Model的设计

前言

很多的app使用MVC设计模式来将“用户交互”与“数据和逻辑”分开，而model其中一个重要作用就是持久化。下文中设计的Model可能不是一个完美的，扩展性强的model范例，但在我需要重构的app中，这样的设计能够满足我的需要。

关于Model

Model层包含了app的数据与逻辑，Model层中的类需要关心的是数据的表现，存储，以及操作。Model层是整个app生态中相对独立的一个部分，因为它不会直接与controller层或者是View层进行通讯，而是在其他层需要请求它的信息的时候进行间接通讯。

Model有什么用?

想要写好一个model，首先要清晰Model的作用。

  • 属性存取：将文件中的一些特性和数据以属性的形式存储

  • 可变性：属性可以readwrite，所以能够被改变，并保存到本地

  • KVO：可以观察一个属性的值并在它改变的时候受到通知，并以此对UI或其他地方进行控制

  • 处理数据：根据业务逻辑处理网络获取数据与本地存储数据

如何定义Model类

我们可以创建一系列的Model类，它们之间可以互相继承，同时每一个Model类是与当前app中的实体对应。比如在我当前需要重构的app中，用户数据对应的是UserInformationModel，班级信息对应的是StudentClassModel。

另一方面，在Model类的实现过程中，有许多问题需要解决，所以我下面会根据我当前正在重构的app的一些情况结合来解释。

信息的存储格式处理

数据可以以各种不同的格式储存，在我重构的app中，数据等信息是使用普通的数据结构来存放，比如使用数据或者是字典来保存Model的信息。在一开始建立Model的时候并没有太大的问题，但是当需求不断增加，一个Model类的信息开始变得庞大起来的时候，问题就开始浮现了。比如下面我要输出用户的姓名、年龄、班级、班主任、年级等数据。

// never do this !!!
- (void)printInformation
{
  NSLog(@"name: %@", [user objectForKey:@"name"]);
  NSLog(@"age: %@"m [user objectForKey:@"age"]);
  NSLog(@"class: %@"m [user objectForKey:@"clazz"]);
  NSLog(@"teacher: %@"m [user objectForKey:@"teacher"]);
  NSLog(@"grade: %@"m [user objectForKey:@"grade"]);
}

这样取出数据似乎没什么问题，但是当数据多起来的时候就会发现代码会十分混乱，而且不！美！观！，同时最主要的问题是，在从字典中取出数据的过程中会把key打错，导致数据取出失败。

所以在设计Model过程中，尽可能将Model设计成一个类而不是一个结构，在类中可以使用属性（Property）来存取信息，它能够提供给开发者基本的拼写检查，完全杜绝打错key导致的数据获取失败的情况，同时方便其他开发者看到Model中存储的数据类型，也方便日后的扩展与维护。

// YES! do this!
- (void)printInformation
{
  NSLog(@"name: %@", user.name);
  NSLog(@"age: %@", user.age);
  NSLog(@"class: %@", user.clazz);
  NSLog(@"teacher: %@", user.teacher);
  NSLog(@"grade: %@", user.grade);
}

网络数据处理

由于我重构的app大部分功能是基于网络的，所以网络数据在Model层的处理会是重点。因为网络数据是异步获取的，而且获取过程很容易失败。所以网络数据的获取比本地数据的获取难度要更大。另一方面，很多app的网络请求框架中都提供了缓存功能，可以在下一次请求中从缓存中更快的获取数据，而不需要再次进行网络请求，这里又涉及到本地数据获取等问题，使得网络数据的处理显得尤其繁琐。

在一个同步的网络环境下，我们可以把错误处理放到其他地方，可以简单的做缓存，甚至可以像处理本地数据一样来更新、删除、添加新的网络数据。但很不幸的是，网络是异步的，所以我们需要处理这个重要问题。

首先我在上文提到的缓存、失败处理，这些应该是交给网络请求框架来进行处理，最后得到一个responseObject，再对responseObject进行model转换等操作。

比如我在当前的项目中，是利用了MJExtension来进行字典与模型之间的转换，而这个转换，我是放到了每个单独的API中，比如对于库存的请求，我在InventoryAPI中进行对responseObject转换成InventoryModel的操作，而不是放到vc中进行，这样在vc中仅仅是进行网络请求，请求完成后返回的是我想要的model。

InventoryAPI.m

- (id)modelingFormJSONResponseObject:(id)JSONResponseObject
{    
  NSUInteger count = ((NSArray *)JSONResponseObject).count;    
  NSMutableArray *modelsArray = [NSMutableArray array];    
  for(int i = 0; i < count; i ++)    {       
    InventoryModel *model = [InventoryModel mj_objectWithKeyValues:JSONResponseObject[i]];       
     [modelsArray addObject:model];    
  }    
  return modelsArray;
}

InventoryViewController

- (void)requestInformation
{    
  [api startWithBlockSuccess:^(__kindof YXYBaseRequest *request) {        
    // request.responseObject 将会返回modelsArray    
  } failure:^(__kindof YXYBaseRequest *request, NSError *error) {   

  }];
}

本地数据处理

本地数据有多种方式存储，比较常见的做法是使用.plist文件存储非常简单的数据，例如设置，而会使用SQLite数据库来存储其他复杂的数据。另一方面，可以试着使用Core Data来对存储数据model，虽然Core Data会带来更多问题，甚至会影响性能，但它的NSFetchResultsController、懒加载、数据处理工具等也是十分的好用，所以……看自己。

在本地数据处理中，最重要的是如何获取和修改数据。在我现在需要重构的项目中并没有太多的本地内容，绝大部份的数据都是通过网络获取，所以我并没有准备详细讲对Data Model的重构与规范化处理。但基本的原则是对每个model配备一个存取器，里面可以提供fetchALl、fetchAllUsingPredicate、createInstance、save等操作，每个model都可以使用这些操作来获取数据，而这些操作的逻辑隐藏起来，在调用的时候我不需要知道我这个model究竟是存放在数据库中，还是.plist文件中，还是在缓存中。我只需要知道当我调用这些方法的时候，我可以获取到我想要的model，并可以取出我想要的数据。

而这篇博文里面详细讲到了SQLite、Core Data、FMDB，想要了解数据库存储方面内容的朋友可以看一下。

业务逻辑处理

在model中不只是能够处理数据的存储，还可以对业务逻辑进行处理。在我需要重构的项目中，无论是强弱业务逻辑都有散落在vc的情况，导致了vc十分臃肿，如下面的代码中，就是需要实现从DateModel中取出一个时间，将NSDate格式的时间转换到NSString，并在View中展示出来的情况：

DateModel.h

@interface DateModel : BaseModel
@property (copy, nonatomic) NSDate *currentDate;
@end

DateModel.m

- (instantcetype)init
{
  if (self = [super init]) {
    currentDate = [NSDate date];
  }
  return self;
}

aViewController.m

- (void)showTheDate
{
  DateModel *dateModel = [DateModel new];
  NSDate *date = dateModel.currentDate;
  NSDateFormatter *format = [[NSDateFormatter alloc] init];
  format.dateFormat = @"yyyy年MM月dd号 HH:mm:ss";
  NSString *string = [format stringFromDate:date];
  self.dateLabel.text = string;
}

事实上这段代码完全可以分开放置在model层中，让整个vc的代码更加清晰，如：

NSDate+dateTransform.h

@interface NSDate (dateTransform)
+ (NSString *)transformStringFromDate:(NSDate *)date;
@end

NSDate+dateTransform.m

+ (NSString *)transformStringFromDate:(NSDate *)date
{
  NSDateFormatter *format = [[NSDateFormatter alloc] init];
  format.dateFormat = @"yyyy年MM月dd号 HH:mm:ss";
  NSString *string = [format stringFromDate:date];
  return string;
}

创建一个NSDate的分类并将转换的代码放到其中，并由DateModel调用他来完成转换

DateModel.h

@interface DateModel : BaseModel
@property (copy, nonatomic) NSString *currentDate;
@end

DateModel.m

- (instantcetype)init
{
  if (self = [super init]) {
    currentDate = [NSDate transformStringFromDate:[NSDate date]];
  }
  return self;
}

然后在vc中，我们只需要简单的调用：

aViewController.m

- (void)showTheDate
{
  DateModel *dateModel = [DateModel new];
  self.dateLabel.text = dateModel.currentDate;
}

这样整个vc的代码结构就清晰了很多，model层取出的属性也能直接交付到view层去显示，而日期转换这类代码也能轻易的被复用。总之，针对这类的model，可以把调用方法尽可能的抽象，当需要解耦这部分代码的时候可以应用IOC模式，否则，在日后改变这些逻辑会变得十分困难。

结论

iOS的app中通常很少考虑model层的设计功能，而然，由于各种原因，比如各种散落的代码或者是容易出错的网络连接，让问题变得十分复杂。所以为了避免这些问题，model层的设计必须严格遵循这些原则，比如是把处理数据的代码独立开来、设计一个给本地数据的存取器、设计一个给网络数据的存取器等等。但不管我们怎么设计这个model层，最重要一点是这些功能的实现要完全对调用者隐藏起来，而且这些功能的实现要足够简单，以便将来对其进行修改与更新。

总而言之，在开发一段时间后很可能会更换网络库、业务逻辑、数据库工具等等，良好的Model层设计能让你不用修改任何一行controller层和view层的代码，就完成了底层库的更新换代。

文章转载于：http://www.cocoachina.com/ios/20180906/24807.html
如有任何不妥，请联系QQ:411282623，会第一时间进行修改或删除。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,602评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,442评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,878评论 0赞 344
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,306评论 1赞 279
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,330评论 5赞 373
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,071评论 1赞 285
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,382评论 3赞 400
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,006评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,512评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2赞 325
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,732评论 4赞 323
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,283评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1赞 262
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2赞 354
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2赞 345