iOS第三方平台集成组件化续集（以插件化的方式添加自定义的第三方
2017-12-09 本文已影响5人
aron1992
背景
不久前写了一篇 iOS第三方平台集成组件化 ，刚好最近公司又在做项目的壳版本，所以考虑把项目中的一些模块做成组件化，这么做的好处是基础的技术组件和基础的业务数据提供组件可以在多个壳版本中共用，不同的项目中进行相关的配置即可，以达到减少工作量和提高效率的目的，此外对于项目的以后的维护也是有帮助的，如果出问题了，只需要修改某一部分的组件即可而不需要修改到其他地方。
在整个项目重构的过程中，发现很多的模块耦合的很厉害，包括我上次做的 iOS第三方平台集成组件化 ，所以特别地我又把这部分做了一个调整，以便于更好的解耦和复用。因为改动的地方比较多，所以新写一篇文章来记录和分享。
结果
在旧的组件库的基础上实现了
- 库项目和业务解耦
- 可配置化
- 独立的私有的Pod组件
- 系统库依赖零配置
- 更简洁的代码和目录结构
- 子模块化第三方平台的业务逻辑
- 以插件化的方式添加自定义的第三方平台
我是代码，欢迎点我👉👉YTThirdPlatformManager
第三方平台注册的例程
注册不同平台的APPID、APPKEY、APPSecret等信息
// 第三方平台注册
[[PTThirdPlatformManager sharedInstance] setPlaform:PTThirdPlatformTypeWechat appID:kWXAppID appKey:nil appSecret:kWXAppSecret redirectURL:nil];
[[PTThirdPlatformManager sharedInstance] setPlaform:PTThirdPlatformTypeTencentQQ appID:kTencentAppID appKey:kTencentAppKey appSecret:kTencentAppSecret redirectURL:nil];
[[PTThirdPlatformManager sharedInstance] setPlaform:PTThirdPlatformTypeWeibo appID:kWeiboAppID appKey:kWeiboAppKey appSecret:kWeiboAppSecret redirectURL:kWeiboRedirectURI];
[[PTThirdPlatformManager sharedInstance] setPlaform:PTThirdPlatformTypeAlipay appID:nil appKey:nil appSecret:nil redirectURL:nil];
[[PTThirdPlatformManager sharedInstance] thirdPlatConfigWithApplication:application didFinishLaunchingWithOptions:launchOptions];
第三方平台调用的例程
这部分和之前的一样
[self addActionWithName:@"QQ Login" callback:^{
[[PTThirdPlatformManager sharedInstance] signInWithType:PTThirdPlatformTypeTencentQQ fromViewController:weakSelf callback:^(ThirdPlatformUserInfo *userInfo, NSError *err) {
}];
}];
[self addActionWithName:@"Wechat Login" callback:^{
[[PTThirdPlatformManager sharedInstance] signInWithType:PTThirdPlatformTypeWechat fromViewController:weakSelf callback:^(ThirdPlatformUserInfo *userInfo, NSError *err) {
}];
}];
思路和实现
库项目和业务解耦
旧的组件在配置方面和业务是没有解耦的，第三方平台的配置是通过 PTThirdPlatformConfigConst 硬编码实现各自平台的配置的，所以参考了友盟分享组件的方式，添加了配置接口，传递第三方平台的配置信息到对应的第三方组件，另外提供了公有的获取接口提供外部使用，这样来达到配置的解耦。PTThirdPlatformManager �这个管理配置的类相当于一个中间者，或者说是一个代理。
结构图
结构图
接口部分
@protocol PTThirdPlatformConfigurable <NSObject>
/**
* 设置平台的appkey
*
* @param platformType 平台类型 @see PTThirdPlatformType
* @param appKey 第三方平台的appKey
* @param appID 第三方平台的appID
* @param appSecret 第三方平台的appSecret
* @param redirectURL redirectURL
*/
- (BOOL)setPlaform:(PTThirdPlatformType)platformType
appID:(NSString *)appID
appKey:(NSString *)appKey
appSecret:(NSString *)appSecret
redirectURL:(NSString *)redirectURL;
- (NSString*)appIDWithPlaform:(PTThirdPlatformType)platformType;
- (NSString*)appKeyWithPlaform:(PTThirdPlatformType)platformType;
- (NSString*)appSecretWithPlaform:(PTThirdPlatformType)platformType;
- (NSString*)appRedirectURLWithPlaform:(PTThirdPlatformType)platformType;
实现部分
这部分的代码还是放在 PTThirdPlatformManager 这个类中，实现起来很简单，只是把不同平台的配置信息保存在一个字典中。
#pragma mark - ......::::::: PTThirdPlatformConfigurable Override :::::::......
- (BOOL)setPlaform:(PTThirdPlatformType)platformType
appID:(NSString *)appID
appKey:(NSString *)appKey
appSecret:(NSString *)appSecret
redirectURL:(NSString *)redirectURL {
[self.thirdPlatformKeysConfig
setObject:@(platformType)
forKey:@{@(PTThirdPlatformAppID): ValueOrEmpty(appID),
@(PTThirdPlatformAppKey): ValueOrEmpty(appKey),
@(PTThirdPlatformAppSecret): ValueOrEmpty(appSecret),
@(PTThirdPlatformRedirectURI): ValueOrEmpty(redirectURL)}];
return YES;
}
- (NSString*)appIDWithPlaform:(PTThirdPlatformType)platformType {
return [[self.thirdPlatformKeysConfig objectForKey:@(platformType)] objectForKey:@(PTThirdPlatformAppID)];
}
- (NSString*)appKeyWithPlaform:(PTThirdPlatformType)platformType {
return [[self.thirdPlatformKeysConfig objectForKey:@(platformType)] objectForKey:@(PTThirdPlatformAppKey)];
}
- (NSString*)appSecretWithPlaform:(PTThirdPlatformType)platformType {
return [[self.thirdPlatformKeysConfig objectForKey:@(platformType)] objectForKey:@(PTThirdPlatformAppSecret)];
}
- (NSString*)appRedirectURLWithPlaform:(PTThirdPlatformType)platformType {
return [[self.thirdPlatformKeysConfig objectForKey:@(platformType)] objectForKey:@(PTThirdPlatformRedirectURI)];
}
具体的，不同平台配置APPID或者APPKey的地方是不统一
微博平台在 PTWeiboManager 中的配置：
- (void)thirdPlatConfigWithApplication:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 子类实现
// 初始化微博模块
#if DEBUG
[WeiboSDK enableDebugMode:YES];
DBLog(@"WeiboSDK getSDKVersion = %@", [WeiboSDK getSDKVersion]);
#endif
NSString* appKey = [[PTThirdPlatformManager sharedInstance] appKeyWithPlaform:PTThirdPlatformTypeWeibo];
[WeiboSDK registerApp:appKey];
}
腾讯QQ平台在 PTTencentRespManager 中的配置：
- (instancetype)init
{
self = [super init];
if (self) {
NSString* appID = [[PTThirdPlatformManager sharedInstance] appIDWithPlaform:PTThirdPlatformTypeTencentQQ];
_tencentOAuth = [[TencentOAuth alloc] initWithAppId:appID andDelegate:self];
}
return self;
}
- (TencentOAuth *)tencentOAuth {
if (!_tencentOAuth) {
NSString* appID = [[PTThirdPlatformManager sharedInstance] appIDWithPlaform:PTThirdPlatformTypeTencentQQ];
_tencentOAuth = [[TencentOAuth alloc] initWithAppId:appID andDelegate:self];
}
return _tencentOAuth;
}
代码和目录结构
代码的简化
支付类型和登录类型合并为同一种类型，这两种类型在一个平台中只有一种方式，所以不用区分，以保持代码的简单
// 登录类型
typedef NS_ENUM(NSInteger, PTThirdPlatformType) {
PTThirdPlatformTypeWechat = 1,//微信
PTThirdPlatformTypeTencentQQ,//QQ
PTThirdPlatformTypeWeibo,//微博
};
// 支付类型
typedef NS_ENUM(NSUInteger, PTPaymentMethodType) {
PaymentMethodTypeWechat = 1,
PaymentMethodTypeAlipay = 2,
PaymentMethodTypeApple = 3,
};
修改为：
// 第三方平台类型
typedef NS_ENUM(NSInteger, PTThirdPlatformType) {
PTThirdPlatformTypeWechat = 1,//微信
PTThirdPlatformTypeTencentQQ,//QQ
PTThirdPlatformTypeWeibo,//微博
PTThirdPlatformTypeAlipay,//支付宝
};
对应的使用到的地方也要做相应的调整，这里就不再赘述了。
目录结构的调整：
目录结构的调整
左边是调整过后的目录结果，右边是调整之前的，主要是把类和接口进行了分离存放在对应的目录，此外吧 PTOrderModel 这个模型类也保存在了PTThirdPlatformObject类中
POD库
Pod私有库的创建有很多细节的东西，这里不会做详细的说明，只说明大概的做法和使用方法。
1、私有库的创建
➜ DevPods pod lib create PTThirdPlatformKit
Cloning `https://github.com/CocoaPods/pod-template.git` into `PTDataModule`.
Configuring PTDataModule template.
------------------------------
To get you started we need to ask a few questions, this should only take a minute.
If this is your first time we recommend running through with the guide:
- http://guides.cocoapods.org/making/using-pod-lib-create.html
( hold cmd and double click links to open in a browser. )
What language do you want to use?? [ Swift / ObjC ]
> Objc
Would you like to include a demo application with your library? [ Yes / No ]
>
yes
Which testing frameworks will you use? [ Specta / Kiwi / None ]
> None
Would you like to do view based testing? [ Yes / No ]
> No
What is your class prefix?
> PT
Running pod install on your new library.
创建库的过程需要填写相应的信息，按照提示即可创建一个是有的Pod库了。
2、私有POD库的使用
Podfile文件中添加POD引用，因为我这里使用的是Pod的Example工程，所以指向的Pod库路径是上一层目录，其他的项目中使用的方式会有差别，这里需要注意下。
pod 'PTThirdPlatformKit', :path => '../'
POD库配置系统库的依赖
使用POD库有个特性是可以配置依赖到的frameworks、libraries 和 compiler_flags ,在 podspec 文件中添加如下的配置，在 pod install 安装了pod库之后会配置好对应的依赖，而不用手动一个个的添加
# 配置系统Framework
s.frameworks = 'CoreMotion'
# 添加依赖的系统静态库
s.libraries = 'xml2', 'z', 'c++', 'stdc++.6', 'sqlite3'
子模块化第三方平台
pod 支持配置子模块，一般的把共用的代码放在Core模块中，把一系列相似的模块代码放在独立的子模块中单独管理，使用的时候可以通过配置podfile按需导入不同的平台。这样一方面模块化更清晰，另一方面不会导入多余的代码，导致包体积变大。
下面的配置文件配置了一个保存基础公有代码的 Core 子模块和四个不同平台的子模块，子模块中管理各自的源文件、依赖库、资源等信息，并且不同的子模块都不 Core 模块当做基础依赖。
s.default_subspec = 'Core'
s.subspec 'Core' do |subspec|
# 源代码
subspec.source_files = 'PTThirdPlatformKit/Classes/**/*'
# 配置系统Framework
subspec.frameworks = 'CoreMotion'
subspec.dependency 'SDWebImage'
# 添加依赖的系统静态库
subspec.libraries = 'xml2', 'z', 'c++', 'stdc++.6', 'sqlite3'
end
s.subspec 'AlipayManager' do |subspec|
# 源代码
subspec.source_files = 'PTThirdPlatformKit/AlipayManager/**/*'
# 添加资源文件
subspec.resource = 'PTThirdPlatformKit/AlipayManager/**/*.bundle'
# 添加依赖的framework
subspec.vendored_frameworks = 'PTThirdPlatformKit/AlipayManager/**/*.framework'
subspec.frameworks = 'CoreTelephony', 'SystemConfiguration'
subspec.dependency 'PTThirdPlatformKit/Core'
end
s.subspec 'TencentManager' do |subspec|
# 源代码
subspec.source_files = 'PTThirdPlatformKit/TencentManager/**/*'
# 添加资源文件
subspec.resource = 'PTThirdPlatformKit/TencentManager/**/*.bundle'
# 添加依赖的framework
subspec.vendored_frameworks = 'PTThirdPlatformKit/TencentManager/**/*.framework'
subspec.frameworks = 'SystemConfiguration'
subspec.dependency 'PTThirdPlatformKit/Core'
end
s.subspec 'WeiboManager' do |subspec|
# 源代码
subspec.source_files = 'PTThirdPlatformKit/WeiboManager/**/*'
subspec.dependency 'WeiboSDK'
subspec.dependency 'PTThirdPlatformKit/Core'
end
s.subspec 'WXManager' do |subspec|
# 源代码
subspec.source_files = 'PTThirdPlatformKit/WXManager/**/*'
subspec.dependency 'WechatOpenSDK'
subspec.dependency 'PTThirdPlatformKit/Core'
end
podfile中配置需要导入的子模块，可以按需导入一个或者多个子模块
pod 'PTThirdPlatformKit', :path => '../'
pod 'PTThirdPlatformKit/AlipayManager', :path => '../'
pod 'PTThirdPlatformKit/TencentManager', :path => '../'
pod 'PTThirdPlatformKit/WeiboManager', :path => '../'
pod 'PTThirdPlatformKit/WXManager', :path => '../'
插件化添加第三方平台
插件化的主要思路就是在原有功能和框架的基础上，提供一个扩展点，方便用户的扩展，用户可以实现框架中的接口或者父类实现自定义的功能扩展。
以当前项目为例，添加了两个扩展点：第三方平台登录或者支付的扩展点以及第三方分享的扩展点：
#pragma mark 插件接入点
/**
插件接入点-添加登录或者是支付的管理类
@param platformType 自定义的第三方平台类型，大于999
@param managerClass 实现了PTAbsThirdPlatformManager接口的自定义第三方平台管理类
*/
- (void)addCustomPlatform:(NSInteger)platformType managerClass:(Class)managerClass {
NSString* classString = NSStringFromClass(managerClass);
if (classString) {
[self.thirdPlatformManagerConfig setObject:NSStringFromClass(managerClass) forKey:@(platformType)];
[self.thirdPlatformManagerClasses addObject:classString];
}
}
/**
插件接入点-添加分享的管理类
@param sharePlatformType 自定义的第三方平台分享类型，大于999
@param managerClass 实现了PTAbsThirdPlatformManager接口的自定义第三方平台管理类
*/
- (void)addCustomSharePlatform:(NSInteger)sharePlatformType managerClass:(Class)managerClass {
NSString* classString = NSStringFromClass(managerClass);
if (classString) {
[self.thirdPlatformShareManagerConfig setObject:classString forKey:@(sharePlatformType)];
[self.thirdPlatformManagerClasses addObject:classString];
}
}
因为项目已经对模块进行了抽象化，每个模块都是抽象的具体事项，互不影响。高层的管理类依赖的是抽象的接口，而不直接依赖具体的实现，低层的具体模块依赖于模块的抽象接口，这就是所谓的** 依赖倒置 **。所以新增一个模块不过是添加一个新的配置而已，对已有的框架不会有任何的影响，添加新的模块更新已有的配置就能达到目的。
还有待改进
先到此结束，后面有改进再更新，有问题或者建议意见的欢迎评论我
