iOS 图片浏览器,功能强大,易于拓展,性能优化和内存控制让其运行更加的流畅和稳健。
相关文章:
YBImageBrowser 重构心得:如何优化架构、性能、内存?
避免 iOS 组件依赖冲突的小技巧
注意事项
关于 3.x 版本 (使用 2.x 版本请切换到 store_2.x 分支)
为了解决 2.x 版本的设计缺陷和代码漏洞,特进行了 3.x 深度重构,所以没办法做到向下兼容,希望社区朋友们能体谅,根据情况进行版本迁移。
提问须知
考虑到笔者的精力问题,遇到问题请先查看 API、效仿 Demo、阅读 README、搜索 Issues。请不要提出与组件无关的问题,比如 CocoaPods 的错误,如果是 BUG 或 Feature 最好是提 Issue。
目录
预览
特性
- 支持 GIF,APNG,WebP 等本地和网络图片类型(由 YYImage、SDWebImage 提供支持)。
- 支持系统相册图片和视频。
- 支持简单的视频播放。
- 支持高清图浏览。
- 支持图片预处理(比如添加水印)。
- 支持根据图片的大小判断是否需要预先解码(精确控制内存)。
- 支持图片压缩、裁剪的界限设定。
- 支持修改下载图片的 NSURLRequest。
- 支持主动旋转或跟随控制器旋转。
- 支持自定义图标。
- 支持自定义 Toast/Loading。
- 支持自定义文案(默认提供中文和英文)。
- 支持自定义工具视图(比如查看原图功能)。
- 支持自定义 Cell(比如添加一个广告模块)。
- 支持添加到其它父视图上使用(比如加到控制器上)。
- 支持转场动效、图片布局等深度定制。
- 支持数据重载、局部更新。
- 支持低粒度的内存控制和性能调优。
- 极致的性能优化和严格的内存控制让其运行更加的流畅和稳健。
安装
CocoaPods
支持分库导入,核心部分就是图片浏览功能,视频播放作为拓展功能按需导入。
- 在 Podfile 中添加:
pod 'YBImageBrowser'
pod 'YBImageBrowser/Video' //视频功能需添加
- 执行
pod install
或pod update
。 - 导入
<YBImageBrowser/YBImageBrowser.h>
,视频功能需导入<YBImageBrowser/YBIBVideoData.h>
。 - 注意:如果你需要支持 WebP,可以在 Podfile 中添加
pod 'YYImage/WebP'
。
若搜索不到库,可执行pod repo update
,或使用 rm ~/Library/Caches/CocoaPods/search_index.json
移除本地索引然后再执行安装,或更新一下 CocoaPods 版本。
去除 SDWebImage 的依赖(版本需 >= 3.0.4)
Podfile 相应的配置变为:
pod 'YBImageBrowser/NOSD'
pod 'YBImageBrowser/VideoNOSD' //视频功能需添加
这时你必须定义一个类实现YBIBWebImageMediator
协议,并赋值给YBImageBrowser
类的webImageMediator
属性(可以参考 YBIBDefaultWebImageMediator
的实现)。
手动导入
- 下载 YBImageBrowser 文件夹所有内容并且拖入你的工程中,视频功能还需下载 Video 文件夹所有内容。
- 链接以下 frameworks:
- SDWebImage
- YYImage
- 导入
YBImageBrowser.h
,视频功能需导入YBIBVideoData.h
- 注意:如果你需要支持 WebP,可以在 Podfile 中添加
pod 'YYImage/WebP'
,或者到手动下载 YYImage 仓库 的 webP 支持文件。
用法
初始化YBImageBrowser
并且赋值数据源id<YBIBDataProtocol>
,默认提供YBIBImageData
(图片) 和YBIBVideoData
(视频) 两种数据源。
图片处理是组件的核心,笔者精力有限,视频播放做得很轻量,若有更高的要求最好是自定义 Cell,望体谅。
Demo 中提供了很多示例代码,演示较复杂的拓展方式,所以若需要深度定制最好是下载 Demo 查看。
建议不对YBImageBrowser
进行复用,目前还存在一些逻辑漏洞。
基本使用
// 本地图片
YBIBImageData *data0 = [YBIBImageData new];
data0.imageName = ...;
data0.projectiveView = ...;
// 网络图片
YBIBImageData *data1 = [YBIBImageData new];
data1.imageURL = ...;
data1.projectiveView = ...;
// 视频
YBIBVideoData *data2 = [YBIBVideoData new];
data2.videoURL = ...;
data2.projectiveView = ...;
YBImageBrowser *browser = [YBImageBrowser new];
browser.dataSourceArray = @[data0, data1, data2];
browser.currentPage = ...;
[browser show];
设置支持的旋转方向
当图片浏览器依托的 UIViewController 仅支持一个方向:
这种情况通过YBImageBrowser.new.supportedOrientations
设置图片浏览器支持的旋转方向。
否则:
上面的属性将失效,图片浏览器会跟随控制器的旋转而旋转,由于各种原因这种情况的旋转过渡有瑕疵,建议不使用这种方式。
自定义图标
修改YBIBIconManager.sharedManager
实例的属性。
自定义文案
修改YBIBCopywriter.sharedCopywriter
实例的属性。
自定义 Toast / Loading
实现YBIBAuxiliaryViewHandler
协议,并且赋值给YBImageBrowser.new.auxiliaryViewHandler
属性,可参考和协议同名的默认实现类。
自定义工具视图(ToolView)
默认实现的YBImageBrowser.new.defaultToolViewHandler
处理器可以做一些属性配置,当满足不了业务需求时,最好是进行自定义,参考默认实现或 Demo 中“查看原图”功能实现。
定义一个或多个类实现YBIBToolViewHandler
协议,并且装入YBImageBrowser.new.toolViewHandlers
数组属性。建议使用一个中介者来实现这个协议,然后所有的工具视图都由这个中介者来管理,当然也可以让每一个自定义的工具 UIView 都实现YBIBToolViewHandler
协议,请根据具体需求取舍。
自定义 Cell
当默认提供的YBIBImageData
(图片) 和YBIBVideoData
(视频) 满足不了需求时,可自定义拓展 Cell,参考默认实现或 Demo 中的示例代码。
定义一个实现YBIBCellProtocol
协议的UICollectionViewCell
类和一个实现YBIBDataProtocol
协议的数据类,当要求不高时实现必选协议方法就能跑起来了,若对交互有要求就相对比较复杂,最好是参考默认的交互动效实现。
在某些场景下,甚至可以直接继承项目中的 Cell 来做自定义。
常见问题
SDWebImage Pods 版本兼容问题
SDWebImage 有两种情况会出现兼容问题:该库对 SDWebImage 采用模糊向上依赖,但将来 SDWebImage 可能没做好向下兼容;当其它库依赖 SDWebImage 更低或更高 API 不兼容版本。对于这种情况,可以尝试以下方式解决:
- Podfile 中采用去除 SDWebImage 依赖的方式导入,只需要实现一个中介者(见安装部分)。
- 更改其它库对 SDWebImage 的依赖版本。
- 手动导入 YBImageBrowser,然后修改
YBIBDefaultWebImageMediator
文件。
为什么不去除依赖 SDWebImage 自己实现?时间成本太高。 为什么不拖入 SDWebImage 修改类名?会扩大组件的体积,若外部有 SDWebImage 就存在一份多余代码。
依赖的 YYImage 与项目依赖的 YYKit 冲突
实际上 YYKit 有把各个组件拆分出来,建议项目中分开导入:
pod 'YYModel'
pod 'YYCache'
pod 'YYImage'
pod 'YYWebImage'
pod 'YYText'
...
而且这样更灵活便于取舍。
低内存设备 OOM 问题
组件内部会降低在低内存设备上的性能,减小内存占用,但若高清图过多,可能需要手动去控制(以下是硬件消耗很低的状态):
YBIBImageData *data = YBIBImageData.new;
// 取消预解码
data.shouldPreDecodeAsync = NO;
// 直接设大触发裁剪比例,绘制更小的裁剪区域压力更小,不过可能会让用户感觉奇怪,放很大才开始裁剪显示高清局部(这个属性很多时候不需要显式设置,内部会动态计算)
data.cuttingZoomScale = 10;
YBImageBrowser *browser = YBImageBrowser.new;
// 调低图片的缓存数量
browser.ybib_imageCache.imageCacheCountLimit = 1;
// 预加载数量设为 0
browser.preloadCount = 0;
视频播放功能简陋
关于大家提的关于视频的需求,有些成本过高,笔者精力有限望体谅。若组件默认的视频播放器满足不了需求,就自定义一个 Cell 吧,把成熟的播放器集成到组件中肯定更加的稳定。
关于 Swift 版本
考虑时间成本,目前没有写 Swift 版本的计划。