组件化之路之接口隔离
在描述我们解决组件化关于接口隔离方法之前，先抛出两个问题：
1. 大家如何拆分非业务模块的模块，比如用户信息模块，vip信息模块等非业务模块。
2.大家对于接口和模型的理解，如何访问接口的属性，以及如何实现KVO监听接口属性变化（比如我们经常使用的RAC操作)。
3.如何管理那些protocol，怎么在外部调用那些实现接口的类的方法以及属性。
一、关于模块化的拆分
目前在我们APP里面，实际上是集合了连个APP，一个是学生版，一个是教师版。学生端的功能 是纯Native的代码，教师端的是RN的代码，但是被集成我们的APP中。教师功能有一些模块是和学生端是共用的，比如用户信息，埋点系统，设置页面等等。
由于在之后的版本迭代里面，教师端的功能，会从我们的主APP中迁移出去，但是有些功能在教师端还能用，我们我们必须要实现组件化。下面是我们组件化的简单结构图，今天主要是针对关于user，vip这两个模块的抽取进行讲解。大家主要看框图上黄色的位置。
image.png
下图是我们根据上面的拆分方式，加上我们的对业务的拆分之后，整理出来的结构。这些代码目前在pod里面，很大家做组件化一样，我们使用的也是podspec,具体我就不写了。
image.png
二、关于接口的设计
通常情况下，我们在APP中会有一个userManager这个单例去管理我们整个APP中用户信息变化。然后在userManager实现对应的增删改查，属性访问等操作。在做组件化之后，我们有一个userManagerProtocol这个接口包含所有原来userManger相关属性和方法，为了能够让大家在调用用户信息的时候感觉没有太大的区别。因为是公司代码，不方便透露，所有我就写了一个简单的demo，来解释我们的实现。这是改造之前userManger头文件。
@class YCUser;
@interface YCUserManager : NSObject
@property (nonatomic, assign) BOOL isStudent;
- (NSDictionary *)retunUserInfo;
- (NSString *)returnToken;
// 更新
- (void)updateUserInfo:(NSDictionary *)userInfo;
- (void)updateUserToken:(NSString *)token;
- (YCUser *)returnUser;
@end
改造之后，userManger头文件,是的什么都没有了，
@interface YCUserManager : NSObject
@end
但是我们多了一个userManagerProtocol，为了能够快速访问到用户属性，我们还定义了一个userProtocol，userProtocol这个接口里面的属性和user里面的属性保持一致。目的是为了实现在外部和访问类的姿势保持一致。 头文件如下：
@protocol YCUserManagerProtocal <NSObject, BHServiceProtocol>
@property (nonatomic, assign) BOOL isStudent;
- (NSDictionary *)retunUserInfo;
- (NSString *)returnToken;
// 更新
- (void)updateUserInfo:(NSDictionary *)userInfo;
- (void)updateUserToken:(NSString *)token;
- (id<YCUserProtocol>)returnUser;
@end
对于userManger实现类如下：
#import "YCUserManager.h"
#import "YCUserManagerProtocal.h"
#import "YCUser.h"
#import <MJExtension.h>
#import <BeeHive.h>
@BeeHiveService(YCUserManagerProtocal, YCUserManager)
@interface YCUserManager() <YCUserManagerProtocal>
@property (nonatomic, strong) YCUser *studentUser;
@property (nonatomic, strong) NSDictionary *userDict;
@property (nonatomic, copy) NSString *token;
@end
@implementation YCUserManager
@synthesize isStudent = _isStudent;
+ (BOOL)singleton {
return YES;
}
static YCUserManager *_manager = nil;
+ (instancetype)shareInstance {
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
_manager = [[YCUserManager alloc] init];
});
return _manager;
}
- (void)updateUserInfo:(NSDictionary *)userInfo {
self.userDict = userInfo;
YCUser *user = [YCUser mj_objectWithKeyValues:userInfo];
self.studentUser = user;
self.isStudent = YES;
}
- (void)updateUserToken:(NSString *)token {
self.token = token;
}
- (NSString *)returnToken {
return self.token;
}
- (NSDictionary *)retunUserInfo {
return self.userDict;
}
- (id<YCUserProtocol>)returnUser {
return (id)self.studentUser;
}
@end
大家在上面的文件中会看到#import <BeeHive.h> ，这是阿里出的一个框架，BeeHive是基于Spring的Service理念，虽然可以使模块间的具体实现与接口解耦，但无法避免模块对接口类的依赖关系。在我们的模块化中主要用这个类实现模块与接口解耦的功能。在使用这个类的时候，为了能够找个这个类，需要注册一下,注册service姿势有三种，具体关于BeeHive的更过功能以及使用姿势可以看 [https://github.com/alibaba/BeeHive]
1. 通过BeeHiveService宏进行Annotation标记。
@BeeHiveService(YCUserManagerProtocal, YCUserManager)
2. 读取本地Pilst文件
[BHContext shareInstance].serviceConfigName = @"BeeHive.bundle/BHService";
3.Load方法注册
[[BeeHive shareInstance] registerService:@protocol(YCUserManagerProtocal) service:[YCUserManager class]];
三、关于接口管理以及使用
@interface ViewController ()
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
NSDictionary *dict = @{
@"name":@"周文超",
@"age":@(12),
@"student" : @{
@"studentName" : @"李向红",
@"studentAge" : @(11)
}
};
id<YCUserManagerProtocal> userManager = [[BeeHive shareInstance] createService:@protocol(YCUserManagerProtocal)];
// 更新数据
[userManager updateUserInfo:dict];
[RACObserve(userManager, isStudent) subscribeNext:^(id x) {
}];
// 获取用户信息
id<YCUserProtocol> user = [userManager returnUser];
[userManager updateUserToken:@"我是token"];
NSLog(@"%@----%@-----%@", user.name, [userManager returnToken], [user.student mj_JSONObject]);
[RACObserve(user, name) subscribeNext:^(id _Nullable x) {
}];
}
先看代码，对着代码进行讲解。
id<YCUserManagerProtocal> userManager = [[BeeHive shareInstance] createService:@protocol(YCUserManagerProtocal)];
在BeeHive中是通过BHServiceManager来管理各个Protocol的。BHServiceManager中只会管理已经被注册过的Protocol。上面我们对YCUserManagerProtocal进行了注册。因此我们可以通过这种方式获取到我们注册的service。
大家可能疑惑为什么，对于一个接口的属性可以实现KVO操作，这也是OC的特性。protocol 的本质类似一个抽象类,这个声明了一些纯虚方法或者属性。在java中,这个叫接口类在编码中,通过继承协议,实现了协议中描述的这一套方法或者方法赋值操作。我们在接口里面定义了一个isStudent属性，在实现类里面，我们做了
@synthesize isStudent = _isStudent;
所以我们可以实现对它的监听，同样，我们通过
// 获取user
id<YCUserProtocol> user = [userManager returnUser];
[RACObserve(userManager, isStudent) subscribeNext:^(id x) {
}];
// 监听user属性变化
[RACObserve(user, name) subscribeNext:^(id _Nullable x) {
}];
注意：大家需要注意的几点
- 在使用BeeHive的时候一定要注册
- 如果要想某个服务是单利，需要重写下面这个方法
+ (BOOL)singleton {
return YES;
}
3.对于实现接口的类，大家在做模型转json的时候，会附带几个protocol的四个属性，hash, superclass, debugDescription, description
