
本文以 YBImageBrowser 组件举例。
YBImageBrowser 依赖了 SDWebImage,在使用 CocoaPods 集成到项目中时,可能会出现少量依赖冲突的问题,最近社区提了多个 Issues 并且在 Insights -> Traffic -> Popular content 中看到了此类问题很高的关注度,所以不得不着手处理。
一个开源组件的迭代过程中,保证上层接口的向下兼容就不错了。为了优化性能并且控制内存,YBImageBrowser 没有直接用其最上层的接口,而是单独使用了下载模块和缓存模块,SDWebImage 的迭代更新很容易导致笔者的组件兼容不了,所以之前一直是相似这样依赖的:
s.dependency 'SDWebImage', '~> 5.0.0'这样做的好处是限制足够小版本范围,降低 SDWebImage 接口变动导致组件代码错误的风险。但假如 SDWebImage 更新到 5.1.0,不论相关 API 能否变动,CocoaPods 都视为依赖冲突。
当两个组件依赖了同一个组件的不同版本,并且依赖的版本没有交集,比方:
A.dependency 'SDWebImage', '~> 4.0.0'B.dependency 'SDWebImage', '~> 5.0.0'那么 A 和 B 同时集成进项目会出现依赖冲突。
使用 CocoaPods 集成项目非常便捷,对于组件使用者来说,总是想在任何场景下都能轻易集成,并且能在将来享受组件的升级优化,显然前面提到的问题可能会影响集成的便捷性。
很多时候一个大版本的组件不会改动 API,并且对于社区流行的组件我们可以寄肯定希望于其做好向下兼容,所以放宽依赖的版本限制能覆盖将来更多的版本(规则参考:podspec dependency):
s.dependency 'SDWebImage', '>= 5.0.0'为什么不干脆去掉版本限制呢?
由于 YBImageBrowser 3.x 是基于 SDWebImage 5.0.0 开发的,笔者可以明确不兼容 5.0.0 之前的版本,所以在 SDWebImage 将来迭代版本出现相关 API 不兼容之前,这个限制都是“完美”覆盖所有版本的。
当有其它组件依赖了不同版本的 SDWebImage,粗暴的处理方案如下:
显然,上面的几种方案不太优雅,手动导入项目难以享受组件的升级优化,修改本地 repo 信息会由于 repo 列表的升级而复位。
出现依赖冲突是必需要处理的问题,其它组件依赖的版本限制可以视为不变量,处理方案可以从组件的制作方面考虑。
要做到的目标是,既满足部分客户快速集成组件,又能让部分客户处理依赖冲突的前提下保证能享受组件将来的升级优化。
答案就是subspec,以下是 YBImageBrowser.podspec 部分代码(完整代码):
s.subspec "Core" do |core| core.source_files = "YBImageBrowser/**/*.{h,m}" core.dependency 'SDWebImage', '>= 5.0.0' end s.subspec "NOSD" do |core| core.source_files = "YBImageBrowser/**/*.{h,m}" core.exclude_files = "YBImageBrowser/WebImageMediator/YBIBDefaultWebImageMediator.{h,m}" end由此,客户可以自由的选择能否需要依赖 SDWebImage,在 Podfile 里的观感大致是这样:
// 依赖 SDWebImagepod 'YBImageBrowser' // 不依赖 SDWebImagepod 'YBImageBrowser/NOSD'那么在 YBImageBrowser 代码中应该如何区分能否依赖了 SDWebImage 并且提供默认实现呢?
第一步是设计一个笼统接口(这个接口不依赖 SDWebImage):
@protocol YBIBWebImageMediator <NSObject>// Download methode, caching methode, and so on.@end第二步是在YBImageBrowser.h中定义一个遵循该接口的属性:
/// 图片下载缓存相关的中介者(赋值可自己设置)@property (nonatomic, strong) id<YBIBWebImageMediator> webImageMediator;第三步是实现一个默认的中介者(这个类依赖了 SDWebImage):
@interface YBIBDefaultWebImageMediator : NSObject <YBIBWebImageMediator>@end@implementation YBIBDefaultWebImageMediator//通过 SDWebImage 的 API 实现 <YBIBWebImageMediator> 协议方法@end第四步是在内部代码中通过条件编译导入并初始化默认中介者:
#if __has_include("YBIBDefaultWebImageMediator.h")#import "YBIBDefaultWebImageMediator.h"#endif...#if __has_include("YBIBDefaultWebImageMediator.h") _webImageMediator = [YBIBDefaultWebImageMediator new];#endif第五步在 YBImageBrowser.podspec 中也可以看到,在不依赖 SDWebImage 的集成方式时排除了两个文件:YBIBDefaultWebImageMediator.{h.m}。
由此便实现了目标:
<YBIBWebImageMediator>协议的中介者。以上便是避免依赖冲突的小技巧,希望读者朋友能提出更好的建议或者意见??。