YTXRestfulModel CI Status Version License Platform

Dependency(依赖)

Integration

pod 'YTXRestfulModel', :subspecs => ["RACSupport", "YTXRequestRemoteSync", "FMDBSync", "UserDefaultStorageSync"]

Testing

git clone https://github.com/baidao/YTXRestfulModel.git
npm install -g json-server
cd Example
pod install
cd Tests
json-server db.json
open YTXRestfulModel.xcworkspace

More useage, please check(更多用法,请查看)Tests

A Model Example(定义Model示例)

@interface YTXTestModel : YTXRestfulModel
@property (nonnull, nonatomic, strong) NSNumber *keyId;
@property (nonnull, nonatomic, strong) NSNumber *userId;
@property (nonnull, nonatomic, strong) NSString *title;
@property (nonnull, nonatomic, strong) NSString *body;
@end

@implementation YTXTestModel
//The dictionary returned by this method specifies how your model object's properties map to the keys in the JSON representation
// Check Mantle
+ (NSDictionary *)JSONKeyPathsByPropertyKey
{
 /** key 的值是 模型中的字段,value 的值是目标源上对应数据的名字。*/
 return @{@"keyId": @"id"};
}
+ (NSString *)primaryKey
{
 return @"keyId";
}
- (instancetype)init {
 if (self = [super init]) {
 //这种方式可以在每次使用url的时候都重新获取
 self.remoteSync.urlHookBlock = ^NSURL * _Nonnull{
 return [URLManager urlWithName:@"restful.posts"];
 };
 }
 return self;
}
// DB Migration(数据迁移)
+ (nullable NSNumber *) currentMigrationVersion
{
 return @0;
}
// Default NO. If you wanna use dbsync, you should return YES;
+ (BOOL) autoCreateTable
{
 return YES;
}
//Default YES. If auto alter table, it does not do migration.
+ (BOOL) autoAlterTable
{
 return YES;
}
// Mantle Transformer
// Implement this optional method to convert a property from a different type when deserializing from JSON
+ (MTLValueTransformer *)startSchoolDateJSONTransformer {
 return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSNumber *timestamp) {
 return [NSDate dateWithTimeIntervalSince1970: timestamp.longLongValue / 1000];
 } reverseBlock:^(NSDate *date) {
 return @((SInt64)(date.timeIntervalSince1970 * 1000));
 }];
}
+ (MTLValueTransformer *) bodyJSONTransformer
{
 return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSString * body) {
 return body;
 } reverseBlock:^(NSString * body) {
 return body;
 }];
}
@end

Fetch

- (nullable instancetype) fetchStorageSync:(nullable NSDictionary *) param;
- (void) fetchRemote:(nullable NSDictionary *)param success:(nonnull YTXRestfulModelRemoteSuccessBlock)success failed:(nonnull YTXRestfulModelRemoteFailedBlock)failed;
- (nonnull instancetype) saveDBSync:(nullable NSDictionary *)param error:(NSError * _Nullable * _Nullable) error;

Model transition Refrence(Model的转换参考)Mantle

+ (MTLValueTransformer *)birthdayJSONTransformer {
 return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSNumber *timestamp) {
 return [NSDate dateWithTimeIntervalSince1970: timestamp.longLongValue / 1000];
 } reverseBlock:^(NSDate *date) {
 return @((SInt64)(date.timeIntervalSince1970 * 1000));
 }];
}
+ (MTLValueTransformer *)passwordJSONTransformer {
 return [MTLValueTransformer reversibleTransformerWithForwardBlock:^(NSString *value) {
 return [self encryption:value];
 } reverseBlock:^(NSString *value) {
 return [self decryption:value];
 }];
}

Response pretreatment

- (nonnull instancetype) transformerProxyOfResponse:(nonnull id) response error:(NSError * _Nullable * _Nullable) error
{
 return [super transformerProxyOfResponse:response[@"properties"] error:error];
}
- (nonnull id) transformerProxyOfForeign:(nonnull Class)modelClass response:(nonnull id) response error:(NSError * _Nullable * _Nullable) error;
{
 return [[super transformerProxyOfForeign:modelClass response:response[@"properties"] error:error];
}

RACSupport

pod "YTXRestfulModel", :path => "../", :subspecs => ["RACSupport", "AFNetworkingRemoteSync", "FMDBSync", "UserDefaultStorageSync"]

/** GET */
- (nonnull RACSignal *) rac_fetchStorage:(nullable NSDictionary *)param;
/** GET */
- (nonnull RACSignal *) rac_fetchRemote:(nullable NSDictionary *)param;
/** POST / PUT */
- (nonnull RACSignal *) rac_saveRemote:(nullable NSDictionary *)param;
/** GET */
- (nonnull RACSignal *) rac_fetchDB:(nullable NSDictionary *)param;

#import <YTXRestfulModel/YTXRestfulModelRACSupport.h>
YTXTestAFNetworkingRemoteCollection * collection = [YTXTestAFNetworkingRemoteCollection new];
[[collection rac_fetchRemote:@{@"_start": @"1", @"_limit": @"2"}] subscribeNext:^(YTXTestAFNetworkingRemoteCollection *x) {
 
} error:^(NSError *error) {
}];

Example:

 /**
 远程请求:http://jsonplaceholder.typicode.com/posts/1
 返回数据:
 {
 "userId": 1,
 "id": 1,
 "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
 "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
 }
 */
 /**
 keyId = @1,按照JSONKeyPathsByPropertyKey方法中的映射转成retDictionary @{@"id":@1};
 由于param为空,所以保留参数{@"id":@"1"}不做修改,直接执行同步操作,同步目标源中 id = 1 的数据;
 */
 YTXTestModel * currentTestModel = [[YTXTestModel alloc] init];
 currentTestModel.keyId = @1;
 [[currentTestModel rac_fetchRemote:nil] subscribeNext:^(YTXTestModel *responseModel) {
 } error:^(NSError *error) {
 }];
 /**
 Model的属性会按照映射转成retDictionary @{@"title":@"ytx test", @"body":@"test content", @"userId":@1}
 param按照映射转成mapParam,@{@"id":@2};(param = @{@"id":@2} 时也会转成 @{@"id":@2})。
 mapParam的value会替换retDictionary 的value,所以执行同步的参数是@{@"title":@"ytx_test", @"body":@"test_content", @"userId":@1, @"id":@1}
 由于retDictionary 中没有主键,所以不符合rest原则,最后发送的请求是: *******?title=ytx_test&body=test_content&userId=1&id=1
 */
 YTXTestModel * testModel = [[YTXTestModel alloc] init];
 testModel.title = @"ytx test";
 testModel.body = @"test content";
 testModel.userId = @1;
 [[testModel rac_saveRemote:@{@"keyId":@1}] subscribeNext:^(YTXTestModel *responseModel) {
 } error:^(NSError *error) {
 }];
 YTXTestModel * currentTestModel = [[YTXTestModel alloc] init];
 __block id ret;
 currentTestModel.keyId = @1;
 [[currentTestModel rac_fetchRemoteForeignWithName:@"comments" modelClass:[YTXTestCommentModel class] param:nil] subscribeNext:^(id x) {
 ret = x;
 } error:^(NSError *error) {
 }];
 YTXTestModel * dbTestModel = [[YTXTestModel alloc] init];
 dbTestModel.keyId = @1;
 [[dbTestModel rac_fetchDB:nil] subscribeNext:^(YTXTestModel *responseModel) {
 } error:^(NSError *error) {
 }];
 YTXTestModel * storageTestModel = [[YTXTestModel alloc] init];
 storageTestModel.keyId = @1;
 [[storageTestModel rac_fetchStorage:nil] subscribeNext:^(YTXTestModel *responseModel) {
 } error:^(NSError *error) {
 }];

RACSupport

#import <YTXRestfulModel/YTXRestfulModelRACSupport.h>
@interface YTXXXXModel : YTXRestfulModel
- (nonnull RACSignal *) rac_fetchFromRemoteAndStorage;
@end
@implementation YTXXXXXModel
- (nonnull RACSignal *) rac_fetchFromRemoteAndStorage
{
 RACSubject * subject = [RACSubject subject];
 [self fetchRemote:param success:^(id _Nullable response) {
 [subject sendNext:response];
 [subject sendCompleted];
 } failed:^(NSError * _Nullable error) {
 [subject sendError:error];
 
 }];
 return subject;
}
@end

Use new sync

id<YTXRestfulModelStorageProtocol> storageSync;
id<YTXRestfulModelRemoteProtocol> remoteSync;
id<YTXRestfulModelDBProtocol> dbSync;

- (instancetype)init
{
 if(self = [super init])
 {
 self.storageSync = [YTXRestfulModelXXXFileStorageSync new];
 }
 return self;
}
YTXTestModel * model = [YTXTestModel new];
model.storageSync = [YTXRestfulModelXXXFileStorageSync new];

#import <YTXRestfulModel/YTXRestfulModelUserDefaultStorageSync.h>
YTXRestfulModelUserDefaultStorageSync * sync = [[YTXRestfulModelUserDefaultStorageSync alloc] initWithUserDefaultSuiteName:suitName1]

DB mapping

YTXRestfulModelDBSerializingModel * dbsm = [YTXRestfulModelDBSerializingModel new];
dbsm.objectClass = propertyClassName;
dbsm.columnName = columnName;
dbsm.modelName = modelProperyName;
dbsm.isPrimaryKey = isPrimaryKey;
dbsm.autoincrement = isPrimaryKeyAutoincrement;
dbsm.unique = NO;

@interface YTXRestfulModelDBSerializingModel : NSObject
/** 可以是CType @"d"这种*/
@property (nonatomic, nonnull, copy) NSString * objectClass;
/** 表名 */
@property (nonatomic, nonnull, copy) NSString * columnName;
/** Model原始的属性名字 */
@property (nonatomic, nonnull, copy) NSString * modelName;
/** 是否 主键*/
@property (nonatomic, assign) BOOL isPrimaryKey;
/** 是否自增*/
@property (nonatomic, assign) BOOL autoincrement;
/** 是否唯一*/
@property (nonatomic, assign) BOOL unique;
/** 默认值*/
@property (nonatomic, nonnull, copy) NSString * defaultValue;
/** 外键类名 可以使用fetchForeignWithName */
@property (nonatomic, nonnull, copy) NSString * foreignClassName;
@end

+ (nullable NSMutableDictionary<NSString *, YTXRestfulModelDBSerializingModel *> *) tableKeyPathsByPropertyKey
{
 NSMutableDictionary<NSString *, YTXRestfulModelDBSerializingModel *> * tmpDictionary = [super tableKeyPathsByPropertyKey];
 YTXRestfulModelDBSerializingModel * genderStruct = tmpDictionary[@"gender"];
 genderStruct.defaultValue = [@(GenderFemale) sqliteValue];
 tmpDictionary[@"gender"] = genderStruct;
 YTXRestfulModelDBSerializingModel * scoreStruct = tmpDictionary[@"score"];
 scoreStruct.unique = YES;
 tmpDictionary[@"score"] = scoreStruct;
 return tmpDictionary;
}

+ (BOOL) autoCreateTable
{
 return YES;
}

+ (BOOL) isPrimaryKeyAutoincrement
{
 return NO;
}

@{
 @"c":@[ @"NSNumber", @"INTEGER"],
 @"i":@[ @"NSNumber", @"INTEGER"],
 @"s":@[ @"NSNumber", @"INTEGER"],
 @"l":@[ @"NSNumber", @"INTEGER"],
 @"q":@[ @"NSNumber", @"INTEGER"],
 @"C":@[ @"NSNumber", @"INTEGER"],
 @"I":@[ @"NSNumber", @"INTEGER"],
 @"S":@[ @"NSNumber", @"INTEGER"],
 @"L":@[ @"NSNumber", @"INTEGER"],
 @"Q":@[ @"NSNumber", @"INTEGER"],
 @"f":@[ @"NSNumber", @"REAL"],
 @"d":@[ @"NSNumber", @"REAL"],
 @"B":@[ @"NSNumber", @"INTEGER"],
 @"NSString":@[ @"NSString", @"TEXT"],
 @"NSMutableString":@[ @"NSMutableString", @"TEXT"],
 @"NSDate":@[ @"NSDate", @"REAL"],
 @"NSNumber":@[ @"NSNumber", @"REAL"],
 @"NSDictionary":@[ @"NSDictionary", @"TEXT"],
 @"NSMutableDictionary":@[ @"NSDictionary", @"TEXT"],
 @"NSArray":@[ @"NSArray", @"TEXT"],
 @"NSMutableArray":@[ @"NSArray", @"TEXT"],
//这里以下和Remote一般不兼容
 @"CGPoint":@[ @"NSValue", @"TEXT"],
 @"CGSize":@[ @"NSValue", @"TEXT"],
 @"CGRect":@[ @"NSValue", @"TEXT"],
 @"CGVector":@[ @"NSValue", @"TEXT"],
 @"CGAffineTransform":@[ @"NSValue", @"TEXT"],
 @"UIEdgeInsets":@[ @"NSValue", @"TEXT"],
 @"UIOffset":@[ @"NSValue", @"TEXT"],
 @"NSRange":@[ @"NSValue", @"TEXT"]
}

DB Alter(自动扩展字段到表中)

+ (BOOL) autoAlterTable
{
 return YES;//Default
}
+ (nullable NSNumber *) currentMigrationVersion
{
 return @0;
}

DB Migration(数据库迁移)

// DB Migration(数据迁移)
+ (nullable NSNumber *) currentMigrationVersion
{
 return @0;
}
+ (BOOL) autoAlterTable
{
 return NO;//Not Default
}

Migration Example

//数据库迁移操作是从当前版本到最新版本依次进行的,所以本方法中要存储所有版本的迁移操作。
+ (void) migrationsMethodWithSync:(nonnull id<YTXRestfulModelDBProtocol>)sync;
{
 // 创建 数据库迁移的操作
 YTXRestfulModelDBMigrationEntity *migration = [YTXRestfulModelDBMigrationEntity new];
 // 设置 进行本次操作时的版本号
 migration.version = @1;
 // 设置 迁移操作(增、删、改)
 migration.block = ^(_Nonnull id db, NSError * _Nullable * _Nullable error) {
 YTXRestfulModelDBSerializingModel *runtimePStruct = [YTXRestfulModelDBSerializingModel new];
 runtimePStruct.objectClass = @"NSString";
 runtimePStruct.columnName = @"runtimeP";
 runtimePStruct.modelName = @"runtimeP";
 runtimePStruct.isPrimaryKey = NO;
 runtimePStruct.autoincrement = NO;
 runtimePStruct.unique = NO;
 // 创建新的列
 [sync createColumnWithDB:db structSync:runtimePStruct error:error];
 };
 // 存储 迁移操作
 [sync migrate:migration];
}

- (BOOL) createColumnWithDB:(nonnull id)db structSync:(nonnull YTXRestfulModelDBSerializingModel *)sstruct error:(NSError * _Nullable * _Nullable)error;
@optional
- (BOOL) renameColumnWithDB:(nonnull id)db originName:(nonnull NSString *)originName newName:(nonnull NSString *)newName error:(NSError * _Nullable * _Nullable)error;
- (BOOL) dropColumnWithDB:(nonnull id)db structSync:(nonnull YTXRestfulModelDBSerializingModel *)sstruct error:(NSError * _Nullable * _Nullable)error;
- (BOOL) changeCollumnDB:(nonnull id)db oldStructSync:(nonnull YTXRestfulModelDBSerializingModel *) oldStruct toNewStruct:(nonnull YTXRestfulModelDBSerializingModel *) newStruct error:(NSError * _Nullable * _Nullable)error;

+ (void)dbWillMigrateWithSync:(nonnull id<YTXRestfulModelDBProtocol>)sync
{
}
+ (void)dbDidMigrateWithSync:(nonnull id<YTXRestfulModelDBProtocol>)sync
{
}

Remote Hook

NSDictionary *(^hook)() = ^NSDictionary *() {
 return @{
 @"deviceToken": objectOrEmptyStr([NotificationManager sharedManager].deviceToken),
 @"deviceId": objectOrEmptyStr([AppInfo deviceUUID]),
 @"marketId": objectOrEmptyStr([AppInfo marketId]),
 @"appVersion": objectOrEmptyStr([AppInfo appVersion])
 };
};
AFNetworkingRemoteSync.HookExtraParamBlock = hook;

Remote Hook Request

AFNetworkingRemoteSync.hookRequestBlock = ^(AFNetworkingRemoteSync * sync) {
 AFHTTPRequestOperationManager * operationManager = sync.requestOperationManager;
 [operationManager.requestSerializer setValue:@"test" forHTTPHeaderField:@"x-auth-token"];
};

subspec

License