CSDataLayer.h
3.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
//
// CocoaSettingsDataLayer.h
// CocoaSettings
//
// Created by Yunpeng Li on 2018/4/19.
// Copyright © 2018年 Baidu. All rights reserved.
//
#import <Foundation/Foundation.h>
@class CSModuleSettings;
/// 如果需要表示此层有值，且值为nil，则应当使用kCSNilValue，最终CSModuleSettings将返回为nil
extern NSString * const kCSNilValue;
/// 添加自定义值有两种方式
/// 1. 调用setExtraAttribute/extraAttributeForKey，即在key后增加kCSExtraAttributeSuffix后缀，此时该值与原有key的值共存亡
extern NSString * const kCSExtraAttributeSuffix;
/// 2. 在对应Settings类的根目录下，有一个kCSExtraAttributesKey对应的Dict，这个目录下的数据需自行管理增加/修改/删除
extern NSString * const kCSExtraAttributesKey;
/**
用于储存/查询数据
数据格式：
{
"ADemoSettings": {
"title": @"test",
"url": @"http://www.baidu.com",
kCSExtraAttributesKey: @{
}
},
"BDemoSettings": {
"title": @"test"
}
}
特殊Case：
如果此层强制要求值为nil，则数据存储上以kCSNilValue做占位符
*/
@interface CSDataLayer : NSObject
/// 原始数据
@property (nonatomic, copy, readonly) NSDictionary *rawSettings;
/// layer层的唯一标识符
@property (nonatomic, copy, readonly) NSString *identifier;
/// 当一个查询经过本DataLayer时，是否强制要求selfUpdateMapper匹配identifier，默认为NO
@property (nonatomic, assign) BOOL requireIdentifier;
/// 标记此Layer是否需要持久化，默认为NO
@property (nonatomic, assign) BOOL needPersistence;
/// 当从settings中读取不到信息时，会通过settingGenerator尝试访问，其中settings和key均为合法值无需再次校验
@property (nonatomic, copy) id<NSCoding> (^settingsGenerator)(CSModuleSettings *settings, NSString *key);
@property (nonatomic, copy) void (^settingsStorage)(CSModuleSettings *settings, NSString *key, id value);
/// 使层级失效，跳过查询，默认为NO
@property (nonatomic, assign) BOOL disable;
#pragma mark - 初始化
- (instancetype)initWithIdentifier:(NSString *)identifier;
#pragma mark - 更新数据
/// key: DemoSettings.key, 返回是否设置成功
- (BOOL)setSettingValue:(id)value forKey:(NSString *)key;
- (BOOL)containsSettingKey:(NSString *)key;
- (id)settingValueForKey:(NSString *)key;
/// 用于记录key对应的某些不需要暴露给业务方的属性（比如version等）
- (id)extraAttributeForKey:(NSString *)key;
- (void)setExtraAttribute:(id)value forKey:(NSString *)key;
/// 将该值从本层移除，有别于value为nil，如果value为nil，也代表本Layer的某个key值为nil
/// 如果移除，标准模式下会继续向下一层查询值
- (void)removeSettingValueForKey:(NSString *)key;
- (BOOL)containSettingValueForKey:(NSString *)key;
- (BOOL)containsModificationForSettingClass:(Class)settingsClass;
- (void)clearModificationForSettingClass:(Class)settingsClass;
#pragma mark - 导入数据，导入数据不会删除旧数据
- (void)loadSettingsFromDictionary:(NSDictionary *)dictionary forClass:(Class)settingsClass;
- (NSDictionary *)settingsForSettingClass:(Class)settingsClass;
#pragma mark - Default 层启动阶段默认值耗时记录
- (NSDictionary *)getDefaultLayerDefaultSettingTimeCost;
@end