iOS MVVM最佳实践(二)

引言

  上一篇介绍了MVVM、组件化的基本概念,这一篇咱们就来讲讲代码。
  首先看一下效果图:

歌单.gif

播放器.gif

界面有很多是模仿网易云音乐的,再来看一下代码结构:


代码结构.png

关于代码组织

  • AppMusic: 主要功能模块,包含用户界面和业务逻辑
  • AudioService: 音频服务提供模块,包含播放器、歌词解析和数据请求
  • Fatal: 错误定义模块,出错情况是多方面的,可能来自于后台也可能来自于所使用的类库(系统或第三方)。一般情况下错误可以通过两个维度来描述,errorCode,errorMessage,ErrorConvertible协议提供了对这一层的抽象,所有出错情况最后都转换成ErrorConvertible,通过提取errorMessage来提醒用户
  • Fate: 通用功能模块,主要是一些Extension
  • FDNamespacer: 命名空间模块,提供object.fd.property/object.fd.method()的访问形式来替代object.fd_property/object.fd_method()
  • FOLDin: 通用控件模块,包含自定义导航条、进度条和占位图等
  • Mediator:组件化中间件的实现
  • RxMoya:对Moya提供了Rx支持,并内建了错误处理和缓存
  • SwiftyHUD: 对MBProgressHUD的封装

关于viewModel

  可以认为viewModel就是一个黑箱,只要提供给它输入,它就能产生输出。现在让我们聚焦在AudioSheetListViewController来看一下具体怎么定义和使用:

// viewModel声明
private let viewModel: AudioSheetListViewModelType = AudioSheetListViewModel()

// viewModel实现
protocol AudioSheetListViewModelInputs {
    /// 加载歌曲列表
    func fetchAudioList(by type: Int)
    
    /// 上拉加载更多
    func pullToRefresh(by type: Int, offset: Int)
    
    /// 修改喜欢状态
    func mutateLikeStatus(_ audio: MusicInfo, at indexPath: IndexPath)
}

protocol AudioSheetListViewModelOutputs {
    /// 返回的歌曲
    var audioList: Observable<[MusicInfo]> { get }
    
    /// 上拉加载返回的歌曲
    var audioListAppended: Observable<[MusicInfo]> { get }
    
    /// 刷新控件的状态
    var pullToRefreshState: Observable<MJRefreshState> { get }

    /// 修改喜欢的结果
    var likeStatus: Observable<(flag: Bool, indexPath: IndexPath)> { get }
    
    /// 遭遇错误
    var showError: Observable<ErrorConvertible> { get }
}

protocol AudioSheetListViewModelType {
    var inputs: AudioSheetListViewModelInputs { get }
    var outputs: AudioSheetListViewModelOutputs { get }
}

class AudioSheetListViewModel: AudioSheetListViewModelType
    , AudioSheetListViewModelInputs
    , AudioSheetListViewModelOutputs {
  // 实现协议,处理输入输出
}

可以看到viewModel是一个协议类型,仅仅对外暴露了两个属性,inputs和outputs,分别代表输入输出,而inputs和outputs同样也是协议类型。这样做的好处是提供了良好的封装性,因为你不能直接访问具体实现类。viewModel已经有了,接下来我们在viewDidLoad中绑定viewModel

    private func performBinding() {
        
        // 处理返回的歌曲
        viewModel.outputs.audioList
            .subscribeNext(weak: self) { (self) in
                return { (audios) in
                    guard let audioSheet = self.audioSheet else { return }
                    self.tableHeaderView.configureWith(value: audioSheet)
                    self.dataSource.load(audioList: audios)
                    self.reloadData()
                    // NOTE: reload data first
                    self.view.hideSkeleton()
                    self.tableHeaderView.hideSkeleton()
                    self.placeholderView.state = audios.isEmpty ? .empty : .completed
                }
            }.disposed(by: disposeBag)
        
        /// 上拉加载更多
        tableView.refreshFooter.rx.refresh
            .debounce(1, scheduler: MainScheduler.instance)
            .filter { $0 == .refreshing }
            .subscribeNext(weak: self) { (self) in
                return { _ in
                    guard let type = self.audioSheet?.type else { return }
                    self.offset += self.dataSource.numberOfItems()
                    self.viewModel.inputs.pullToRefresh(by: type, offset: self.offset)
                }
            }.disposed(by: disposeBag)
        
        // 处理上拉数据返回
        viewModel.outputs.audioListAppended
            .subscribeNext(weak: self) { (self) in
                return { (audios) in
                    let indexPaths = self.dataSource.append(audioList: audios)
                    self.tableView.insertRows(at: indexPaths, with: .none)
                    self.view.hideSkeleton()
                    self.tableHeaderView.hideSkeleton()
                    self.placeholderView.state = self.dataSource.numberOfItems() == 0 ? .empty : .completed
                }
            }.disposed(by: disposeBag)
        
        // 更新刷新控件状态
        viewModel.outputs.pullToRefreshState
            .bind(to: tableView.refreshFooter.rx.refresh)
            .disposed(by: disposeBag)
        
        // 处理喜欢
        viewModel.outputs.likeStatus
            .subscribeNext(weak: self) { (self) in
                return { (result) in
                    let flag = result.flag
                    let indexPath = result.indexPath
                    self.dataSource.load(flag: flag, at: indexPath)
                    self.tableView.reloadRow(at: indexPath, with: .none)
                }
            }.disposed(by: disposeBag)
        
        // 处理失败
        viewModel.outputs.showError
            .subscribeNext(weak: self) { (self) in
                return { (error) in
                    self.view.hideSkeleton()
                    self.tableHeaderView.hideSkeleton()
                    if error.isFailedByNetwork {
                        self.placeholderView.state = .failed
                    } else {
                        self.placeholderView.state = .completed
                    }
                    // 接口貌似不稳定 http code 403贼多
                    SwiftyHUD.show(message: error.message)
                }
            }.disposed(by: disposeBag)
    }

至此viewModel的outputs已经全部关联好了,只需要触发inputs一切就形成了闭环。比如我希望在viewDidAppear中请求数据,所以我在viewDidAppear中写下:

    /// 加载歌曲
    private func fetchAudioList() {
        guard let sheet = audioSheet else { return }
        if dataSource.numberOfItems() == 0 {
            view.showAnimatedSkeleton()
            tableHeaderView.showAnimatedSkeleton()
            viewModel.inputs.fetchAudioList(by: sheet.type)
        }
    }

需要说明的是dataSource的实际类型是一个tableView/collectionView数据源的包装类-ValueCellDataSource。实际上它包装了一个二维数组来对应indexPath,数组是私有的,但是可以通过方法来访问。
  viewModel接收到输入以后,在内部通过私有Subject来转发:

    fileprivate let fetchRelay = PublishSubject<Int>()
    func fetchAudioList(by type: Int) {
        fetchRelay.onNext(type)
    }

接下来会来到viewMode的init方法:

let fetch = fetchRelay
    .flatMap { AudioProvider.fetchAndConvertAudioList(by: $0).materialize() }
    .share()
        
audioList = fetch.elements()

至此就触发了网络请求加载资源。注意到这里使用了materialize()来进行错误处理。我们知道一旦AudioProvider.fetchAndConvertAudioList(by: $0)发出了一个错误,fetchRelay就会dispose,所有订阅的observer都会被清除,这不是我们希望的。materialize操作符将所有事件重新包装成Event,这样就避免了发出error,接着使用RxSwiftExt提供的elements和errors操作符就可以很方便的提取元素和错误。网络请求处理完毕,viewModel.outputs.audioList也就发出了元素,接下来只要刷新tableView处理一些状态就可以了。
  现在让我们来整理一下流程:viewDidAppear -> viewModel.inputs -> subject forwarding -> viewModel.outputs -> update UI。viewModel处理了业务逻辑,view只需要绑定输出,触发输入,整个过程非常清晰。

关于MVVM对MVC的兼容

  AudioPlayerViewController就是一个不涉及viewModel的例子。鉴于播放器页面更新频繁,且状态其实是共享自AudioStreamer(基本上都是单例),我在这里使用了通过XXXViewDataSource协议来获取AudioStreamer的状态的方式,相比直接持有这些状态,适时的获取更简单也更不容易出错。

其他

  Asserts文件夹下的图片经pod打包后无法直接访问,需要获取其所在bundle才能访问,具体就是:

# podspec打包
  s.resource_bundles = {
    'AppMusic' => ['AppMusic/Assets/*.{png,jpg}']
  }

// 图片访问
class AppMusicBundleLoader: NSObject {}

extension Bundle {
    static let resourcesBundle: Bundle? = {
        var path = Bundle(for: AppMusicBundleLoader.self).resourcePath ?? ""
        path.append("/AppMusic.bundle")
        return Bundle(path: path)
    }()
}

extension UIImage {
    convenience init?(nameInBundle name: String) {
        self.init(named: name, in: .resourcesBundle, compatibleWith: nil)
    }
}

语言表述难免有疏漏不明之处,如果你还是很疑惑,移步看一下代码吧。

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

推荐阅读更多精彩内容

  • 1月14日水彩打卡——菊花很多天没有画出一幅完整的画了。最近有点意外的事情,我还没适应过来。 在画画中忘了自己,忘...
    尹菀柔阅读 416评论 0 6
  • 总把自己过得不好的原因归咎于别人的人,始终不可能过好!晚安自己
    柠檬茶文化阅读 185评论 0 0
  • 玳安去后,应伯爵问,那天在哪里结拜?是在哥的家里面,还是寺院里好?谢希大说,我们这边只有两个寺院,僧家是永福士,道...
    原野草阅读 266评论 0 1