<简书 — 刘小壮> http://www.jianshu.com/p/67a6004f6930html
前段时间公司项目打算重构, 准确来讲应该是按以前的产品逻辑重写一个项目😂。在重构项目以前涉及到架构选型的问题,我和组里小伙伴一块儿研究了一下组件化架构, 打算将项目重构为组件化架构。固然不是直接拿来照搬,仍是要根据公司具体的业务需求设计架构。在学习组件化架构的过程当中,从不少高质量的博客中学到很多东西,例如蘑菇街李忠、casatwy、bang的博客。在学习过程当中也遇到一些问题,在微博和QQ上和一些作
iOS
的朋友进行了交流,很是感谢这些朋友的帮助。前端本篇文章主要针对于以前蘑菇街提出的组件化方案,以及casatwy提出的组件化方案进行分析,后面还会简单提到滴滴、淘宝、微信的组件化架构,最后会简单说一下我公司设计的组件化架构。git
随着移动互联网的不断发展,不少程序代码量和业务愈来愈多,现有架构已经不适合公司业务的发展速度了,不少都面临着重构的问题。github
在公司项目开发中,若是项目比较小,普通的单工程+MVC架构
就能够知足大多数需求了。可是像淘宝、蘑菇街、微信这样的大型项目,原有的单工程架构就不足以知足架构需求了。web
就拿淘宝来讲,淘宝在13年开启的“All in 无线”
战略中,就将阿里系大多数业务都加入到手机淘宝中,使客户端出现了业务的爆发。在这种状况下,单工程架构则已经远远不能知足现有业务需求了。因此在这种状况下,淘宝在13年开启了插件化架构的重构,后来在14年迎来了手机淘宝有史以来最大规模的重构,将项目重构为组件化架构。算法
在一个项目愈来愈大,开发人员愈来愈多的状况下,项目会遇到不少问题。sql
为了解决上面的问题,能够考虑加一个中间层来协调各个模块间的调用,全部的模块间的调用都会通过中间层中转。数据库
可是发现增长这个中间层后,耦合仍是存在的。中间层对被调用模块存在耦合,其余模块也须要耦合中间层才能发起调用。这样仍是存在以前的相互耦合的问题,并且本质上比以前更麻烦了。编程
因此应该作的是,只让其余模块对中间层产生耦合关系,中间层不对其余模块发生耦合。
对于这个问题,能够采用组件化的架构,将每一个模块做为一个组件。而且创建一个主项目,这个主项目负责集成全部组件。这样带来的好处是不少的:设计模式
CocoaPods
集成便可。进行组件化开发后,能够把每一个组件当作一个独立的app,每一个组件甚至能够采起不一样的架构,例如分别使用MVVM
、MVC
、MVCS
等架构,根据本身的编程习惯作选择。
蘑菇街经过MGJRouter
实现中间层,由MGJRouter
进行组件间的消息转发,从名字上来讲更像是“路由器”。实现方式大体是,在提供服务的组件中提早注册block
,而后在调用方组件中经过URL
调用block
,下面是调用方式。
MGJRouter
是一个单例对象,在其内部维护着一个“URL -> block”
格式的注册表,经过这个注册表来保存服务方注册的block
,以及使调用方能够经过URL
映射出block
,并经过MGJRouter
对服务方发起调用。
MGJRouter
是全部组件的调度中心,负责全部组件的调用、切换、特殊处理等操做,能够用来处理一切组件间发生的关系。除了原生页面的解析外,还能够根据URL跳转H5页面。
在服务方组件中都对外提供一个PublicHeader
,在PublicHeader
中声明当前组件所提供的全部功能,这样其余组件想知道当前组件有什么功能,直接看PublicHeader
便可。每个block
都对应着一个URL
,调用方能够经过URL
对block
发起调用。
#ifndef UserCenterPublicHeader_h #define UserCenterPublicHeader_h /** 跳转用户登陆界面 */ static const NSString * CTBUCUserLogin = @"CTB://UserCenter/UserLogin"; /** 跳转用户注册界面 */ static const NSString * CTBUCUserRegister = @"CTB://UserCenter/UserRegister"; /** 获取用户状态 */ static const NSString * CTBUCUserStatus = @"CTB://UserCenter/UserStatus"; #endif
在组件内部实现block
的注册工做,以及block
对外提供服务的代码实现。在注册的时候须要注意注册时机,应该保证调用时URL
对应的block
已经注册。
蘑菇街项目使用git
做为版本控制工具,将每一个组件都当作一个独立工程,并创建主项目来集成全部组件。集成方式是在主项目中经过CocoaPods
来集成,将全部组件当作二方库集成到项目中。详细的集成技术点在下面“标准组件化架构设计”章节中会讲到。
下面代码模拟对详情页的注册、调用,在调用过程当中传递id
参数。参数传递能够有两种方式,相似于Get请求在URL
后面拼接参数,以及经过字典传递参数。下面是注册的示例代码:
[MGJRouter registerURLPattern:@"mgj://detail" toHandler:^(NSDictionary *routerParameters) { // 下面能够在拿到参数后,为其余组件提供对应的服务 NSString uid = routerParameters[@"id"]; }];
经过openURL:
方法传入的URL
参数,对详情页已经注册的block
方法发起调用。调用方式相似于GET
请求,URL
地址后面拼接参数。
[MGJRouter openURL:@"mgj://detail?id=404"];
也能够经过字典方式传参,MGJRouter
提供了带有字典参数的方法,这样就能够传递非字符串以外的其余类型参数,例如对象类型参数。
[MGJRouter openURL:@"mgj://detail" withParam:@{@"id" : @"404"}];
有的时候组件间调用过程当中,须要服务方在完成调用后返回相应的参数。蘑菇街提供了另外的方法,专门来完成这个操做。
[MGJRouter registerURLPattern:@"mgj://cart/ordercount" toObjectHandler:^id(NSDictionary *routerParamters){ return @42; }];
经过下面的方式发起调用,并获取服务方返回的返回值,要作的就是传递正确的URL
和参数便可。
NSNumber *orderCount = [MGJRouter objectForURL:@"mgj://cart/ordercount"];
这时候会发现一个问题,在蘑菇街组件化架构中,存在了不少硬编码的URL和参数。在代码实现过程当中URL
编写出错会致使调用失败,并且参数是一个字典类型,调用方不知道服务方须要哪些参数,这些都是个问题。
对于这些数据的管理,蘑菇街开发了一个web
页面,这个web
页面统一来管理全部的URL
和参数,Android
和iOS
都使用这一套URL
,能够保持统一性。
在项目中存在不少公共部分的东西,例如封装的网络请求、缓存、数据处理等功能,以及项目中所用到的资源文件。蘑菇街将这些部分也当作组件,划分为基础组件,位于业务组件下层。全部业务组件都使用同一套基础组件,也能够保证公共部分的统一性。
为了解决MGJRouter
方案中 URL
硬编码 ,以及 字典参数类型不明确 等问题,蘑菇街在原有组件化方案的基础上推出了Protocol
方案。Protocol
方案由两部分组成,进行组件间通讯的ModuleManager
类以及MGJComponentProtocol
协议类。
经过中间件ModuleManager
进行消息的调用转发,在ModuleManager
内部维护一张映射表,映射表由以前的"URL -> block"
变成"Protocol -> Class"
。
在中间件中建立MGJComponentProtocol
文件,服务方组件将能够用来调用的方法都定义在Protocol
中,将全部服务方的Protocol
都分别定义到MGJComponentProtocol
文件中,若是协议比较多也能够分开几个文件定义。这样全部调用方依然是只依赖中间件,不须要依赖除中间件以外的其余组件。
Protocol
方案中每一个组件须要一个MGJModuleImplement,此类负责实现当前组件对应的协议方法,也就是对外提供服务的实现。在程序开始运行时将自身的Class
注册到ModuleManager
中,并将Protocol
反射为字符串当作key
。
Protocol方案依然须要提早注册服务,因为Protocol
方案是返回一个Class
,并将Class
反射为对象再调用方法,这种方式不会直接调用类的内部逻辑。能够将Protocol
方案的Class
注册,都放在类对应的MGJModuleImplement
中,或者专门创建一个RegisterProtocol
类。
建立MGJUserImpl
类当作User
组件对外公开的类,并在MGJComponentProtocol.h
中定义MGJUserProtocol
协议,由MGJUserImpl
类实现协议中定义的方法,完成对外提供服务的过程。下面是协议定义:
@protocol MGJUserProtocol <NSObject> - (NSString *)getUserName; @end
Class
遵照协议并实现定义的方法,外界经过Protocol
获取的Class
并实例化为对象,调用服务方实现的协议方法。
ModuleManager
的协议注册方法,注册时将Protocol
反射为字符串当作存储的key
,将实现协议的Class
当作值存储。经过Protocol
取Class
的时候,就是经过Protocol
从ModuleManager
中将Class
映射出来。
[ModuleManager registerClass:MGJUserImpl forProtocol:@protocol(MGJUserProtocol)];
调用时经过Protocol
从ModuleManager
中映射出注册的Class
,将获取到的Class
实例化,并调用Class
实现的协议方法完成服务调用。
Class cls = [[ModuleManager sharedInstance] classForProtocol:@protocol(MGJUserProtocol)]; id userComponent = [[cls alloc] init]; NSString *userName = [userComponent getUserName];
蘑菇街是MGJRouter
和Protocol
混用的方式,两种实现的调用方式不一样,但大致调用逻辑和实现思路相似。在MGJRouter
不能知足需求或调用不方便时,就能够经过Protocol
的方式调用。
MGJRouter
对服务方组件进行注册。每一个URL
对应一个block
的实现,block
中的代码就是组件对外提供的服务,调用方能够经过URL
调用这个服务。MGJRouter
调用openURL:
方法,并将被调用代码对应的URL
传入,MGJRouter
会根据URL
查找对应的block
实现,从而调用组件的代码进行通讯。block
时,block
有一个字典用来传递参数。这样的优点就是参数类型和数量理论上是不受限制的,可是须要不少硬编码的key
名在项目中。蘑菇街组件化方案有两种,Protocol
和MGJRouter
的方式,但都须要进行register
操做。Protocol
注册的是Class
,MGJRouter
注册的是Block
,注册表是一个NSMutableDictionary
类型的字典,而字典的拥有者又是一个单例对象,这样会形成内存的常驻。
下面是对两种实现方式内存消耗的分析:
MGJRouter
方案可能致使的内存问题,因为block
会对代码块内部对象进行持有,若是使用不当很容易形成内存泄漏的问题。block
自身实际上不会形成很大的内存泄漏,主要是内部引用的变量,因此在使用时就须要注意强引用的问题,并适当使用weak
修饰对应的变量。以及在适当的时候,释放对应的变量。block
代码块内部尽可能不要直接建立对象,应该经过方法调用中转一下。block
内存常驻方式差很少。只是将存储的block
对象换成Class
对象。这其实是存储的类对象,类对象原本就是单例模式,因此不会形成多余内存占用。casatwy组件化方案能够处理两种方式的调用,远程调用和本地调用,对于两个不一样的调用方式分别对应两个接口。
AppDelegate
代理方法传递到当前应用后,调用远程接口并在内部作一些处理,处理完成后会在远程接口内部调用本地接口,以实现本地调用为远程调用服务。performTarget:action:params:
方法负责,但调用方通常不直接调用performTarget:
方法。CTMediator
会对外提供明确参数和方法名的方法,在方法内部调用performTarget:
方法和参数的转换。casatwy是经过CTMediator
类实现组件化的,在此类中对外提供明确参数类型的接口,接口内部经过performTarget
方法调用服务方组件的Target
、Action
。因为CTMediator
类的调用是经过runtime
主动发现服务的,因此服务方对此类是彻底解耦的。
但若是CTMediator
类对外提供的方法都放在此类中,将会对CTMediator
形成极大的负担和代码量。解决方法就是对每一个服务方组件建立一个CTMediator
的Category
,并将对服务方的performTarget
调用放在对应的Category
中,这些Category
都属于CTMediator
中间件,从而实现了感官上的接口分离。
对于服务方的组件来讲,每一个组件都提供一个或多个Target
类,在Target
类中声明Action
方法。Target
类是当前组件对外提供的一个“服务类”,Target
将当前组件中全部的服务都定义在里面,CTMediator
经过runtime
主动发现服务。
在Target
中的全部Action
方法,都只有一个字典参数,因此能够传递的参数很灵活,这也是casatwy提出的去Model
化的概念。在Action
的方法实现中,对传进来的字典参数进行解析,再调用组件内部的类和方法。
casatwy为咱们提供了一个Demo,经过这个Demo
能够很好的理解casatwy的设计思路,下面按照个人理解讲解一下这个Demo
。
打开Demo
后能够看到文件目录很是清楚,在上图中用蓝框框出来的就是中间件部分,红框框出来的就是业务组件部分。我对每一个文件夹作了一个简单的注释,包含了其在架构中的职责。
在CTMediator
中定义远程调用和本地调用的两个方法,其余业务相关的调用由Category
完成。
// 远程App调用入口 - (id)performActionWithUrl:(NSURL *)url completion:(void(^)(NSDictionary *info))completion; // 本地组件调用入口 - (id)performTarget:(NSString *)targetName action:(NSString *)actionName params:(NSDictionary *)params;
在CTMediator
中定义的ModuleA
的Category
,为其余组件提供了一个获取控制器并跳转的功能,下面是代码实现。因为casatwy的方案中使用performTarget
的方式进行调用,因此涉及到不少硬编码字符串的问题,casatwy采起定义常量字符串来解决这个问题,这样管理也更方便。
#import "CTMediator+CTMediatorModuleAActions.h" NSString * const kCTMediatorTargetA = @"A"; NSString * const kCTMediatorActionNativFetchDetailViewController = @"nativeFetchDetailViewController"; @implementation CTMediator (CTMediatorModuleAActions) - (UIViewController *)CTMediator_viewControllerForDetail { UIViewController *viewController = [self performTarget:kCTMediatorTargetA action:kCTMediatorActionNativFetchDetailViewController params:@{@"key":@"value"}]; if ([viewController isKindOfClass:[UIViewController class]]) { // view controller 交付出去以后,能够由外界选择是push仍是present return viewController; } else { // 这里处理异常场景,具体如何处理取决于产品逻辑 return [[UIViewController alloc] init]; } }
下面是ModuleA
组件中提供的服务,被定义在Target_A
类中,这些服务能够被CTMediator
经过runtime
的方式调用,这个过程就叫作发现服务。
在Target_A
中对传递的参数作了处理,以及内部的业务逻辑实现。方法是发生在ModuleA
内部的,这样就能够保证组件内部的业务不受外部影响,对内部业务没有侵入性。
- (UIViewController *)Action_nativeFetchDetailViewController:(NSDictionary *)params { // 对传过来的字典参数进行解析,并调用ModuleA内部的代码 DemoModuleADetailViewController *viewController = [[DemoModuleADetailViewController alloc] init]; viewController.valueLabel.text = params[@"key"]; return viewController; }
在大型项目中代码量比较大,须要避免命名冲突的问题。对于这个问题casatwy采起的是加前缀的方式,从casatwy的Demo
中也能够看出,其组件ModuleA
的Target
命名为Target_A
,能够区分各个组件的Target
。被调用的Action
命名为Action_nativeFetchDetailViewController:
,能够区分组件内的方法与对外提供的方法。
casatwy将类和方法的命名,都统一按照其功能作区分当作前缀,这样很好的将组件相关和组件内部代码进行了划分。
从我调研和使用的结果来讲,并不推荐使用Protocol
方案。首先Protocol
方案的代码量就比MGJRouter
方案的要多,调用和注册代码量很大,调用起来并非很方便。
本质上来讲Protocol
方案是经过类对象实例一个变量,并调用变量的方法,并无真正意义上的改变组件之间的交互方案,但MGJRouter
的方案却经过URL Router
的方式改变和统一了组件间调用方式。
而且Protocol
没有对Remote Router
的支持,不能直接处理来自Push
的调用,在灵活性上就不如MGJRouter
的方案。
我并不推荐CTMediator
方案,这套方案其实是一套很臃肿的方案。虽然为CTMediator
提供了不少Category
,但实际上组件间的调用逻辑都耦合在了中间件中。一样,和Protocol
方案存在一个相同的问题,就是调用代码量很大,使用起来并不方便。
在CTMediator
方案中存在不少硬编码的问题,例如target
、action
以及参数名都是硬编码在中间件中的,这种调用方式并不灵活直接。
但casatwy提出了去Model
化的想法,我以为这在组件化中传参来讲,是很是灵活的,这点我比较认同。相对于MGJRouter
的话,也采用了去Model
化的传参方式,而不是直接传递模型对象。组件化传参并不适用传模型对象,但组件内部仍是可使用Model
的。
MGJRouter
方案是一套很是轻量级的方案,其中间件代码总共也就两百行之内,很是简洁。在调用时直接经过URL
调用,调用起来很简单,我推荐使用这套方案做为组件化架构的中间件。
MGJRouter
最强大的一点在于,统一了远程调用和本地调用。这就使得能够经过Push
的方式,进行任何容许的组件间调用,对项目运营是有很大帮助的。
这三套方案都实现了组件间的解耦,MGJRouter
和Protocol
都是调用方对中间件的耦合,CTMediator
是中间件对组件的耦合,都是单向耦合。
在三套方案中,服务方组件都对外提供一个PublicHeader
或Target
,在文件中统必定义对外提供的服务,组件间通讯的实现代码大多数都在里面。
但三套实现方案实现方式并不一样,蘑菇街的两套方案都须要注册操做,不管是Block
仍是Protocol
都须要注册后才能够提供服务。而casatwy的方案则不须要,直接经过runtime
调用。
在上面文章中提到了casatwy方案的CTMediator
,蘑菇街方案的MGJRouter
和ModuleManager
,以后将统称为中间件,下面让咱们设计一套组件化架构。
组件化架构中,须要一个主工程,主工程负责集成全部组件。每一个组件都是一个单独的工程,建立不一样的git
私有仓库来管理,每一个组件都有对应的开发人员负责开发。开发人员只须要关注与其相关组件的代码,不用考虑其余组件,这样来新人也好上手。
组件的划分须要注意组件粒度,粒度根据业务可大可小。组件划分能够将每一个业务模块都划分为组件,对于网络、数据库等基础模块,也应该划分到组件中。项目中会用到不少资源文件、配置文件等,也应该划分到对应的组件中,避免重复的资源文件。项目实现彻底的组件化。
每一个组件都须要对外提供调用,在对外公开的类或组件内部,注册对应的URL
。组件处理中间件调用的代码应该对其余代码无侵入,只负责对传递过来的数据进行解析和组件内调用的功能。
每一个组件都是一个单独的工程,在组件开发完成后上传到git
仓库。主工程经过Cocoapods
集成各个组件,集成和更新组件时只须要pod update
便可。这样就是把每一个组件当作第三方来管理,管理起来很是方便。
Cocoapods
能够控制每一个组件的版本,例如在主项目中回滚某个组件到特定版本,就能够经过修改podfile
文件实现。选择Cocoapods
主要由于其自己功能很强大,能够很方便的集成整个项目,也有利于代码的复用。经过这种集成方式,能够很好的避免在传统项目中代码冲突的问题。
对于组件化架构的集成方式,我在看完bang的博客后专门请教了一下bang。根据在微博上和bang的聊天以及其余博客中的学习,在主项目中集成组件主要分为两种方式——源码和framework
,但都是经过CocoaPods
来集成。
不管是用CocoaPods
管理源码,仍是直接管理framework
,集成方式都是同样的,都是直接进行pod update
等CocoaPods
操做。
这两种组件集成方案,实践中也是各有利弊。直接在主工程中集成代码文件,能够看到其内部实现源码,方便在主工程中进行调试。集成framework
的方式,能够加快编译速度,并且对每一个组件的代码有很好的保密性。若是公司对代码安全比较看重,能够考虑framework
的形式。
例如手机QQ或者支付宝这样的大型程序,通常都会采起framework
的形式。并且通常这样的大公司,都会有本身的组件库,这个组件库每每能够表明一个大的功能或业务组件,直接添加项目中就可使用。关于组件化库在后面讲淘宝组件化架构的时候会提到。
对于项目中图片的集成,能够把图片当作一个单独的组件,组件中只存在图片文件,没有任何代码。图片可使用Bundle
和image assets
进行管理,若是是Bundle
就针对不一样业务模块创建不一样的Bundle
,若是是image assets
,就按照不一样的模块分类创建不一样的assets
,将全部资源放在同一个组件内。
Bundle
和image assets
二者相比,我仍是更推荐用assets
的方式,由于assets
自身提供不少功能(例如设置图片拉伸范围),并且在打包以后图片会被打包在.cer
文件中,不会被看到。(如今也能够经过工具对.cer
文件进行解析,获取里面的图片)
使用Cocoapods
,全部的资源文件都放置在一个podspec
中,主工程能够直接引用这个podspec
,假设此podspec
名为:Assets
,而这个Assets
的podspec
里面配置信息能够写为:
s.resources = "Assets/Assets.xcassets/ ** / *.{png}"
主工程则直接在podfile
文件中加入:
pod 'Assets', :path => '../MainProject/Assets'(这种写法是访问本地的,能够换成git)
这样便可在主工程直接访问到Assets
中的资源文件(不局限图片,sqlite
、js
、html
亦可,在s.resources
设置好配置信息便可)了。
在MGJRouter
方案中,是经过调用OpenURL:
方法并传入URL
来发起调用的。鉴于URL
协议名等固定格式,能够经过判断协议名的方式,使用配置表控制H5
和native
的切换,配置表能够从后台更新,只须要将协议名更改一下便可。
mgj://detail?id=123456 http://www.mogujie.com/detail?id=123456
假设如今线上的native
组件出现严重bug
,在后台将配置文件中原有的本地URL
换成H5
的URL
,并更新客户端配置文件。
在调用MGJRouter
时传入这个H5
的URL
便可完成切换,MGJRouter
判断若是传进来的是一个H5
的URL
就直接跳转webView
。并且URL
能够传递参数给MGJRouter
,只须要MGJRouter
内部作参数截取便可。
使用组件化架构开发,组件间的通讯都是有成本的。因此尽可能将业务封装在组件内部,对外只提供简单的接口。即“高内聚、低耦合”原则。
把握好组件划分粒度的细化程度,太细则项目过于分散,太大则项目组件臃肿。可是项目都是从小到大的一个发展过程,因此不断进行重构是掌握这个组件的细化程度最好的方式。
若是经过framework
等二进制形式,将组件集成到主项目中,须要注意预编译指令的使用。由于预编译指令在打包framework
的时候,就已经在组件二进制代码中打包好,到主项目中的时候预编译指令其实已经再也不起做用了,而是已经在打包时按照预编译指令编码为固定二进制。
对于项目架构来讲,必定要创建于业务之上来设计架构。不一样的项目业务不一样,组件化方案的设计也会不一样,应该设计最适合公司业务的架构。
我公司项目是一个地图导航应用,业务层之下的核心模块和基础模块占比较大,涉及到地图SDK、算路、语音等模块。且基础模块相对比较独立,对外提供了不少调用接口。由此能够看出,公司项目是一个重逻辑的项目,不像电商等App
偏展现。
项目总体的架构设计是:层级架构+组件化架构,对于具体的实现细节会在下面详细讲解。采起这种结构混合的方式进行总体架构,对于组件的管理和层级划分比较有利,符合公司业务需求。
在设计架构时,咱们将整个项目都拆分为组件,组件化程度至关高。用到哪一个组件就在工程中经过Podfile
进行集成,并经过URLRouter
统一全部组件间的通讯。
组件化架构是项目的总体框架,而对于框架中每一个业务模块的实现,能够是任意方式的架构,MVVM
、MVC
、MVCS
等都是能够的,只要经过MGJRouter
将组件间的通讯方式统一便可。
组件化架构在物理结构上来讲是不分层次的,只有组件与组件之间的划分关系。可是在组件化架构的基础上,应该根据项目和业务设计本身的层次架构,这套层次架构能够用来区分组件所处的层次及职责,因此咱们设计了层级架构+组件化架构的总体架构。
我公司项目最开始设计的是三层架构:业务层 -> 核心层 (high
+ low
) -> 基础层,其中核心层又分为high
和low
两部分。可是这种架构会形成核心层太重,基础层太轻的问题,这种并不适合组件化架构。
在三层架构中会发现,low
层并无耦合业务逻辑,在同层级中是比较独立的,职责较为单一和基础。咱们对low
层下沉到基础层中,并和基础层进行合并。因此架构被从新分为三层架构:业务层 -> 核心层 -> 基础层。以前基础层大可能是资源文件和配置文件,在项目中存在感并不高。
在分层架构中,须要注意只能上层对下层依赖,下层对上层不能有依赖,下层中不要包含上层业务逻辑。对于项目中存在的公共资源和代码,应该将其下沉到下层中。
在三层架构中,业务层负责处理上层业务,将不一样业务划分到相应组件中,例如IM
组件、导航组件、用户组件等。业务层的组件间关系比较复杂,会涉及到组件间业务的通讯,以及业务层组件对下层组件的引用。
核心层位于业务层下方,为业务层提供业务支持,如网络、语音识别等组件应该划分到核心层。核心层应该尽可能减小组件间的依赖,将依赖降到最小。核心层有时相互之间也须要支持,例如经纬度组件须要网络组件提供网络请求的支持,这种是不可避免的。
其余比较基础的模块,都放在基础层当作基础组件。例如AFN
、地图SDK
、加密算法等,这些组件都比较独立且不掺杂任何业务逻辑,职责更加单一,相对于核心层更底层。能够包含第三方库、资源文件、配置文件、基础库等几大类,基础层组件相互之间不该该产生任何依赖。
在设计各个组件时,应该遵循“高内聚,低耦合”的设计规范,组件的调用应该简单且直接,减小调用方的其余处理。 对于核心层和基础层的划分,能够以是否涉及业务、是否涉及同级组件间通讯、是否常常改动为参照点。若是符合这几点则放在核心层,若是不符合则放在基础层。
新建一个项目后,首先将配置文件、URLRouter
、App
容器等集成到主工程中,作一些基础的项目配置,随后集成须要的组件便可。项目被总体拆分为组件化架构后,应用对全部组件的集成方式都是同样的,经过Podfile
将须要的组件集成到项目中。经过组件化的方式,使得开发新项目速度变得很是快。
在集成业务层和核心层组件后,组件间的通讯都是由URLRouter
进行通讯,项目中不容许直接依赖组件源码。而基础层组件则在集成后直接依赖,例如资源文件和配置文件,这些都是直接在主工程或组件中使用的。第三方库则是经过核心层的业务封装,封装后由URLRouter
进行通讯,但核心层也是直接依赖第三方库源码的。
组件的集成方式有两种,源码和framework
的形式,咱们使用framework
的方式集成。由于通常都是项目比较大才用组件化的,但大型项目都会存在编译时间的问题,若是经过framework
则会大大减小编译时间,能够节省开发人员的时间。
对于组件间通讯,咱们采用的MGJRouter
方案。由于MGJRouter
如今已经很稳定了,并且能够知足蘑菇街这样量级的App
需求,证实是很好的,不必本身写一套再慢慢踩坑。
MGJRouter
的好处在于,其调用方式很灵活,经过MGJRouter
注册并在block
中处理回调,经过URL
直接调用或者URL+Params
字典的方式进行调用。因为经过URL
拼接参数或Params
字典传值,因此其参数类型没有数量限定,传递比较灵活。在经过openURL:
调用后,能够在completionBlock
中处理完成逻辑。
MGJRouter
有个问题在于,在编写组件间通讯的代码时,会涉及到大量的Hardcode
。对于Hardcode
的问题,蘑菇街开发了一套后台系统,将全部的Router
须要的URL
和参数名,都定义到这套系统中。咱们维护了一个Plist
表,内部按不一样组件进行划分,包含URL
和传参名以及回调参数。
组件化架构须要注意路由层的安全问题。MGJRouter
方案能够处理本地及远程的OpenURL
调用,若是是程序内组件间的OpenURL
调用,则不须要进行校验。而跨应用的OpenURL
调用,则须要进行合法性检查。这是为了防止第三方伪造进行OpenURL
调用,因此对应用外调起的OpenURL
进行的合法性检查,例如其余应用调起、服务器Remote Push
等。
在合法性检查的设计上,每一个从应用外调起的合法URL
都会带有一个token
,在本地会对token
进行校验。这种方式的优点在于,没有网络请求的限制和延时。
在项目中常常会用到代理模式传值,代理模式在iOS
中主要分为三部分,协议、代理方、委托方三部分。
但若是使用组件化架构的话,会涉及到组件与组件间的代理传值,代理方须要设置为委托方的delegate
,但组件间是不能够直接产生耦合的。对于这种跨组件的代理状况,咱们直接将代理方的对象经过MGJRouter
以参数的形式传给另外一个组件,在另外一个组件中进行代理设置。
HomeViewController *homeVC = [[HomeViewController alloc] init]; NSDictionary *params = @{CTBUserCenterLoginDelegateKey : homeVC}; [MGJRouter openURL:@"CTB://UserCenter/UserLogin" withUserInfo:params completion:nil]; [MGJRouter registerURLPattern:@"CTB://UserCenter/UserLogin" toHandler:^(NSDictionary *routerParameters) { UIViewController *homeVC = routerParameters[CTBUserCenterLoginDelegateKey]; LoginViewController *loginVC = [[LoginViewController alloc] init]; loginVC.delegate = homeVC; }];
协议的定义放在委托方组件的PublicHeader.h
中,代理方组件只引用这个PublicHeader.h
文件,不耦合委托方内部代码。为了不定义的代理方法中出现耦合的状况,方法中不能出现和组件内部业务有关的对象,只能传递系统的类。若是涉及到交互的状况,则经过协议方法的返回值进行。
MGJRouter
能够在openURL:
时传入一个NSDictionary
参数,在接触RAC
以后,我在想是否是能够把NSDictionary
参数变为RACSignal
参数,直接传一个信号过去。
注册MGJRouter
:
RACSignal *signal = [RACSignal createSignal:^RACDisposable *(id<RACSubscriber> subscriber) { [subscriber sendNext:@"刘小壮"]; return [RACDisposable disposableWithBlock:^{ NSLog(@"disposable"); }]; }]; [MGJRouter registerURLPattern:@"CTB://UserCenter/getUserInfo" withSignal:signal];
调用MGJRouter
:
RACSignal *signal = [MGJRouter openURL:@"CTB://UserCenter/getUserInfo"]; [signal subscribeNext:^(NSString *userName) { NSLog(@"userName %@", userName); }];
这种方式是可行的。使用RACSignal
方式优势在于,相对于直接传字典过去更加灵活,而且具有RAC
的诸多特性。但缺点也很多,信号控制很差乱用的话也很容易挖坑,是否使用仍是看团队状况了。
在项目中常常会定义一些常量,例如通知名、常量字符串等,这些常量通常都和所属组件有很强的关系,很差单独拆出来放到其余组件。可是这些变量数量并非不少,并且不是每一个组件中都有。
因此,咱们将这些变量都声明在PublicHeader.h
文件中,其余组件只能引用PublicHeader.h
文件,不能引用组件内部业务代码,这样就规避掉了组件间耦合的问题。
在项目中常常会用到H5
页面,若是能经过点击H5
页面调起原生页面,这样的话Native
和H5
的融合会更好。因此咱们设计了一套H5
和Native
交互的方案,这套方案可使用URLRouter
的方式调起原生页面,实现方式也很简单,而且这套方案和H5
本来的跳转逻辑并不冲突。
经过iOS
自带UIWebView
建立一个H5
页面后,H5
能够经过调用下面的JS
函数和Native
通讯。调用时能够传入新的URL
,这个URL
能够设置为URLRouter
的URL
。
window.location.href = 'CTB://UserCenter/UserLogin?userName=lxz&WeChatID=lz2046703959';
经过JS
刷新H5
页面时,会调用下面的代理方法。若是方法返回YES
,则会根据URL
协议进行跳转。
- (BOOL)webView:(UIWebView *)webView shouldStartLoadWithRequest:(NSURLRequest *)request navigationType:(UIWebViewNavigationType)navigationType;
跳转时系统会判断通讯协议,若是是HTTP
等标准协议,则会在当前页面进行刷新。若是跳转协议在URL Schame
中注册,则会经过系统openURL:
的方式调用到AppDelegate
的系统代理方法中,在代理方法中调用URLRouter
,则能够经过H5
页面唤起原生页面。
在应用启动过程当中,一般会作一些初始化操做。有些初始化操做是运行程序所须要的,例如崩溃统计、创建服务器的长链接等。或有的组件会对初始化操做有依赖关系,例如网络组件依赖requestToken
等。
对于应用启动时的初始化操做,应该建立一个AppService
来统一管理启动操做,将初始化操做都放在里面,包含建立根控制器等。其中有的初始化操做须要尽快执行,有的并不须要当即执行,能够根据不一样操做设定优先级,来管理全部初始化操做。
#import <Foundation/Foundation.h> typedef NS_ENUM(NSUInteger, CTBAppServicePriority) { CTBAppServicePriorityLow, CTBAppServicePriorityDefault, CTBAppServicePriorityHigh, }; @interface CTBAppService : NSObject + (instancetype)appService; - (void)registerService:(dispatch_block_t)serviceBlock priority:(CTBAppServicePriority)priority; @end
项目中存在不少的模型定义,那组件化后这些模型应该定义在哪呢?
casatwy对模型类的观点是去Model
化,简单来讲就是用字典代替Model
存储数据。这对于组件化架构来讲,是解决组件之间数据传递的一个很好的方法。可是去Model
的方式,会存在大量的字段读取代码,使用起来远没有模型类方便。
由于模型类是关乎业务的,理论上必须放在业务层也就是业务组件这一层。可是要把模型对象从一个组件中当作参数传递到另外一个组件中,模型类放在调用方和被调方的哪一个组件都不太合适,并且有可能不仅两个组件使用到这个模型对象。这样的话在其余组件使用模型对象,必然会形成引用和耦合。
若是在用到这个模型对象的全部组件中,都分别维护一份相同的模型类,或者各自维护不一样结构的模型类,这样以后业务发生改变模型类就会很麻烦,这是不可取的。
若是将全部模型类单独拉出来,定义一个模型组件呢?
这个看起来比较可行,将这个定义模型的组件下沉到基础层,模型组件不包含业务,只声明模型对象的类。 若是将原来各个组件的模型类定义都拉出来,单独放在一个组件中,能够将原有各组件的Model
层变得很轻量,这样对整个项目架构来讲也是有好处的。
在经过Router
进行组件间调用时,经过字典进行传值,这种方式比较灵活。在组件内部使用Model
层时,仍是用模型组件中定义的Model
类。Model
层建议仍是用Model
对象的形式比较方便,不建议总体使用去Model
化的设计。在接收到其余组件传递过来的字典参数时,能够经过Model
类提供的初始化方法,或其余转Model
框架将字典转为Model
对象。
@interface CTBStoreWelfareListModel : NSObject /** * 自定义初始化方法 */ - (instancetype)initWithDict:(NSDictionary *)dict; @end
我公司持久化方案用的是CoreData
,全部模型的定义都在CoreData
组件中,则不须要再单首创建一个模型组件。
我公司项目是一个常规的地图类项目,首页和百度、高德等主流地图导航App
同样,有不少添加在地图上的控件。有的版本会添加控件上去,而有的版本会删除控件,与之对应的功能也会被隐藏。
因此,有次和组里小伙伴们开会的时候就在考虑, 能不能在服务器下发代码对首页进行布局! 这样就能够对首页进行动态布局,例若有活动的时候在指定时间显示某个控件,这样能够避免App Store
审核慢的问题。又或者线上某个模块出现问题,能够紧急下架出问题的模块。
对于这个问题,咱们设计了一套动态配置方案,这套方案能够对整个App
进行配置。
对于动态配置的问题,咱们简单设计了一个配置表,初期打算在首页上先进行试水,之后可能会布置到更多的页面上。这样应用程序各模块的入口,均可以经过配置表来控制,而且经过Router
控制页面间跳转,灵活性很是大。
在第一次安装程序时使用内置的配置表,以后每次都用服务器来替换本地的配置表,这样就能够实现动态配置应用。下面是一个简单设计的配置数据,JSON
中配置的是首页的配置信息,用来模拟服务器下发的数据,真正服务器下发的字段会比这个多不少。
{ "status": 200, "viewList": [ { "className": "UIButton", "frame": { "originX": 10, "originY": 10, "sizeWidth": 50, "sizeHeight": 30 }, "normalImageURL": "http://image/normal.com", "highlightedImageURL": "http://image/highlighted.com", "normalText": "text", "textColor": "#FFFFFF", "routerURL": "CTB://search/***" } ] }
对于服务器返回的数据,咱们会建立一套解析器,这个解析器用来将JSON
解析并“转换”为标准的UIKit
控件。点击后的事件都经过Router
进行跳转,因此首页的灵活性和Router
的使用程度成正比。
这套方案相似于React Native
的方案,从服务器下发页面展现效果,但没有React Native
功能那么全。相对而言是一个轻量级的配置方案,主要用于页面配置。
除了页面的配置以外,咱们发现地图类App
通常都存在ipa
过大的问题,这样在下载时很消耗流量以及时间。因此咱们就在想能不能把资源也作到动态配置,在用户运行程序的时候再加载资源文件包。
咱们想经过配置表的方式,将图片资源文件都放到服务器上,图片的URL
也随配置表一块儿从服务器获取。在使用时请求图片并缓存到本地,成为真正的网络APP
。在此基础上设计缓存机制,按期清理本地的图片缓存,减小用户磁盘占用。
以前看过滴滴iOS
负责人李贤辉的技术分享,分享的是滴滴iOS
客户端的架构发展历程,下面简单总结一下。
滴滴在最开始的时候架构较混乱。而后在2.0时期重构为MVC
架构,使项目划分更加清晰。在3.0时期上线了新的业务线,这时开始采用游戏开发中的状态机机制,暂时能够知足现有业务。
然而在后期不断上线顺风车、代驾、巴士等多条业务线的状况下,现有架构变得很是臃肿,代码耦合严重。从而在2015年开始了代号为“The One”
的方案,这套方案就是滴滴的组件化方案。
滴滴的组件化方案,和蘑菇街方案相似,将项目拆分为各个组件,经过CocoaPods
来集成和管理各个组件。项目被拆分为业务部分和技术部分,业务部分包括专车、拼车、巴士等组件,使用一个pods
管理。技术部分则分为登陆分享、网络、缓存这样的一些基础组件,分别使用不一样的pods
管理。
组件间通讯经过ONERouter
中间件进行通讯,ONERouter
相似于MGJRouter
,担负起协调和调用各个组件的做用。组件间通讯经过OpenURL
方法,来进行对应的调用。ONERouter
内部保存一份Class-URL
的映射表,经过URL
找到Class
并发起调用,Class
的注册放在+load
方法中进行。
滴滴在业务组件内部使用MVVM+MVCS
混合的架构,两种架构都是MVC
的衍生版本。其中MVCS
中的Store
负责数据相关逻辑,例如订单状态、地址管理等数据处理。经过MVVM
中的VM
给控制器瘦身,最后Controller
的代码量就不多了。
滴滴文章中说道首页只能有一个地图实例,这在不少地图导航相关应用中都是这样作的。滴滴首页主控制器持有导航栏和地图,每一个业务线首页控制器都添加在主控制器上,而且业务线控制器背景都设置为透明,将透明部分响应事件传递到下面的地图中,只响应属于本身的响应事件。
由主控制器来切换各个业务线首页,切换页面后根据不一样的业务线来更新地图数据。
本章节源自于宗心在阿里技术沙龙上的一次技术分享
淘宝iOS
客户端初期是单工程的普通项目,但随着业务的飞速发展,现有架构并不能承载愈来愈多的业务需求,致使代码间耦合很严重。后期开发团队对其不断进行重构,将项目重构为组件化架构,淘宝iOS
和Android
两个平台,除了某个平台特有的一些特性或某些方案不便实施以外,大致架构都是差很少的。
发展历程
MVC
架构进行开发。随着业务不断的增长,致使项目很是臃肿、耦合严重。淘宝开始实行插件化架构,将每一个业务模块划分为一个子工程,将组件以framework
二方库的形式集成到主工程。但这种方式并无作到真正的拆分,仍是在一个工程中使用git
进行merge
,这样还会形成合并冲突、很差回退等问题。
framework
。主工程经过podfile
集成全部组件的framework
,实现业务之间真正的隔离,经过CocoaPods
实现组件化架构。淘宝是使用git
来作源码管理的,在插件化架构时须要尽量避免merge
操做,不然在大团队中协做成本是很大的。而使用CocoaPods
进行组件化开发,则避免了这个问题。
在CocoaPods
中能够经过podfile
很好的配置各个组件,包括组件的增长和删除,以及控制某个组件的版本。使用CocoaPods
的缘由,很大程度是为了解决大型项目中,代码管理工具merge
代码致使的冲突。而且能够经过配置podfile
文件,轻松配置项目。
每一个组件工程有两个target
,一个负责编译当前组件和运行调试,另外一个负责打包framework
。先在组件工程作测试,测试完成后再集成到主工程中集成测试。
每一个组件都是一个独立app
,能够独立开发、测试,使得业务组件更加独立,全部组件能够并行开发。下层为上层提供能知足需求的底层库,保证上层业务层能够正常开发,并将底层库封装成framework
集成到主工程中。
使用CocoaPods
进行组件集成的好处在于,在集成测试本身组件时,能够直接在本地主工程中,经过podfile
使用当前组件源码,能够直接进行集成测试,不须要提交到服务器仓库。
淘宝架构的核心思想是一切皆组件,将工程中全部代码都抽象为组件。
淘宝架构主要分为四层,最上层是组件Bundle
(业务组件),依次往下是容器(核心层),中间件Bundle
(功能封装),基础库Bundle
(底层库)。容器层为整个架构的核心,负责组件间的调度和消息派发。
总线设计:URL
路由+服务+消息。统一全部组件的通讯标准,各个业务间经过总线进行通讯。
经过URL
总线对三端进行了统一,一个URL
能够调起iOS
、Android
、前端三个平台,产品运营和服务器只须要下发一套URL
便可调用对应的组件。
URL
路由能够发起请求也能够接受返回值,和MGJRouter
差很少。URL
路由请求能够被解析就直接拿来使用,若是不能被解析就跳转H5
页面。这样就完成了一个对不存在组件调用的兼容,使用户手中比较老的版本依然能够显示新的组件。
服务提供一些公共服务,由服务方组件负责实现,经过Protocol
进行调用。
应用经过消息总线进行事件的中心分发,相似于iOS
的通知机制。例如客户端先后台切换,则能够经过消息总线分发到接收消息的组件。由于经过URLRouter
只是一对一的进行消息派发和调度,若是屡次注册同一个URL
,则会被覆盖掉。
在组件化架构的基础上,淘宝提出Bundle App
的概念,能够经过已有组件,进行简单配置后就能够组成一个新的app
出来。解决了多个应用业务复用的问题,防止重复开发同一业务或功能。
Bundle
即App
,容器即OS
,全部Bundle App
被集成到OS
上,使每一个组件的开发就像app
开发同样简单。这样就作到了从巨型app
回归普通app
的轻盈,使大型项目的开发问题完全获得了解决。
到目前为止组件化架构文章就写完了,文章确实挺长的,看到这里真是辛苦你了😁。下面留个小思考,把下面字符串复制到微信输入框随便发给一个好友,而后点击下面连接大概也能猜到微信的组件化方案。
weixin://dl/profile
各位能够来我博客评论区讨论,能够讨论文中提到的技术细节,也能够讨论本身公司架构所遇到的问题,或本身独到的看法等等。不管是否是架构师或新入行的iOS
开发,欢迎各位以一个讨论技术的心态来讨论。在评论区你的问题能够被其余人看到,这样可能会给其余人带来一些启发。
Demo
地址:蘑菇街和casatwy
组件化方案,其Github
上都给出了Demo
,这里就贴出其Github
地址了。
蘑菇街-MGJRouter
casatwy-CTMediator
好多朋友在看完这篇文章后,都问有没有Demo
。其实架构是思想上的东西,重点仍是理解架构思想。文章中对思想的概述已经很全面了,用多个项目的例子来描述组件化架构。就算提供了Demo
,也无法把Demo
套在其余工程上用,由于并不必定适合所在的工程。
后来想了一下,我把组件化架构的集成方式,简单写了个Demo
,这样能够解决不少人在架构集成上的问题。我把Demo
放在我Github上了,用Coding的服务器来模拟我公司私有服务器,直接拿MGJRouter
来当Demo
工程中的Router
。下面是Demo
地址,麻烦各位记得点个star😁。
因为简书排版并非很好,因此作了一个PDF
版的《组件化架构漫谈》,放在我Github
上了。PDF
上有文章目录,方便阅读,下面是地址。
若是你以为不错,请把PDF帮忙转到其余群里,或者你的朋友,让更多的人了解组件化架构,衷心感谢! 😁
Github地址 : https://github.com/DeveloperErenLiu/ComponentArchitectureBook