[关闭]
@sambodhi 2016-12-13T10:23:49.000000Z 字数 4886 阅读 1780

面向协议编程并不是一颗银弹

为什么我们对使用协议感到不满

本文来自于《Advanced Swift》作者Chris Edihof博客,经作者授权同意InfoQ中文站翻译并发布。


InfoQ注标题中银弹一词(Silver Bullet)出自IBM大型机之父Frederick P. Brooks, Jr.在1986年发表的一篇关于软件工程的经典论文,便以《没有银弹:软件工程的本质性与附属性工作》(No Silver Bullet — Essence and Accidents of Software Engineering)为标题。其中的“银弹”是指一项可使软件工程的生产力在十年内提高十倍的技术或方法。该论文强调由于软件的复杂性本质,而使这样“真正的银弹”并不存在。

银弹在软件工程中的含义是指妄图创造某种便捷的开发技术,从而使某个项目的实施提高效率。又或者指摆脱该项目的本质或核心,而达到超乎想象的成功。但这么做的结果却是徒劳的。

在本文中Chris介绍了Swift中的面向协议编程的滥用情况,认为很多时候有更简单的解决办法,面向协议编程并非银弹。


在Swift语言中,面向协议编程很流行。在“面向协议”那儿有很多Swift代码,一些开源库甚至将其声明为功能。我觉得协议在Swift中被过度滥用了,其实问题常常可以用更简单的方式来解决。简而言之,就是不要生搬硬套协议的条条框框,而不知变通。

在WWDC2015上苹果推出了一个Session叫Swift的面向协议编程,它成了这届大会上最有影响力的Session之一。
它表明了除某些情况外,用户可以使用面向协议的解决方案(即协议和一些符合协议的类型)来替换类层次结构(即超类和一些子类)。面向协议的解决方案更简单、更灵活。例如,一个类只能有一个超类,但一个类型可以符合许多协议。

让我们来看看他们在WWDC演讲中解决的这个问题:一系列绘图命令需要渲染成图像,并将指令记录到控制台。通过将绘图命令放在协议中,描述绘图的任何代码可以根据协议的方法来表述。协议扩展允许你根据协议的基本功能定义新的绘图功能,并且每个符合的类型都可以自动获得新的功能。

在上述例子中,协议解决了多种类型之间共享代码的问题。在Swift的标准库中,协议主要用于Collection类型,用来解决完全相同的问题。因为dropFirstCollection类型定义,所有的Collection类型都能自动得到它。与此同时,标准库中定义了太多的Collection相关的协议和类型,当我们想找东西时会面临困难。这是协议的一个缺点,然而,在标准库的情况下还是利大于弊。

现在,让我们通过一个例子来开始。这里有一个WebService类。它使用URLSession从网络加载实体。(实际上并不加载东西,领会意思即可):

  1. class Webservice {
  2. func loadUser() -> User? {
  3. let json = self.load(URL(string: "/users/current")!)
  4. return User(json: json)
  5. }
  6. func loadEpisode() -> Episode? {
  7. let json = self.load(URL(string: "/episodes/latest")!)
  8. return Episode(json: json)
  9. }
  10. private func load(_ url: URL) -> [AnyHashable:Any] {
  11. URLSession.shared.dataTask(with: url)
  12. // etc.
  13. return [:] // should come from the server
  14. }
  15. }

上面的代码很短,运行正常。直到我们要测试loadUserloadEpisode之前,没有什么问题。现在我们要么用stub方法来模拟load,要么通过依赖注入传递来模拟URLSession。我们还可以定义一个符合URLSession的协议,然后传递一个测试实例。不过在这个案例中,我们采用更简单的解决方案,将Webservice更改的部分取出并转换为结构体:

  1. struct Resource<A> {
  2. let url: URL
  3. let parse: ([AnyHashable:Any]) -> A
  4. }
  5. class Webservice {
  6. let user = Resource<User>(url: URL(string: "/users/current")!, parse: User.init)
  7. let episode = Resource<Episode>(url: URL(string: "/episodes/latest")!, parse: Episode.init)
  8. private func load<A>(resource: Resource<A>) -> A {
  9. URLSession.shared.dataTask(with: resource.url)
  10. // load asynchronously, parse the JSON, etc. For the sake of the example, we directly return an empty result.
  11. let json: [AnyHashable:Any] = [:] // should come from the server
  12. return resource.parse(json)
  13. }
  14. }

现在,我们可以不必通过模拟任何东西来测试userepisode了:它们是简单的结构值。我们仍然需要测试load,但只有这一个方法需要写测试(而不是为每个资源)。现在让我们来添加一些协议。

取代parse函数,我们可以为能够从JSON初始化的类型创建一个协议。

  1. protocol FromJSON {
  2. init(json: [AnyHashable:Any])
  3. }
  4. struct Resource<A: FromJSON> {
  5. let url: URL
  6. }
  7. class Webservice {
  8. let user = Resource<User>(url: URL(string: "/users/current")!)
  9. let episode = Resource<Episode>(url: URL(string: "/episodes/latest")!)
  10. private func load<A>(resource: Resource<A>) -> A {
  11. URLSession.shared.dataTask(with: resource.url)
  12. // load asynchronously, parse the JSON, etc. For the sake of the example, we directly return an empty result.
  13. let json: [AnyHashable:Any] = [:] // should come from the server
  14. return A(json: json)
  15. }
  16. }

上面的代码可能看起来更简单,但灵活性也大大降低。例如,你如何定义一个具有User值的数组资源?(上述面向协议的例子中,是不可能实现的,我们必须等待Swift 4或5,直至可用。)协议使代码得以简化,但我认为它不为自身买单,因为它大大减少了我们可以创建一个Resource的方式。

代替将userepisode作为Resource值,我们还可以使Resource成为协议并具有UserResourceEpisodeResource结构。这似乎是一个很流行的做法,因为拥有类型比只是一个值来说,“就是感觉要对一些”:

  1. protocol Resource {
  2. associatedtype Result
  3. var url: URL { get }
  4. func parse(json: [AnyHashable:Any]) -> Result
  5. }
  6. struct UserResource: Resource {
  7. let url = URL(string: "/users/current")!
  8. func parse(json: [AnyHashable : Any]) -> User {
  9. return User(json: json)
  10. }
  11. }
  12. struct EpisodeResource: Resource {
  13. let url = URL(string: "/episodes/latest")!
  14. func parse(json: [AnyHashable : Any]) -> Episode {
  15. return Episode(json: json)
  16. }
  17. }
  18. class Webservice {
  19. private func load<R: Resource>(resource: R) -> R.Result {
  20. URLSession.shared.dataTask(with: resource.url)
  21. // load asynchronously, parse the JSON, etc. For the sake of the example, we directly return an empty result.
  22. let json: [AnyHashable:Any] = [:]
  23. return resource.parse(json: json)
  24. }
  25. }

但如果我们仔细看看,我们真正得到了什么?代码变得更冗长、复杂、不直观。并且由于关联类型,结果最后我们可能定义一个AnyResourceEpisodeResource结构和episodeResource值有什么区别呢?它们都是全局定义的。对于结构体,名称以大写字母开头;而对于值,则使用小写字母。除此之外,结构真的没有任何优势。你可以将它们加入命名空间(自动补全)。所以在这种情况下,有一个值肯定会更简短。

我在网上看到的很多代码例子。例如,我看到这样的协议::

  1. protocol URLStringConvertible {
  2. var urlString: String { get }
  3. }
  4. // Somewhere later
  5. func sendRequest(urlString: URLStringConvertible, method: ...) {
  6. let string = urlString.urlString
  7. }

是什么打动了你?为什么不简单地删除协议并直接传递urlString呢?这样就简单多了。或者,一个单一方法的协议:

  1. protocol RequestAdapter {
  2. func adapt(_ urlRequest: URLRequest) throws -> URLRequest
  3. }

有些争议的是:为什么不简单地删除协议,并在某处传递函数?这样岂不是更简单。(除非你的协议是一个类的协议,你想要一个弱引用)。

我可以继续展示例子,但我希望希望你已经明确我的观点:多数情况下都有更简单的选择。更抽象地说,协议只是实现多态代码的一种方式。还有许多其他方法:子类、泛型、值、函数等。使用值(例如,一个String,而不是一个URLStringConvertible)是最简单的方法。函数(例如adapt而不是RequestAdapter)比值复杂一点,但仍然很简单。泛型(无任何限制)比协议简单。为了完成代码,协议通常比类层次结构更简单。

一个有用的启发是,也许是考虑您的协议是依照数据还是行为来建模。对于数据,结构可能更容易。对于复杂的行为(例如,具有多个方法的委托),协议通常更容易。(标准库的collection协议有点特别:它们并不真正描述数据,而是描述数据操作。)

也就是说,协议可能非常有用。但不要为了面向协议编程而编程。首先要审视你的问题,并尝试以最简单的方式来解决它。让问题推动解决方案,而不是相反。面向协议编程本身无所谓好与坏。就像任何其他技术(函数式编程,OO,依赖注入,子类化)一样,它可以用来解决一个问题,我们应该尝试选择合适的工具。有时这是一个协议,但往往,有一个更简单的方法。

其他

如果您喜欢这篇文章,可以参阅我们的书《Advanced Swift》(已更新到Swift 3)或者中文电子版:《Swift进阶》(王巍 译),或者观看视频系列《Swift Talk》。

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注