一个iOS模块化开发解决方案

时间  2019-11-12
标签 一个 ios 模块化 开发 解决 方案 栏目 iOS 繁體版
原文   原文链接

jiaModuleDemo项目是为了解决关于项目中如何进行模块化开发而编写的实例，包含如何进行路由式、本地模块间交互的实现；目前仍是在页面层级进行抽离，对于项目中各个模块共有的基础功能也进行提取，能够结合私有Pods进行管理；java

项目中存在的问题ios

  • 问题一：页面耦合严重git

18.png

上面这张图中左边体现了目前项目中存在的问题，对于页面之间相互耦合，而页面之间的传参也各不相同，因为不一样的开发人员或者简便方式等缘由，传参的类型都有差别，包含如实体、简单基本类型等，先前项目对于路由方式也不支持，致使要实现收到消息推送进行不一样的页面跳转存在硬编码状况，对于功能扩展存在至关大的问题；而右边则是模块化后页面之间的交互方式；页面之间也不存在耦合关系，都只跟JiaMediator这个中介者相依赖；而传参都统一成以字典的形式；虽然可能牺牲一些方便跟随意，却能够解耦模块化；而且加入对路由方式的处理；约定好相关的协议进行交互；用这种路由方式代替那些第三方的路由插件则是由于它的灵活性，最主要仍是省去了第三方路由插件在启动时要注册路由的问题；github

  • 问题二：相同模块重复开发web

19.png

当公司里面有多个项目同时进行，而且有多是多我的分别不一样项目时，就会存在如上图出现的状况，其实每一个APP中都是有不少共同的模块，固然有可能你会把相同功能模块代码复制一份在新项目中，但这其实并非最好的方式，在后期不断迭代过程当中，不一样的人会往里面增长不少带有我的色彩的代码；这样就像相同的模块项目后期对于多个项目统一管理也是灾难性，有可能会失控，哪怕项目转移别人接手也会无形中浪费不少时间，增长维护成本，因此实例中更注重对于一些相同模块进行提取，求同存异；而模块化结合私有Pods进行管理，对于经常使用功能的封装，只要开放出一些简单开关配置方式，就能够实现一个功能，好比日志记录、网络请求模块、网络状态变化提示等；数组

模块化解决方案安全

页面交互解耦微信

20.png

实现调用代码：网络

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
NSDictionary *curParams=@{kDesignerModuleActionsDictionaryKeyName:@ "wujunyang" ,kDesignerModuleActionsDictionaryKeyID:@ "1001" ,kDesignerModuleActionsDictionaryKeyImage:@ "designerImage" };
     switch  (indexPath.row) {
         case  0:
         {
             UIViewController *viewController=[[JiaMediator sharedInstance]JiaMediator_Designer_viewControllerForDetail:curParams];
             [self presentViewController:viewController animated:YES completion:nil];
             break ;
         }
         case  1:
         {
             UIViewController *viewController=[[JiaMediator sharedInstance]JiaMediator_Designer_viewControllerForDetail:curParams];
             [self.navigationController pushViewController:viewController animated:YES];
             break ;
         }
         case  2:
         {
             NSString *curRoue=@ "jiaScheme://Designer/nativeFetchDetailViewController?name=wujunyang&ID=1001&image=designerImage" ;
             UIViewController *viewController=[[JiaMediator sharedInstance]performActionWithUrl:[NSURL URLWithString:curRoue] completion:^(NSDictionary *info) {
             }];
             [self.navigationController pushViewController:viewController animated:YES];
             break ;
         }
         default :
             break ;
     }


上面针对本地模块调用及路由方式调用的跳转app

1：JiaMediator起到一个中介的做用，全部的模块间响应交互都是经过它进行，每一个模块都会对它进行扩展分类（例如：JiaMediator+模块A），分类主要是为了用于本地间调用而又不想用路由的方式，若要用路由的方式则要注意关于路由约束准确编写，它将会直接影响到可否正确响应到目标；

3 (1).png

2：JiaMediator是每一个模块都要用到的内容，能够把它放在公共的模块中，由于关于各个模块的JiaMediator由每一个模块自个负责，开放给要调用的模块使用；

3：为了解耦对于页面间的传参都采用字典形式，项目中全部的页面都继承于一个基页面jiaBaseViewController，里面已经有对初始化对于字典参数的接收并赋值，每一个模块的子页面只要调用parameterDictionary属性，就能够获取关于参数的内容；一样jiaBaseViewController也是每一个模块都要使用，因此也被提取在公共里面，其还包括一些导栏条的封装及关于网络状态变化的提示等；

1
2
3
4
5
6
7
8
9
10
11
12
13
//页面接收参数
@property(nonatomic,strong)NSDictionary *parameterDictionary;
//初始化参数
- (id)initWithRouterParams:(NSDictionary *)params;
 
- (id)initWithRouterParams:(NSDictionary *)params {
     self = [ super  init];
     if  (self) {
         _parameterDictionary=params;
         NSLog(@ "当前参数：%@" ,params);
     }
     return  self;
}

21.png

4：当响应某一个模块目标后，将会把相应的viewController进行返回，而对于具体如何操做则是在得到当前控制器自行处理，好比是跳转仍是弹出展示；

5：为了减小对于字典参数key拼写错误问题，每一个模块都有一个对应key值的常量配置文件，已经把对应的key值都定义成的常量，方便调用；

1
2
3
4
5
6
7
8
9
10
#ifndef HeaderDesignerConfig_h
#define HeaderDesignerConfig_h
 
//键值
static NSString * const kDesignerModuleActionsDictionaryKeyName=@ "name" ;
static NSString * const kDesignerModuleActionsDictionaryKeyID=@ "ID" ;
static NSString * const kDesignerModuleActionsDictionaryKeyImage=@ "image" ;
 
#endif /* HeaderDesignerConfig_h */
  NSDictionary *curParams=@{kDesignerModuleActionsDictionaryKeyName:@ "wujunyang" ,kDesignerModuleActionsDictionaryKeyID:@"1

JiaCore(基础功能封装)

JiaCore是整个APP最基础模块，全部的模块化都要依赖，主要包含一些全局的功能模块，好比JiaBaseViewController、JiaAppDelegate等；目前已经把一些默认的功能进行集成在里面，包含网络状态变化判断及提示、日志记录功能等；并把一些相关配置的内容用JiaCoreConfigManager这个管理类进行统一设置，好比是否打开日志记录功能；JiaCoreConfigManager类则是开放给具体APP设置全局的相关配置；下面就以其中一个日志记录功能进行讲解:

1
2
3
//JiaCore基础模块相关配置
JiaCoreConfigManager *jiaCoreConfig=[JiaCoreConfigManager sharedInstance];
jiaCoreConfig.recordlogger=YES;

而后具体APP的PrefixHeader.pch引入命名空间并进行设置记录日志的等级：

1
2
3
4
#import "JiaCocoaLumberjack.h"
 
//DDLog等级
static const int ddLogLevel = DDLogLevelVerbose;

这样就完成的一个APP对于日志记录模块的引入，JiaCore已经帮你完成的关于日志记录的相关配置，而且错误内容以一种可读性较好的格式记录到file文件中，并且这些file文件生成规则也都定义好了，固然如什么时候你要是在Xcode控制台显示不一样等级色彩，只要安装XcodeColors插件并简单进行设置就能够了，对于不一样等级不一样色彩都已经在JiaCore配置完成；

在JiaCore里面也默认集成了热更新的功能，只要传入简单的对象数组就会启动热更新；其中JiaPathchModel已是定义好的模型，在APP中把接口请求转化成模型数组，其中patchId是惟一值名称、md5则是JS文件的MD5值、url是JS的下载路径、ver则是对哪一个版本起做用；由于通常咱们在外面的APP都是多版本共存，热更新也要进行版本区分，只下载与本版本相对应的热更新JS文件加载；而MD5值则是为了增长安全性，避免JS文件被别人进行修改而影响APP的运行，在JiaCore会对下载后的JS文件进行MD5计算并比较；对于没有在jSPatchMutableArray之前的JS文件会被删除；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
//热更新内容
JiaPathchModel *sample=[[JiaPathchModel alloc]init];
sample.patchId = @ "patchId_sample1" ;
sample.md5 = @ "2cf1c6f6c5632dc21224bf42c698706b" ;
sample.url = @ "http://test.qshmall.net:9090/demo1.js" ;
sample.ver = @ "1" ;
 
JiaPathchModel *sample1=[[JiaPathchModel alloc]init];
sample1.patchId = @ "patchId_sample2" ;
sample1.md5 = @ "e8a4eaeadce5a4598fb9a868e09c75fd" ;
sample1.url = @ "http://test.qshmall.net:9090/demo2.js" ;
sample1.ver = @ "1" ;
 
//JiaCore基础模块相关配置
JiaCoreConfigManager *jiaCoreConfig=[JiaCoreConfigManager sharedInstance];
jiaCoreConfig.jSPatchMutableArray=[@[sample,sample1] mutableCopy];

JiaNetWork(网络交互封装)

对于网络请求模块则采用YTKNetwork，底层仍是以AFNetworking进行网络通讯交互，定义一个继承于YTKBaseRequest的JiaBaseRequest，针对JiaBaseRequest则是为了后期各个APP能够对它进行分类扩展，对于一些超时、请求头部等进行统一个性化设置，毕竟这些是每一个APP都不相同；而针对模块中关于请求网络的前缀设置，则在每一个模块中都有一个单例的配置类，此配置类是为了针对该模块对不一样APP变化而定义；相应的配置内容开放给APP，由具体APP来定义，例如如今项目中的JiaBaseRequest+App.h类，里面有简单设置超时跟头部；固然记得把这个分类引入到APP中，好比AppPrefixHeader这个APP的全局头部；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#import "JiaBaseRequest+App.h"
 
@implementation JiaBaseRequest (App)
 
- (NSTimeInterval)requestTimeoutInterval {
     return  15;
}
 
//公共头部设置
- (NSDictionary *)requestHeaderFieldValueDictionary
{
     NSDictionary *headerDictionary=@{@ "platform" :@ "ios" };
     return  headerDictionary;
}
 
@end

网络层总体实现以下：

22.png

JiaGT模块(个推封装)

消息推送对于一个APP是至关重要性，通常是采用第三方的SDK进行集成，其实大部分的SDK处理代码都是差很少，在这实例中对差别化的内容进行提取，实例中将以个推动行模块化，由于消息推送的大部分代码都集中在AppDelegate中，形成的一大堆杂乱代码，固然也有一部分人对AppDelegate进行扩展分类进行移除代码，实例中将采用另一种解决方案进行抽取，能够达到彻底解耦，在具体的APP里面将不会再出现个推SDK相关内容，只要简单进行配置跟处理消息就能够，下面只是简单的列出部分代码，其它封装代码见源代码；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
//设置个推模块的配置
jiaGTConfigManager *gtConfig=[jiaGTConfigManager sharedInstance];
gtConfig.jiaGTAppId=@ "0uuwznWonIANoK07JeRWgAs" ;
gtConfig.jiaGTAppKey=@ "26LeO4stbrA7TeyMUJdXlx3" ;
gtConfig.jiaGTAppSecret=@ "2282vl0IwZd9KL3ZpDyoUL7" ;
 
#pragma mark 消息推送相关处理
 
/**
  *  @author wujunyang, 16-07-07 16:07:25
  *
  *  @brief  处理个推消息
  *
  *  @param NotificationMessage
  */
-(void)gtNotification:(NSDictionary *)NotificationMessage
{
     NSLog(@ "%@" ,NotificationMessage[@ "payload" ]);
     NSLog(@ "－－－－－接收到个推通知------" );
}
 
/**
  *  @author wujunyang, 16-07-07 16:07:40
  *
  *  @brief  处理远程苹果通知
  *
  *  @param RemoteNotificationMessage
  */
-(void)receiveRemoteNotification:(NSDictionary *)RemoteNotificationMessage
{
     NSLog(@ "%@" ,RemoteNotificationMessage[@ "message" ]);
     NSLog(@ "－－－－－接收到苹果通知------" );
}
 
/**
  *  @author wujunyang, 16-09-21 14:09:33
  *
  *  @brief 得到注册成功时的deviceToken 能够在里面作一些绑定操做
  *
  *  @param deviceToken 
  */
-(void)receiveDeviceToken:(NSString *)deviceToken
{
     NSLog(@ "－－－－－当前deviceToken：%@------" ,deviceToken);
}

23.png

上面可以对个推动行彻底的解耦不得不提一个第三方的插件XAspect，若是想对它进行了解能够在github进行查找；它的主要做用以下图，能够用它进行其它第三方SDK的抽离

24.png

JiaAnalytics模块(友盟统计封装)

JiaAnalytics模块是在友盟统计SDK跟Aspect相结合基础上完成，对于页面的进出统计采用Aop切面方式进行，把本来应该在每一个页面生命周期的统计代码移除，App运用只要简单配置友盟相对应的信息，也能够设置要统计页面的过滤条件，目前已经有三种如要统计的开头页面的前缀字符串数组、要统计的页面名称字符串数组、不统计的页面名称字符串数组；能够结合使用，达到精确统计页面的目的；并且把统计的代码放在异步线程进行，不会影响主线程的响应；

25.jpg

26.png

JiaShare模块(友盟分享及第三方登陆封装)

JiaShare模块运用友盟分享最新版的SDK进行封装，并把一些其它不是很经常使用的去除，目前只支持新浪、微信聊天、微信朋友圈、QQ聊天页面、qq空间、腾讯微博；分享包括纯文本、图文、URL、视频地址、音乐地址，并在里面已经运用JavaScriptCore.framework封装好关于H5页面调用分享并传参的功能；能够直接在UIWebView里面进行调用；本模块只是对功能进行封装，对于友盟在info.plist的配置仍是要自行手动，如不明白能够直接到友盟分享官网查看，项目到也有配置好一份能够直接参考；JiaPlatformHelper类里面有一个判断当前手机是否有安装相应平台软件的方法，能够用它进行隐藏相应的操做功能，避免上架时审核不过；下面的代码是在项目的AppDelegate里面进行配置.

1
2
3
4
5
6
7
8
//友盟分享
JiaShareConfigManager *jiaShareConfig=[JiaShareConfigManager sharedInstance];
jiaShareConfig.shareAppKey=@ "57e3f1cbe0f55a42080011ec" ;
jiaShareConfig.shareLogEnabled=YES;
//设置平台
[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Tencent appKey:@ "100424468"  appSecret:@ "c7394704798a158208a74ab60104f0ba"  redirectURL:@ "http://www.umeng.com/social" ];
[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Wechat appKey:@ "wxdc1e388c3822c80b"  appSecret:@ "3baf1193c85774b3fd9d18447d76cab0"  redirectURL:@ "http://www.umeng.com/social" ];
[jiaShareConfig setPlaform:JiaSocialPlatConfigType_Sina appKey:@ "3921700954"  appSecret:@ "04b48b094faeb16683c32669824ebdad"  redirectURL:@ "http://sns.whalecloud.com/sina2/callback" ];

而后就能够进行分享，在ViewController里面进行调用，JiaSocialPlatformType是分享平台的枚举，shareUrlDataWithPlatform为URL分享方式，其它能够直接见源代码JiaShareHelper类

1
2
3
4
5
6
     [JiaShareHelper shareUrlDataWithPlatform:JiaSocialPlatformType_WechatSession withShareUrl:@ "http://www.sina.com.cn"  withTitle:@ "新浪"  withDescr:@ "新浪网页"  withThumImage:@ "http://dev.umeng.com/images/tab2_1.png"  withCompletion:^(id result, NSError *error) {
         if (error)
         {
             NSLog(@ "分享出错了" );
         }
     }];

若是有加载H5页面，并且也要进行分享的功能就可使用JiaWebShareHelper,由于使用到的是JavaScriptCore，因此只能用在UIWebView中，若是你要是使用WKWebView能够自个再进行封闭，下面是加载H5页面中的webViewDidFinishLoad代码；

1
2
3
4
5
6
7
8
9
10
11
12
13
- (void)webViewDidFinishLoad:(UIWebView *)webView {
     self.jsContext = [webView valueForKeyPath:@ "documentView.webView.mainFrame.javaScriptContext" ];
     // 经过模型调用方法，这种方式更好些。
     JiaWebShareHelper *shareHelper  = [[JiaWebShareHelper alloc] init];
     self.jsContext[@ "jia" ] = shareHelper;
     shareHelper.jsContext = self.jsContext;
     shareHelper.webView = self.webView;
     
     self.jsContext.exceptionHandler = ^(JSContext *context, JSValue *exceptionValue) {
         context.exception = exceptionValue;
         NSLog(@ "异常信息：%@" , exceptionValue);
     };
}

H5中就能够很方便直接进行：

27.png

下面简单介绍关于第三方登陆跟获取用户信息的功能，其功能代码放在JiaPlatformHelper里面，已经对受权成功及获取用户信息都有回去调相应的参数回来：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
if (![JiaPlatformHelper installPlatAppWithType:JiaSocialPlatformType_QQ])
{
     [weakSelf showResult:@ "没有安装QQ软件,将此功能隐藏" ];
     return ;
}
 
[JiaPlatformHelper authWithPlatform:JiaSocialPlatformType_QQ withCompletion:^(NSString *uid, NSString *openid,NSString *accessToken, NSError *error) {
     if  (error) {
         NSLog(@ "出错了" );
         return ;
           }
 
     NSString *result=[NSString stringWithFormat:@ "得到到的值为：uid:%@--token:%@--openid:%@" ,uid,accessToken,openid];
     [weakSelf showResult:result];
}];

获取用户信息的代码以下：

1
2
3
4
5
6
7
8
9
[JiaPlatformHelper getUserInfoWithPlatform:JiaSocialPlatformType_QQ withCompletion:^(NSString *name, NSString *iconUrl, NSString *gender, NSError *error) {
    if  (error) {
       NSLog(@ "出错了" );
       return ;
     }
     
    NSString *result=[NSString stringWithFormat:@ "得到到的值为：name:%@--性别:%@" ,name,gender];
    [weakSelf showResult:result];
}];

关于取消受权也有相应的方法：

1
2
3
4
5
6
7
8
9
[JiaPlatformHelper cancelAuthWithPlatform:JiaSocialPlatformType_QQ withCompletion:^(id result, NSError *error) {
    if  (error) {
       NSLog(@ "出错了" );
       return ;
      }
      
    NSString *ressult=@ "取消成功" ;
    [weakSelf showResult:ressult];
}];

28.png

模块化结合私有Pods方案

上面实例中只是把相关模块化的提取都在一个工程进行体现，最后仍是要落实结合Pods进行管理，把每一个模块分开管理，不一样的APP能够简单经过Pods指令就能够达到引入模块的效果，对于一些相同模块能够在不一样的APP重复引用，减少重复开发成本；

29.png

在本项目中已经引入的Pod来管理目前开发的几个模块，并导入在我目前的Github的一个库里Spec进行统一管理，首先要引入Pod来管理则要增长jiaModule.podspec文件；

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
Pod::Spec. new  do  |s|
 
s.name         =  "jiaModule"
s.version      =  "0.0.6"
s.summary      =  "iOS模块化功能的引用"
 
s.homepage     =  "https://github.com/wujunyang/jiaModuleDemo"
s.license      = { :type =>  "MIT" , :file =>  "FILE_LICENSE"  }
s.author             = {  "wujunyang"  =>  "wujunyang@126.com"  }
 
s.platform     = :ios,  "7.0"
 
s.source       = { :git =>  "https://github.com/wujunyang/jiaModuleDemo.git" , :tag =>  "0.0.6"  }
 
s.requires_arc =  true
 
s.subspec  'JiaCore'  do  |jiaCore|
jiaCore.source_files =  'jiaModuleDemo/BaseModule/JiaCore/**/*.{h,m}'
jiaCore.dependency  'XAspect'
jiaCore.dependency  'YYCache'
jiaCore.dependency  'JSPatch'
jiaCore.dependency  'RealReachability'
jiaCore.dependency  'FLEX' ,  '~> 2.0'
jiaCore.dependency  'CocoaLumberjack' ,  '~> 2.0.0-rc'
jiaCore.dependency  'AFNetworking' ,  '~>2.6.0'
end
 
s.subspec  'JiaGT'  do  |jiaGT|
jiaGT.source_files =  'jiaModuleDemo/BaseModule/JiaGT/**/*'
jiaGT.dependency  'jiaModule/JiaCore'
jiaGT.dependency  'XAspect'
jiaGT.dependency  'GTSDK' ,  '~> 1.5.0'
end
 
s.subspec  'JiaAnalytics'  do  |jiaAnalytics|
jiaAnalytics.source_files =  'jiaModuleDemo/BaseModule/JiaAnalytics/**/*'
jiaAnalytics.dependency  'jiaModule/JiaCore'
jiaAnalytics.dependency  'XAspect'
jiaAnalytics.dependency  'Aspects'
jiaAnalytics.dependency  'UMengAnalytics-NO-IDFA' ,  '~> 4.1.1'
end
 
s.frameworks =  'UIKit'
 
# s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
# s.dependency "JSONKit", "~> 1.4"
end

上面的文件会把不一样的模块进行分离，能够一块儿引入也能够单独引入某一个模块；pod会自动把相应的依赖都引入,下面是所有引入关于jiaModule模块

1
2
3
4
5
source  'https://github.com/CocoaPods/Specs.git'
source  'https://github.com/wujunyang/WjySpecs.git'
platform :ios,  "7.0"
 
pod  'jiaModule'

假如要引入只是其中一个模块：

1
2
3
4
5
6
source  'https://github.com/CocoaPods/Specs.git'
source  'https://github.com/wujunyang/WjySpecs.git'
platform :ios,  "7.0"
 
pod 'jiaModule/JiaCore’
pod 'jiaModule/JiaGT’

下面简单介绍两条关于验证跟提交jiaModule.podspec的指令，都要打开终端进入项目根目录，也就是jiaModule.podspec所在的目录，而后进行执行；

1
2
3
4
5
#验证是否正确（后面还有一个git的私有地址)
pod lib lint jiaModule.podspec --allow-warnings --use-libraries --sources= 
 
#提交到库  (specs就是大家的私有库名，见下面repo add指令时的名字，后面还有一个git的私有地址)
pod repo push specs jiaModule.podspec --allow-warnings --use-libraries --sources=https: //github.com/CocoaPods/Specs.git,https://github.com/wujunyang/WjySpecs.git

注意：若是提交到库时报下面的问题，说明尚未把私有仓库集下载到本地：

1
[!] Unable to find the `specs` repo. If it has not yet been cloned, add it via `pod repo add`.

能够直接执行指令（specs名字能够自行定义，跟上面提交时对应该上就行）：

1
pod repo add specs https: //github.com/wujunyang/WjySpecs.git

会在路径：/Users/自个电脑用户名/.cocoapods/repos（被隐藏，要用指令进行显示出来） 下有一个文件夹specs 另外还有一个是Pod官网的文件夹；

最后还要登陆Git帐号跟密码，就能够成功提交了

1
2
3
4
Username  for  'https://github.com' : wujunyang@126.com
Password  for  'https://wujunyang@126.com@github.com' : 
To https: //github.com/wujunyang/WjySpecs.git
    80ca876..d4f7446  master -> master
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程