如何将第三方库与业务代码解耦

日常开发中我们经常会用到各种第三方库,而如何使用别人的代码其实也有一点讲究。如果直接在业务代码中使用第三方库,导致项目对某个第三方库的依赖过重,那一旦因为各种原因需要更换方案的时候,所需要修改的代码量之大可能还不如直接重写了。

所以关键就在于如何将第三方库与业务代码进行解耦,常见的思路就是对第三方库进行二度封装。而具体怎么封装,可以有很多方案,比较简单粗暴的是使用继承。譬如我们在项目中集成了 AFNetworking,但我们不直接使用AFHTTPRequestOperationManager来进行网络请求,而是新建一个MyHTTPRequestOperationManager继承自AFHTTPRequestOperationManager,声明一系列方法供业务方调用,这些方法可以执行一些额外的操作,然后将请求消息转发给父类。这样如果以后不准备使用 AFNetworking 了,只需要改写AFHTTPRequestOperationManager这个类,而不用去修改其它地方。这是可行的,但是我们可以有更好的解决方案。

2015年的 WWDC 有一个 topic 是 Protocol-Oriented Programming in Swift,苹果宣称 Swift 是一门面向协议的语言,说是这将颠覆人们写代码的方式。这多少有点夸大其辞,毕竟所谓的面向协议编程其实跟几十年前就被提出的设计原则——面向接口编程而不是面向实现编程,是有异曲同工之妙的。

那接下来,我就运用面向协议的思维来进行解耦。举个真实的案例吧,最近我准备在项目中集成 Realm 来做缓存,于是我先声明了一个CacheManagerType

typealias Handler = () -> Void
protocol CacheManagerType {
    associatedtype Cacheable
    
    static var defaultManager: Self { get }
    
    func addItem(item: Cacheable)
    func updateItem(item: Cacheable)
    func deleteItem(item: Cacheable)
    
    func addItems(items: [Cacheable])
    func updateItems(items: [Cacheable])
    func deleteItems(items: [Cacheable])
    func deleteAllItems()
    
    func itemWithId(id: Int) -> Cacheable?
    
    func updateWithHandler(handler: Handler)
}

Swift 不直接支持范型协议,不过可以用associatedtype达到相同的效果,这边的Cacheable就是一个范型,代表了可以被缓存的类型。接下来我定义一个RealmCacheManager,它遵守CacheManagerType协议:

private let errorMessage = "Realm exception: write failed."
private let cacheQueueName = "cn.sheepy.CacheManager"
private let cacheQueue = dispatch_queue_create(cacheQueueName, DISPATCH_QUEUE_CONCURRENT)

private let instance = CacheManager()

final class RealmCacheManager: NSObject, CacheManagerType {
    
    static var defaultManager: RealmCacheManager {
        return instance
    }
    
    private var cache: RLMRealm {
        // The default `RLMRealm` instance for the current thread
        return RLMRealm.defaultRealm()
    }
    
    // MARK: - Handle item
    
    func addItem(item: RLMObject) {
        invokeInCacheQueue {
            self.cache.addObject(item)
        }
    }
    
    func updateItem(item: RLMObject) {
        invokeInCacheQueue {
            self.cache.addOrUpdateObject(item)
        }
    }
    
    func deleteItem(item: RLMObject) {
        invokeInCacheQueue {
            self.cache.deleteObject(item)
        }
    }
    
    // MARK: - Handle items
    
    func addItems(items: [RLMObject]) {
        invokeInCacheQueue {
            self.cache.addObjects(items)
        }
    }
    
    func updateItems(items: [RLMObject]) {
        invokeInCacheQueue {
            self.cache.addOrUpdateObjectsFromArray(items)
        }
    }
    
    func deleteItems(items: [RLMObject]) {
        invokeInCacheQueue {
            self.cache.deleteObjects(items)
        }
    }
    
    func deleteAllItems() {
        invokeInCacheQueue {
            self.cache.deleteAllObjects()
        }
    }
    
    // MARK: - Handle with closure
    
    func updateWithHandler(handler: Handler) {
        invokeInCacheQueue {
            handler()
        }
    }
    
    // MARK: - Query
    
    func itemWithId<T: RLMObject>(id: Int) -> T? {
        if let result = T.objectsWhere("id == \(id)").firstObject() as? T {
            return result
        } else {
            return nil
        }
    }
    
    // MARK: - Private methods
    
    private func invokeInCacheQueue(handler: Handler) {
        dispatch_async(cacheQueue) {
            self.invoke(handler)
        }
    }
    
    private func invoke(handler: Handler) {
        do {
            try cache.transactionWithBlock {
                handler()
            }
        } catch {
            printLog(errorMessage)
        }
    }
}

这个类是CacheManagerType的 Realm 版本的实现,我们可以定义生成方法:

fun genericCacheManager<T: CacheManagerType>() -> T {
    return T.defaultManager
}

func cacheManager() -> RealmCacheManager {
    return genericCacheManager()
}

在业务方需要进行缓存操作的时候,只需要调用生成方法拿到一个defaultManager单例即可使用:

let cacheManager = cacheManager()

如果要以它作为方法参数,那该方法应该声明为范型方法:

func doSometihingWithCacheManager<T: CacheManagerType>(cacheManager: T)

这样,一旦以后需要更换缓存方案,譬如还是准备使用 CoreData,那只需要创建一个CoreDataCacheManager,让它遵守CacheManagerType,然后把cacheManager方法的返回类型改为CoreDataCacheManager即可:

func cacheManager() -> CoreDataCacheManager {
    return genericCacheManager()
}

这样原先业务代码中得到的cacheManager就自动变成CoreDataCacheManager的一个单例了。用了一段时间如果觉得还是 Realm 好用,依旧只要把cacheManager方法的返回类型改为RealmCacheManager就可以了,非常方便。

以上方案还有一个问题,就是RealmCacheManager的一系列方法的参数都使用了RLMObject,这是Realm中 Model 的基类,业务代码中需要生成具体RLMObject对象才能使用这些缓存方法,这也是一种紧耦合。一旦移除了 Realm,还是需要修改许多业务代码。更合适的方法是声明一个Cacheable协议:

protocol Cacheable {
    var entity: RLMObject { get }
}

然后让一个原先就在项目中用来表示 Model 的类型来遵守这个协议,譬如 JOSN、Dictionary、MTLModel 等等都行。譬如这样:

extension XXXModel: Cacheable {
    var entity: RLMObject {
        return RLMObject(object: self)
    }
}

具体的转换逻辑可以用 extension 加到 RLMObject 中去,这样就把转换逻辑和 RLMObject 对象从业务代码中剥离出来。而且CacheManagerType中的associatedtypedefaultManager也可以去掉了,CacheManagerType可以作为类型使用了(Swift 中使用了associatedtypeSelf的协议不能作为类型,只能作为范型约束)。相应的在RealmCacheManager中相关的方法要进行一点修改,以addItem为例:

func addItem(item: Cacheable) {
    invokeInCacheQueue {
        self.cache.addObject(item.entity)
    }
}

生成方法只要这样就行了:

func cacheManager() -> CacheManagerType {
    return RealmCacheManager.defaultManager
}

以后要换缓存方案的时候,只需要修改Cacheableentity的返回类型(譬如 CoreData 中的NSManagedObject),然后相应地添加转换逻辑就行了。cacheManager实例的替换跟之前差不多,把cacheManager中的RealmCacheManager换成CoreDataCacheManager就行了。

说了这么多,其实主要目的就是在工具库和业务代码间设置一层抽象屏障,不让业务代码对某个类库依赖过重(当然,如果是确定会一直使用,中途不会有任何变更的第三方库,那大可不必如此)。具体的做法不必拘泥于我文中的思路,大家尽可各展神通。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,802评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,109评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,683评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,458评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,452评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,505评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,901评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,550评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,763评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,556评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,629评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,330评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,898评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,897评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,140评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,807评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,339评论 2 342

推荐阅读更多精彩内容