从 SDWebImage 谈如何为开源软件做贡献

Posted 2020-08-13 小敏的博客

 

来源：伯乐在线 - 酷酷的哀殿

链接：http://ios.jobbole.com/89483/

点击 → 申请加入伯乐在线专栏作者

 

从 SDWebImage 谈如何为开源软件做贡献

 

相识 – 知我者谓我心忧，不知我者谓我何求

 

今天和别人聊天时，扯到了这个非常著名的开源库。算算日子，我和 SDWebImage 已经认识 3 年零 11 个月了。将近四年的时间，说短不短，说长不长。

 

作为 iOS 开发者，我接触的第一个库就是 SDWebImage（第二个是 ASIHttpRequest）,研究时间最长的也是 SDWebImage。

刚学完基础知识，开始做项目时，我就用到了这个图片缓存库。下面的代码是我从 SDWebImage 身上学到的第一个知识，也是最重要的一个知识：如何设计一个接受多个可选参数的方法，并让调用方能够简单地使用。

 

对于初出茅庐的我来说，这份代码带给我的除了上面的知识以外，我还学会了如何给现有的类写 扩展，第一次见识了 block 的 威力 ……

 

@implementation UIImageView (WebCache)

 

- (void)setImageWithURL:(NSURL *)url

{

    [self setImageWithURL:url placeholderImage:nil];

}

 

- (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder

{

    [self setImageWithURL:url placeholderImage:placeholder options:0];

}

 

- (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(`SDWebImage`Options)options

{

    `SDWebImage`Manager *manager = [`SDWebImage`Manager sharedManager];

 

    // Remove in progress downloader from queue

    [manager cancelForDelegate:self];

 

    self.image = placeholder;

 

    if (url)

    {

        [manager downloadWithURL:url delegate:self options:options];

    }

}

 

#if NS_BLOCKS_AVAILABLE

- (void)setImageWithURL:(NSURL *)url success:(`SDWebImage`SuccessBlock)success failure:(`SDWebImage`FailureBlock)failure;

{

    [self setImageWithURL:url placeholderImage:nil success:success failure:failure];

}

 

- (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder success:(`SDWebImage`SuccessBlock)success failure:(`SDWebImage`FailureBlock)failure;

{

    [self setImageWithURL:url placeholderImage:placeholder options:0 success:success failure:failure];

}

 

- (void)setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(`SDWebImage`Options)options success:(`SDWebImage`SuccessBlock)success failure:(`SDWebImage`FailureBlock)failure;

{

    `SDWebImage`Manager *manager = [`SDWebImage`Manager sharedManager];

 

    // Remove in progress downloader from queue

    [manager cancelForDelegate:self];

 

    self.image = placeholder;

 

    if (url)

    {

        [manager downloadWithURL:url delegate:self options:options success:success failure:failure];

    }

}

#endif

 

实际上，通过这个项目，你还可以学到更多，比如，如何通过 NSData 判断图片的类型，如何管理多线程队列……

 

相知 – 悲莫悲兮生别离，乐莫乐兮新相知

 

不知何时起，我注册了 github 账号，关注（watch）了这个开源项目。

 

对特定项目进行 watch 操作后，该项目任何新的 conversation（合并提交，创建新的 issue，有人回复 issue）都会产生一个未读通知。

 

随着我对它的了解也越来越深，我发现了一系列令人震惊的事实：

 

• 这个库仅仅是由两位开发者维护者更新

• 历史最悠久的未关闭 issue 出自 2011 年

• 几乎所有的版本都有大小不一的 bug（crash、获取错误的图片、回调无法执行……）这些事实一次次地令我感觉震撼，作为一个拥有 15824 个 star 的开源库，它是如此的脆弱。于是，我成为了一名志愿者，我努力地帮助开发者团队解决 issue。

 

相杀 – 消灭bug，是所有程序员的梦想

 

Bug 是所有程序员的噩梦，而上面的 bug，有很多是在特定情况下才会发生的，是无法仅仅依靠开发团队来避免的。作为该项目的成果享有者，我们是否可以做出一些自己的贡献呢？

 

大部分的开发者可能会觉得自己无法贡献代码。那么，我们是否可以充当该项目的测试人员呢？

 

我在下面简单的列出了一些普通开发者能做些什么（主要以 SDWebImage + CocoaPods 为例）。希望各位读者能够一起为开源软件做贡献。

 

SDWebImage 的当前版本号为 3.8.2

 

• 在项目的短期开发分支使用 pod ‘SDWebImage‘, ‘~> 3.8.2‘，并定期执行 pod update。

  可以快速收到 bug 修复版本，可以帮助验证是否已经解决 bug。

• 在项目的长期开发分支使用 pod ‘SDWebImage‘, ‘~> 3.8‘，并定期执行 pod update。

  可以快速收到小的功能更新版本，可能需要修改项目代码，有较小的概率有 bug。

• 在新的项目中使用 pod ‘SDWebImage‘, ‘~> 3‘，并定期执行 pod update。有重大版本更新时，有很大概率需要修改项目代码，有较大的概率有 bug。

• 定期根据版本更新修改 Podfile

• 发现相关bug 后，请及时创建 issue。点此创建

  https://github.com/rs/%60SDWebImage%60/issues/new

 

后记

 

SDWebImage 4.0 版本已经在路上，该版本提供了更加细粒度的控制加载请求，兼容 Swift 3，使用了最新的 OC 语法……