该文章属于<简书 — 刘小壮>原创,转载请注明:
<简书 — 刘小壮> http://www.jianshu.com/p/67a6004f6930
前段时间公司项目打算重构,准确来说应该是按之前的产品逻辑重写一个项目😂。在重构项目之前涉及到架构选型的问题,我和组里小伙伴一起研究了一下组件化架构,打算将项目重构为组件化架构。当然不是直接拿来照搬,还是要根据公司具体的业务需求设计架构。
在学习组件化架构的过程中,从很多高质量的博客中学到不少东西,例如蘑菇街李忠、casatwy、bang的博客。在学习过程中也遇到一些问题,在微博和QQ上和一些做
iOS
的朋友进行了交流,非常感谢这些朋友的帮助。本篇文章主要针对于之前蘑菇街提出的组件化方案,以及casatwy提出的组件化方案进行分析,后面还会简单提到滴滴、淘宝、微信的组件化架构,最后会简单说一下我公司设计的组件化架构。
占位图
组件化架构的由来
随着移动互联网的不断发展,很多程序代码量和业务越来越多,现有架构已经不适合公司业务的发展速度了,很多都面临着重构的问题。
在公司项目开发中,如果项目比较小,普通的单工程+MVC架构
就可以满足大多数需求了。但是像淘宝、蘑菇街、微信这样的大型项目,原有的单工程架构就不足以满足架构需求了。
就拿淘宝来说,淘宝在13年开启的“All in 无线”
战略中,就将阿里系大多数业务都加入到手机淘宝中,使客户端出现了业务的爆发。在这种情况下,单工程架构则已经远远不能满足现有业务需求了。所以在这种情况下,淘宝在13年开启了插件化架构的重构,后来在14年迎来了手机淘宝有史以来最大规模的重构,将其彻底重构为组件化架构。
蘑菇街的组件化架构
原因
在一个项目越来越大,开发人员越来越多的情况下,项目会遇到很多问题。
- 业务模块间划分不清晰,模块之间耦合度很大,非常难维护。
- 所有模块代码都编写在一个项目中,测试某个模块或功能,需要编译运行整个项目。
为了解决上面的问题,可以考虑加一个中间层来协调模块间的调用,所有的模块间的调用都会经过中间层中转。(注意看两张图的箭头方向)
添加中间层但是发现增加这个中间层后,耦合还是存在的。中间层对被调用模块存在耦合,其他模块也需要耦合中间层才能发起调用。这样还是存在之前的相互耦合的问题,而且本质上比之前更麻烦了。
架构改进
所以应该做的是,只让其他模块对中间层产生耦合关系,中间层不对其他模块发生耦合。
对于这个问题,可以采用组件化的架构,将每个模块作为一个组件。并且建立一个主项目,这个主项目负责集成所有组件。这样带来的好处是很多的:
- 业务划分更佳清晰,新人接手更佳容易,可以按组件分配开发任务。
- 项目可维护性更强,提高开发效率。
- 更好排查问题,某个组件出现问题,直接对组件进行处理。
- 开发测试过程中,可以只编译自己那部分代码,不需要编译整个项目代码。
- 方便集成,项目需要哪个模块直接通过CocoaPods集成即可。
进行组件化开发后,可以把每个组件当做一个独立的app,每个组件甚至可以采取不同的架构,例如分别使用MVVM
、MVC
、MVCS
等架构。
MGJRouter方案
蘑菇街通过MGJRouter
实现中间层,通过MGJRouter
进行组件间的消息转发,从名字上来说更像是“路由器”。实现方式大致是,在提供服务的组件中提前注册block
,然后在调用方组件中通过URL
调用block
,下面是调用方式。
架构设计
MGJRouter组件化架构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
来集成,将所有组件当做二方库集成到项目中。详细的集成技术点在下面“标准组件化架构设计”
章节中会讲到。
MGJRouter调用
代码模拟对详情页的注册、调用,在调用过程中传递id
参数。参数传递可以有两种方式,类似于Get请求在URL
后面拼接参数,以及通过字典传递参数。下面是注册的示例代码:
[MGJRouter registerURLPattern:@"mgj://detail?id=id" 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
,可以保持统一性。
基础组件
在项目中存在很多公共部分的东西,例如封装的网络请求、缓存、数据处理等功能,以及项目中所用到的资源文件。
蘑菇街将这些部分也当做组件,划分为基础组件,位于业务组件下层。所有业务组件都使用同一个基础组件,也可以保证公共部分的统一性。
Protocol方案
整体架构
Protocol方案的中间件为了解决MGJRouter
方案中URL
硬编码,以及字典参数类型不明确等问题,蘑菇街在原有组件化方案的基础上推出了Protocol
方案。Protocol
方案由两部分组成,进行组件间通信的ModuleManager
类以及MGJComponentProtocol
协议类。
通过中间件ModuleManager
进行消息的调用转发,在ModuleManager
内部维护一张映射表,映射表由之前的"URL -> block"
变成"Protocol -> Class"
。
在中间件中创建MGJComponentProtocol
文件,服务方组件将可以用来调用的方法都定义在Protocol
中,将所有服务方的Protocol
都分别定义到MGJComponentProtocol
文件中,如果协议比较多也可以分开几个文件定义。这样所有调用方依然是只依赖中间件,不需要依赖除中间件之外的其他组件。
Protocol
方案中每个组件需要一个PublicHeader,此类负责实现当前组件对应的协议方法,也就是对外提供服务的实现。在程序开始运行时将自身的Class
注册到ModuleManager
中,并将Protocol
反射为字符串当做key
,Protocol方案需要提前注册服务。
Protocol
方案依然需要提前注册,由于Protocol
方案是返回一个Class
,并将Class
反射为对象再调用方法,这种方式不会直接调用类的内部逻辑。可以将Protocol
方案的Class
注册,都放在对应类的PublicHeader
中,或者专门建立一个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];
项目调用流程
蘑菇街是OpenURL
和Protocol
混用的方式,两种实现的调用方式不同,但大体调用逻辑和实现思路类似。在OpenURL
不能满足需求或调用不方便时,就可以通过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
方案并不会造成太大的内存占用。被保存在字典中是一个block
对象,而block
自身的实现只是一个结构体,也就相当于字典中存放的是很多结构体,所以内存的占用并不是很大。 -
对于协议这种实现方式,和
block
内存常驻方式差不多。只是将存储的block
对象换成Class
对象,如果不是已经实例化的对象,内存占用还是比较小的。
casatwy组件化方案
整体架构
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将类和方法的命名,都统一按照其功能做区分当做前缀,这样很好的将组件相关和组件内部代码进行了划分。
标准组件化架构设计
这个章节叫做“标准组件化架构设计”,对于项目架构来说并没有绝对意义的标准之说。这里说到的“标准组件化架构设计”只是因为采取这样的方式的人比较多,且这种方式相比而言较合理。
在上面文章中提到了casatwy方案的CTMediator
,蘑菇街方案的MGJRouter
和ModuleManager
,下面统称为中间件。
整体架构
组件化架构中,首先有一个主工程,主工程负责集成所有组件。每个组件都是一个单独的工程,创建不同的git
私有仓库来管理,每个组件都有对应的开发人员负责开发。开发人员只需要关注与其相关组件的代码,其他业务代码和其无关,这样来新人也好上手。
组件的划分需要注意组件粒度,粒度根据业务可大可小。组件划分后属于业务组件,对于一些多个组件共同的东西,例如网络、数据库之类的,应该划分到单独的组件或基础组件中。对于图片或配置表这样的资源文件,应该再单独划分一个资源组件,这样避免资源的重复性。
服务方组件对外提供服务,由中间件调用或发现服务,服务对当前组件无侵入性,只负责对传递过来的数据进行解析和组件内调用的功能。需要被其他组件调用的组件都是服务方,服务方也可以调用其他组件的服务。
优点
通过这样的组件划分,组件的开发进度不会受其他业务的影响,可以多个组件单独的并行开发。组件间的通信都交给中间件来进行,需要通信的类只需要接触中间件,而中间件不需要耦合其他组件,这就实现了组件间的解耦。中间件负责处理所有组件之间的调度,在所有组件之间起到控制核心的作用。
组件化框架清晰的划分了不同模块,从整体架构上来约束开发人员进行组件化开发。组件化架构在各个模块之间天然形成了一道屏障,避免某个开发人员偷懒直接引用头文件,产生组件间的耦合,破坏整体架构。
使用组件化架构进行开发时,因为每个人都负责自己的模块,代码提交也只提交自己负责模块的仓库,所以代码冲突的问题会变得很少。
假设以后某个业务发生大的改变,需要对相关代码进行重构,可以在单个组件进行重构。组件化架构降低了重构的风险,保证了代码的健壮性。
组件集成
组件化架构图每个组件都是一个单独的工程,在组件开发完成后上传到git
仓库。主工程通过Cocoapods
集成各个组件,集成和更新组件时只需要pod update
即可。这样就是把每个组件当做第三方来管理,管理起来非常方便。
Cocoapods
可以控制每个组件的版本,例如在主项目中回滚某个组件到特定版本,就可以通过修改podfile
文件实现。选择Cocoapods
主要因为其本身功能很强大,可以很方便的集成整个项目,也有利于代码的复用。通过这种集成方式,可以很好的避免在传统项目中代码冲突的问题。
集成方式
对于组件化架构的集成方式,我在看完bang的博客后专门请教了一下bang。根据在微博上和bang的聊天以及其他博客中的学习,在主项目中集成组件主要分为两种方式——源码和framework
,但都是通过CocoaPods
来集成。
无论是用CocoaPods
管理源码,还是直接管理framework
,集成方式都是一样的,都是直接进行pod update
等CocoaPods
操作。
这两种组件集成方案,实践中也是各有利弊。直接在主工程中集成代码文件,可以在主工程中进行调试。集成framework
的方式,可以加快编译速度,而且对每个组件的代码有很好的保密性。如果公司对代码安全比较看重,可以考虑framework
的形式,但framework
不利于主工程中的调试。
例如手机QQ或者支付宝这样的大型程序,一般都会采取framework
的形式。而且一般这样的大公司,都会有自己的组件库,这个组件库往往可以代表一个大的功能或业务组件,直接添加项目中就可以使用。关于组件化库在后面讲淘宝组件化架构的时候会提到。
不推荐的集成方式
之前有些项目是直接用workspace
的方式集成的,或者直接在原有项目中建立子项目,直接做文件引用。但这两点都是不建议做的,因为没有真正意义上实现业务组件的剥离,只是像之前的项目一样从文件目录结构上进行了划分。
图片集成
对于项目中图片的集成,可以把图片当做一个单独的组件,组件中只存在图片文件,没有任何代码。图片可以使用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
设置好配置信息即可)了。
注意点
如果通过framework
等二进制形式,将组件集成到主项目中,需要注意预编译指令的使用。因为预编译指令在打包framework
的时候,就已经在组件二进制代码中打包好,到主项目中的时候预编译指令其实已经不再起作用了,而是已经在打包时按照预编译指令编码为固定二进制。
组件化开发总结
对于项目架构来说,一定要建立于业务之上来设计架构。不同的项目业务不同,组件化方案的设计也会不同,应该设计最适合公司业务的架构。
架构对比
硬编码
在除蘑菇街Protocol
方案外,其他两种方案都或多或少的存在硬编码问题,硬编码如果量比较大的话挺麻烦的。
在casatwy的CTMediator
方案中需要硬编码Target
、Action
字符串,只不过这个缺陷被封闭在中间件里面了,将这些字符串都统一定义为常量,外界使用不需要接触到硬编码。蘑菇街的MGJRouter
的方案也是一样的,也有硬编码URL
的问题,蘑菇街可能也做了类似的处理。
调用方式
casatwy和蘑菇街提出的两套组件化方案,大体结构是类似的,三套方案都分为调用方、中间件、服务方,只是在具体实现过程中有些不同。例如Protocol
方案在中间件中加入了Protocol
文件,casatwy的方案在中间件中加入了Category
。
三种方案内部都有容错处理,所以三种方案的稳定性都是比较好的,而且都可以拿出来单独运行,在服务方不存在的情况下也不会有问题。
服务方
在三套方案中,服务方组件都对外提供一个PublicHeader
或Target
,在文件中统一定义对外提供的服务,从文件中就知道服务方可以做什么。
但三套实现方案实现方式却不同,蘑菇街的两套方案都需要注册操作,无论是Block
还是Protocol
都需要注册后才可以提供服务。而casatwy的方案则不需要,直接通过runtime
调用。casatwy的方案实现了真正的对服务方解耦,而蘑菇街的两套方案则没有,对服务方和调用方都造成了耦合。
小总结
我认为三套方案中,Protocol
方案是调用和维护最麻烦的一套方案。修改组件间通信方式时需要维护Protocol
,在调用时需要将Class
给调用方,再由调用方进行实例化及调用操作,这在开发中是非常影响开发效率的。
总结
下面是组件化开发中的一个小总结,也是开发过程中的一些注意点。
- 在
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
内部做参数截取即可。
-
casatwy方案和蘑菇街
Protocol
方案,都提供了传递明确类型参数的方法。在MGJRouter
方案中,传递参数主要是通过类似GET
请求一样在URL
后面拼接参数,和在字典中传递参数两种方式组成。这两种方式会造成传递参数类型不明确,传递参数类型受限(GET
请求不能传递对象)等问题,后来使用Protocol
方案弥补这个问题。 -
组件化开发可以很好的提升代码复用性,组件可以直接拿到其他项目中使用,这个优点在下面淘宝架构中会着重讲一下。
-
对于调试工作,应该放在每个组件中完成。单独的业务组件可以直接提交给测试提测,这样测试起来也比较方便。最后组件开发完成并测试通过后,再将所有组件更新到主项目,提交给测试进行集成测试即可。
-
使用组件化架构开发,组件间的通信都是有成本的。所以尽量将业务封装在组件内部,对外只提供简单的接口。即“高内聚、低耦合”原则。
-
把握好组件划分粒度的细化程度,太细则项目过于分散,太大则项目组件臃肿。但是项目都是从小到大的一个发展过程,所以不断进行重构是掌握这个组件的细化程度最好的方式。
我公司架构
架构设计
下面就说说我公司项目的架构,公司项目是一个地图导航应用,业务层之下的基础组件占比较大,涉及到地图SDK、算路、语音等模块。且基础组件相对比较独立,对外提供了很多调用接口。由此可以看出,公司项目是一个重逻辑的项目,不像电商等App偏展示。
项目基础部分占比比较大,整体的架构设计是:层级架构+组件化架构,对于具体的实现细节会在下面详细讲解。采取这种结构混合的方式进行整体架构,对于组件的管理和层级划分比较有利,符合公司业务需求。
公司组件化架构在设计层级架构时,我们将所有层级的组件都“一视同仁”,用到哪个组件就在当前组件的Podfile
中引入。这样所有组件都会涉及到和Router
的通信,通信方式完全统一。
组件间通信
对于组件间通信,我们采用的MGJRouter
方案。因为MGJRouter
现在已经很稳定了,而且可以满足蘑菇街这样量级的App
需求,证明是很好的,没必要自己写一套再慢慢踩坑。
MGJRouter
的好处在于,其调用方式很灵活,通过MGJRouter
注册并在block
中处理回调,通过URL
直接调用或者URL+Params
字典的方式进行调用。调用后有返回值,返回值类型无限定。
由于通过URL
拼接参数或Params
字典传值,所以其参数类型没有数量限定,传递比较灵活。在通过openURL:
调用后,可以在completionBlock
中处理完成逻辑。
MGJRouter
的问题在于,在编写组件间通信的代码时,会涉及到大量的Hardcood
。对于Hardcode
的问题,我们将所有涉及到Hardcode
的代码都放在组件的PublicHeader.h
中,这样只需要通过PublicHeader
就知道当前组件所提供的能力。
一个小思考
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
当做参数的方式,可以避免大量参数Hardcode
的问题,参数通过RACSignal
的方式传递。这样可以将参数传递、方法调用等操作,都由一个RACSignal
对象来完成,统一调用方式。而且通过openURL:
拿到RACSignal
后,还可以基于RAC
的特性做其他函数响应式的编程。
分层架构
四层架构
组件化架构在物理结构上来说是不分层次的,只是组件与组件之间的依赖关系。但是在组件化架构的基础上,应该根据项目和业务设计自己的层次架构,这套层次架构可以用来区分组件所处的层次及职责,所以我们设计了层级架构+组件化架构的架构。
我公司项目最开始设计的是三层架构:业务层 -> 核心层 (high
+ low
) -> 基础层,其中核心层又分为high
和low
两部分。但是这种架构会造成核心层过重,基础层过轻的问题。在上面三层架构中会发现,low
层其实是可以单独拆出来的,low
层是完全独立于其他层的,且功能比较基础和独立。
所以可以拆分为四层架构:业务层 -> 核心层 -> 基础层 -> 资源层。之前的基础层大多都是资源文件,所以下沉到资源层。将之前核心层的low
层拆分为基础层,拆分后的核心层为业务层提供业务支撑,封装网络、数据库等核心模块,实现真正意义上的核心。
在分层架构中,需要注意只能上层对下层依赖,下层对上层不能有依赖,下层中不要包含上层业务逻辑。对于项目中存在的公共资源和代码,应该将其下沉到下层中。
架构设计思考
在四层架构中,业务层用来处理上层业务,例如个人中心模块、搜索模块、语音处理模块等。这些模块的组件间关系比较复杂,会涉及到业务组件之间的关系,以及业务层对下层核心层组件的引用。
在设计核心层时就需要注意了,核心层需要为上层提供业务支持,而且应该遵循“高内聚,低耦合”的设计规范。核心层组件应该调用方便,而且对上层无依赖,不需要上层做太多的处理即可完成任务。
核心层的设计应该尽量无耦合,但是并不能做到完全无耦合。例如核心层的分享和网络两个同级组件,分享可能会调用到网络的代码,例如分享成功后向公司服务器发送请求,这时候就不可避免的产生核心层组件间的引用。
一些和业务无关的模块,也就是纯技术的模块,应该放在基础层中当做基础组件。基础组件包含加密、基础网络库(AFNetworking
)、图片库(SDWebImage
)等模块,在基础层中的各个组件间不应该有任何耦合,如果有耦合也只能发生在核心层和业务层。
基础层的组件应该符合“单一职责”的原则,即当前组件只负责和组件相关的事,不会包含其他不相关的代码。例如分享中不应该包含网络请求,如果包含则放在核心层中。
对于核心层和基础层的划分,可以以是否涉及业务、是否涉及同级组件间通信、是否经常改动为参照点。如果符合这几点则放在核心层,如果不符合则放在基础层。
最底层的资源层用来存放资源文件、图片、Plist
等和代码无关的东西,资源层的设计也应该设计为组件的形式。图片统一放在一个组件中,Plist
或配置文件单独放在一个组件中,等等。这样可以使整个项目都以组件的形式进行开发。
模型类怎么办,放在哪合适?
casatwy对模型类的观点是去Model化,简单来说就是用字典代替Model
存储数据。这对于组件化架构来说,是解决组件之间数据传递的一个很好的方法。但是去Model的方式,会存在大量的字段读取代码,使用起来远没有模型类方便。
因为模型类是关乎业务的,理论上必须放在业务层也就是业务组件这一层。但是要把模型对象从一个组件中当做参数传递到另一个组件中,模型类放在调用方和服务方的哪个组件都不太合适,而且有可能不只两个组件使用到这个模型对象。这样的话在其他组件使用模型对象,必然会造成引用和耦合。
如果在用到这个模型对象的所有组件中,都分别维护一份相同的模型类,或者各自维护不同结构的模型类,这样之后业务发生改变模型类就会很麻烦。
那应该怎么办呢?
如果将所有模型类单独拉出来,定义一个模型组件呢?
这个看起来比较可行,将这个定义模型的组件下沉到核心层,模型组件不包含业务,只声明模型对象的类。如果将原来各个组件的模型类定义都拉出来,单独放在一个组件中,可以将原有各模块的Model层变得很轻量,这样对整个项目架构来说也是有好处的。
上面只是思考,恰巧我公司持久化方案用的是CoreData
,所有模型的定义都在CoreData
组件中,这样就避免了业务层组件之间因为模型类的耦合。
动态化构想
我公司项目是一个常规的地图类项目,首页和百度、高德等主流地图导航App
一样,有很多布置在地图上的控件。有的版本会添加控件上去,而有的版本会删除控件,与之对应的功能也会被隐藏。
所以,有次和组里小伙伴们开会的时候就在考虑,能不能在服务器下发代码对首页进行布局!这样就可以对首页进行动态布局,例如有活动的时候在指定时间显示某个控件,这样可以避免App Store
审核慢的问题。又或者线上某个模块出现问题,需要紧急下架出问题的模块。
对于这个问题,我们设计了一套动态配置方案,这套方案可以对整个App
进行配置。
配置表设计
对于动态配置的问题,我们简单设计了一个配置表,初期打算在首页上先进行试水,以后可能会布置到更多的页面上。这样应用程序各模块的入口,都可以通过配置表来控制,并且通过Router
进行模块间跳转,灵活性非常大。
在第一次安装程序时使用内置的配置表,之后每次都用服务器来替换本地的配置表,这样就可以实现动态配置应用。
下面是一个简单设计的假接口,这个接口里是首页的配置信息,用来模拟服务器下发的数据,真正服务器下发的字段会比这个多很多。
{
"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
的使用程度成正比。
资源动态配置
除了页面的配置之外,我们发现地图类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
架构进行开发。随着业务不断的增加,导致项目非常臃肿、耦合严重。 -
2013年淘宝开启"all in 无线"计划,计划将淘宝变为一个大的平台,将阿里系大多数业务都集成到这个平台上,造成了业务的大爆发。
淘宝开始实行插件化架构,将每个业务模块划分为一个组件,将组件以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
可以请求也可以接受返回值,和MGJRouter
差不多。URL
路由请求可以被解析就直接拿来使用,如果不能被解析就跳转H5
页面。这样就完成了一个对不存在组件调用的兼容,使用户手中比较老的版本依然可以显示新的组件。
服务提供一些公共服务,由服务方组件负责实现,通过Protocol
实现。消息负责统一发送消息,类似于通知也需要注册。
Bundle App
Bundle App(图片来自淘宝技术分享)淘宝提出Bundle App
的概念,可以通过已有组件,进行简单配置后就可以组成一个新的app
出来。解决了多个应用业务复用的问题,防止重复开发同一业务或功能。
Bundle
即App
,容器即OS
,所有Bundle App
被集成到OS
上,使每个组件的开发就像app
开发一样简单。这样就做到了从巨型app
回归普通app
的轻盈,使大型项目的开发问题彻底得到了解决。
总结
留个小思考
到目前为止组件化架构文章就写完了,文章确实挺长的,看到这里真是辛苦你了😁。下面留个小思考,把下面字符串复制到微信输入框随便发给一个好友,然后点击下面链接大概也能猜到微信的组件化方案。
weixin://dl/profile
总结
各位可以来我博客评论区讨论,可以讨论文中提到的技术细节,也可以讨论自己公司架构所遇到的问题,或自己独到的见解等等。无论是不是架构师或新入行的iOS开发,欢迎各位以一个讨论技术的心态来讨论。在评论区你的问题可以被其他人看到,这样可能会给其他人带来一些启发。
现在H5
技术比较火,好多应用都用H5
来完成一些页面的开发,H5
的跨平台和实时更新等是非常大的优点,但其性能和交互也是缺点。如果以后客户端能够发展到可以动态部署线上代码,不用打包上线应用市场,直接就可以做到原生应用更新,这样就可以解决原生应用最大的痛点。这段时间公司项目比较忙,有时间我打算研究一下这个技术点😄。
Demo
地址:蘑菇街和casatwy
组件化方案,其Github
上都给出了Demo
,这里就贴出其Github
地址了。
蘑菇街-MGJRouter
casatwy-CTMediator
好多朋友在看完这篇文章后,都问有没有Demo
。其实架构是思想上的东西,重点还是理解架构思想。文章中对思想的概述已经很全面了,用多个项目的例子来描述组件化架构。就算提供了Demo
,也没法把Demo
套在其他工程上用,因为并不一定适合所在的工程。
后来想了一下,我把组件化架构的集成方式,简单写了个Demo
,这样可以解决很多人在架构集成上的问题。我把Demo
放在我Github上了,用Coding的服务器来模拟我公司私有服务器,直接拿MGJRouter
来当Demo
工程中的Router
。下面是Demo
地址,麻烦各位记得点个start😁。
这两天更新了一下文章,并且做了一个PDF
版的《组件化架构漫谈》,放在我Github
上了。PDF
上有文章目录,方便阅读,下面是地址。
如果你觉得不错,请把PDF帮忙转到其他群里,或者你的朋友,让更多的人了解组件化架构,衷心感谢!😁
组件化架构PDFGithub地址 : https://github.com/DeveloperErenLiu/ComponentArchitectureBook
网友评论
FOUNDATION_EXPORT NSString * const KLLoginSuccessNotification;我在别的业务模块怎么才能拿到这个通知,谢谢
s.resource_bundles = {
'TZFileDownloader' => ['TZFileDownloaderTool/OtherResource/*'] #xcdatamodel放在OtherResource文件夹中
}
来将coredata的xcdatamodel资源文件加入项目中.
在开发过程中没有问题,直到我们产品发布,上传appstore抱如下错误:
ERROR ITMS-90171: "Invalid Bundle Structure - The binary file 'xxxxx.app/Frameworks/TZFileDownloaderTool.framework/OtherRes.bundle/TZFileDownloaderTool +CoreDataModel.o' is not permitted. Your app can’t contain standalone executables or libraries, other than a valid CFBundleExecutable of supported bundles. Refer to the Bundle Programming Guide at https://developer.apple.com/go/?id=bundle-structure for information on the iOS app bundle structure."
然后就悲剧了,组件里面使用coredata会抱着个错误.
最后没办法,只能临时将coredata资源文件放到主工程中,这样下来的话,模块化方案就没办法继续进行下去了.
请兄弟指教一下,是不是组件内使用coredata的姿势不对?还是方案不对呢?
一些项目里公共的定义,要放在统一的地方定义,比如说获取screen的width等。
我想问一下,工程的图片、声音、本地化的字符串等资源文件,是按照业务划分到各个组件之内,还是所有资源整合成单独的组件?如果是整合到一个组件内,业务A只用了两张图,集成整个组件显得冗余,查找起来也不方便。如果分散到各个业务组件又不能统一管理。想了解一下你的看法。
以图片为例,如果A模块需要用到一张图片,B模块里恰巧有,这时候直接用就可以,从资源组件就可以找到这张图片。
如果划分到各自的组件里的话,在实际开发中经常是哪里用到就拖到哪个项目里,很容易出现重复资源。
我在主工程中pod ModulaA,假如ModulaA中的.pch文件通过s.prefix_header_file 导入了。
那么我在主工程中能够使用ModulaA的pch吗?
这两天更新了一下文章,并且做了一个PDF版的《组件化架构漫谈》,放在我Github上了。PDF上有文章目录,方便阅读。
如果你觉得不错,请把PDF帮忙转到其他群里,或者你的朋友,让更多的人了解组件化架构,衷心感谢!😁
我的理解是,每个单独的组件A工程里,都包含了必要的 依赖组件,这样才可以做单独测试,缺了必要的组件,组件A就编译不起来,不知道我的理解对不对。
本来的我的想法是每个单独的组件不需要依赖任何组件就可以编译运行,虽然结果功能可能缺失(通过perform,或者IMP)。但是这样好像没有什么意义。
所以我对文章中所说的组件的理解是:每个组件都在中间件注册了可以提供的服务,由需求方向中间件发起调用。那么在单个组件的测试中,需要把相应依赖的组件一起包含进来,也就是每个单独的组件工程,其实都包含了其依赖的组件。
protocol这个还么看懂
(1)其他组件怎么访问这个组件?
(2)其他组件中怎么获取到图片?
(3)在storyboard或xib中,怎么直接显示图片组件中的图片?
比如在主工程中,需要加载资源组件中的my.png图片,要怎么调用?
(1)博主如果能针对蘑菇街和CASA的方案还有淘宝和滴滴的多说一些自己的看法就更好了,在我看来MGJ的方案在设计上是存在缺陷的,并没有能解决一类问题。
(2)博主提到Protocol的缺点是实现麻烦,影响开发效率。凡事皆有利弊,确实是个仁者见仁智者见智的问题,但我个人还是更倾向于Protocol,相对于Block代码结构清晰,调试维护起来相对于方便很多,这点我觉得CASA分析的很对。
羡慕可以接触到那么多沙龙、分享~
就是你在“聊天内容”中点开这个URL,他会跳转到“个人信息”那个页面,然后点击“左上角”的返回,是直接回到“我”这个界面,而不是回到“聊天内容”这里,我一直希望可以实现这样的效果,但是一直想不明白要怎么实现,感觉仅仅使用路由跳转不能这样的效果吧?
希望作者能给一些提示或者指引
也了解到一些模块拆分用cocoapods管理很好,但是关于路由跳转,一直不是很了解他的用意。
如果可以,麻烦作者可以解释一下,谢谢
UIViewController *vc = [UIViewController alloc] init];
vc.modal = self.modal;
[self.navigationController push:vc ];