16.7Todo II - 如何通过Subject传递数据

基于上个待办事项的例子,在这段视频里,我们完成添加和编辑的Todo任务的功能在开始之前,先了解下基于上段视频完成的例子,我们做了哪些主要修改:

去做
  • 修改了之前添加按钮的代码,让它打开一个创建待办事项的视图。
  • 给表格的配件添加了segue,让它打开一个编辑当前Todo的视图;
  • 新建了一个TodoDetailViewController,处理添加和编辑的Todo的逻辑;
  • TodoListViewController中,根据赛格瑞的目标修改了新打开查看的标题;

可以大家在这里下载项目的起始模板。

新建待办事项

接下来,我们就动手实现添加一个新的待办事项这个事情唯一的要点,就是如何把在。TodoDetailViewController中创建的待办事项内容,给传递TodoListViewController在使用RxSwift之前,可可的套路是这样的:

去做
  1. 定义一个protocol,并这个让protocol类型的对象成为TodoDetailViewController的代表;
  2. TodoListViewController实现这个protocol中的方法,并分类中翻译设置TodoDetailViewController的委托对象;
  3. TodoDetailViewController通过委托方法发送数据;

于是,当我们在控制器中发送数据的时候,方法一直是“不对称”的,可以通过给属性赋值把数据“发出去”,但是却要通过protocol“传回来”。

借助RxSwift,我们可以更方便和统一地在控制器之间发送数据。简单来说,让发送数据的一方包含一个可观察对象,让接收方直接订阅就好了。

去做

创建PublishSubject

按照这个思路,先我们在TodoDetailViewController中,添加下面的代码:

class TodoDetailViewController: UITableViewController {
    fileprivate let todoSubject = PublishSubject()
    var todo: Observable {
        return todoSubject.asObservable()
    }
    // ...
}

在继续之前,思考两个问题:

  1. 为什么这里我们使用了一个主题对象呢?
  2. 为什么这个主题一个的英文PublishSubject呢?

对于问题一,因为的英文在TodoDetailViewController内部,我们需要一个观察员,要它订阅到UITextField状语从句:UISwitch的值;但同时,我们也需要它是一个可观察,让可以TodoLisViewController订阅到之后更新待办事项列表的显示。

而对于问题二,相信等我们完成待办事项编辑之后,你自然就会明白了,我们暂且先不管它。

这里,我们还使用了一个小技巧,避免为了todoSubject意外从TodoDetailViewController外部接受onNext事件,把我们定义它成了fileprivate属性。对外,只提供了一个仅供订阅的可观察属性todo

实现onNext

接下来,我们要在用户创建待办事项的时候,给todoSubject发送onNext事件首先,给。TodoDetailViewController添加一个保存的Todo内容的属性:

class TodoDetailViewController: UITableViewController {
    var todoItem: TodoItem!
    // ...
}

其次,在viewWillAppear中初始化它:

class TodoDetailViewController: UITableViewController {

    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)
        todoName.becomeFirstResponder()

        todoItem = TodoItem()
    }

    // ...
}

最后,在Done按钮的事件处理方法里,通知todoSubject

class TodoDetailViewController: UITableViewController {
    @IBAction func done() {
        todoItem.name = todoName.text!
        todoItem.isFinished = isFinished.isOn

        todoSubject.onNext(todoItem)
        dismiss(animated: true, completion: nil)
    }
}

至此,TodoDetailViewController这一侧的装修就完工了。可以我们到TodoListViewController去订阅了。

在另一个控制器中订阅

要在另外一个控制器中订阅todo,最核心的问题,如何就是得到TodoDetailViewController对象。然而,这对我们来说,并不是一个问题,通过Segue公司进行场景转换的时候,已经我们通过topViewController得到了。因此,在TodoListViewController中,添加下面的代码:

class TodoListViewController: UIViewController {
    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
        let naviController =
            segue.destination as! UINavigationController
        var todoDetailController =
            naviController.topViewController as! TodoDetailViewController

        if segue.identifier == "AddTodo" {
            todoDetailController.title = "Add Todo"

            todoDetailController.todo.subscribe(
                onNext: {
                    [weak self] newTodo in
                    self?.todoItems.value.append(newTodo)
                },
                onDisposed: {
                    print("Finish adding a new todo.")
                }
            ).addDisposableTo(bag)
        }
    }
}

其中,新增的代码,订阅就是todo的部分,我们从事件中订阅到要添加的内容,然后塞进todoItems,由于它也是响应式的,UITableView就能自动更新了。

资源被正常回收了么?

此时,尽管已经可以正常添加Todo了,但是如果你足够细心就可以发现,控制台并没有打印Finsih添加了一个新的todo。的提示。也就是说,在dismissTodoDetailViewController之后,todoSubject并没有释放,我们应该在某些地方导致了资源泄漏。

为了进一步确认这个问题,在Podfile中添加下面的内容:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    if target.name == 'RxSwift'
      target.build_configurations.each do |config|
        if config.name == 'Debug'
          config.build_settings['OTHER_SWIFT_FLAGS'] ||= ['-D', 'TRACE_RESOURCES']
        end
      end
    end
  end
end

简单来说,就是找到项目中的RxSwift target,在它的调试配置中,添加-D TRACE_RESOURCES编译参数,并在Termianl中重新执行pod install更新下RxSwift。然后,在TodoDetailViewControllerviewWillAppear方法中,添加下面的代码:

override func viewWillAppear(_ animated: Bool) {
    super.viewWillAppear(animated)
    todoName.becomeFirstResponder()

    todoItem = TodoItem()

    print("Resource tracing: \(RxSwift.Resources.total)")
}

这样,我们就能在控制台看到当前RxSwift分配的资源计数重新建立并执行整个项目,然后多添加几个藤,就会在控制台看到资源一直在增加:

去做

为什么会这样呢其实,看下订阅的代码就明白了?

todoDetailController.todo.subscribe(
    onNext: {
        [weak self] newTodo in
        self?.todoItems.value.append(newTodo)
    },
    onDisposed: {
        print("Finish adding a new todo.")
    }
).addDisposableTo(bag)

我们把todo.subscribe返回的订阅对象放在了TodoListViewController.bag里,但只要App不退出,作为初始视图控制器的TodoListViewController是不会被释放的,因此,它的bag里装的订阅对象只会越来越多。这显然不是我们想要的,怎么办呢?

一个“头疼医头”的办法,把就是todo.subscribe报道查看的订阅对象放在TodoDetailViewControllerbag里。这样,当控制器被dismiss的时候,bag里的订阅就会自动被取消,todoSubject占用的资源也就被回收了。为了验证这个想法,在我们TodoDetailViewController中添加下面的代码:

class TodoDetailViewController: UITableViewController {
    // ...
    var bag = DisposeBag()
}

然后,修改TodoListViewController中的订阅代码:

todoDetailController.todo.subscribe(
    onNext: {
        [weak self] newTodo in
        self?.todoItems.value.append(newTodo)
    },
    onDisposed: {
        print("Finish adding a new todo.")
    }
).addDisposableTo(todoDetailController.bag)

重新编译执行,现在,多次打开添加待办事项的界面,就会发现资源可以正常回收了:

去做

但事情至此还没结束,可能你会觉得这样写代码感觉怪怪的,甚至有些危险。因为我们要依赖一个Controller(TodoDetailViewController)中的某个属性(bag)才能得以工作正常。而常规的开发经验通常告诉我们,如此密切的耦合关系通常是各种问题滋生的温床。这至多,只能算一个“非主流”的办法。

那么,更“主流”的办法是什么呢?

希望你还记得,对于一个Observable来说,除了所有订阅者都取消订阅会导致其被回收之外,Observable自然结束(onCompleted)或发生错误结束(onError)也会自动让所有订阅者取消订阅,并导致Observable占用的资源被回收。

因此,当TodoDetailViewController dismiss之后,实际上我们也不会再使用它添加新的待办事项了,这时,应该我们给todoSubject发送onCompeleted事件,明确告知RxSwift,这个事件序列结束了:

class TodoDetailViewController: UITableViewController {
    // ...
    override func viewWillDisappear(_ animated: Bool) {
        super.viewWillDisappear(animated)
        todoSubject.onCompleted()
    }
}

于是,我们之前的订阅代码就可以进一步改成这样:

_ = todoDetailController.todo.subscribe(
    onNext: {
        [weak self] newTodo in
        self?.todoItems.value.append(newTodo)
    },
    onDisposed: {
        print("Finish adding a new todo.")
    }
)

至此,所有添加的Todo的工作,就结束了。接下来,我们实现编辑的部分。

编辑待办事项

编辑待办事项,和新建的Todo绝大部分工作都是一样的,只是相比新建,有两个关键问题要想清楚:

  • 如何把要编辑的内容传递给TodoDetailViewController;
  • 编辑后的内容如何传回来更新UI;

第一个问题,我们可以在segue中通过Identifier来确定如果是编辑操作,就读取当前表视图中被选中的cell,然后根据cell的IndexPath,读取到Todo的内容,并传递给TodoDetailViewController

有了这个思路之后,首先,来我们处理prepare(for:sender:)方法:

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    let naviController = segue.destination as! UINavigationController
    var todoDetailController =
        naviController.topViewController as! TodoDetailViewController

    if segue.identifier == "AddTodo" {
        // ...
    }
    else if segue.identifier == "EditTodo" {
        // 1\. The edit segue
        todoDetailController.title = "Edit todo"

        // 2\. Get the selected cell index
        if let indexPath = tableView.indexPath(
            for: sender as! UITableViewCell) {

            // 3\. Pass the selected todo
            todoDetailController.todoItem =
                todoItems.value[indexPath.row]
        }
    }
}

这样,我们就把用户选择编辑的待办事项,传递给了TodoDetailViewController.todoItem

其次,在TodoDetailViewController中,当todoItem不为nil时,我们要用它的内容初始化界面:

class TodoDetailViewController: UITableViewController {
    // ...

    override func viewWillAppear(_ animated: Bool) {
        super.viewWillAppear(animated)
        todoName.becomeFirstResponder()

        if let todoItem = todoItem {
            self.todoName.text = todoItem.name
            self.isFinished.isOn = todoItem.isFinished
        }
        else {
            todoItem = TodoItem()
        }

        print("Resource tracing: \(RxSwift.Resources.total)")
    }
}

第三,无论是新建还是编辑待办事项,名单最终在提交操作的done方法里,都是我们给todoSubject发送一条onNext事件接下来,只要回到。TodoListViewController,处理在EditTodo的情况里,订阅这个事件更新UI就好了:

override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    // ...

    if segue.identifier == "AddTodo" {
        // ...
    }
    else if segue.identifier == "EditTodo" {
        todoDetailController.title = "Edit todo"

        if let indexPath =
            tableView.indexPath(for: sender as! UITableViewCell) {

            todoDetailController.todoItem =
                todoItems.value[indexPath.row]

            _ = todoDetailController.todo.subscribe(
                onNext: { [weak self] todo in
                    self?.todoItems.value[indexPath.row] = todo
                },
                onDisposed: {
                    print("Finish editing a todo.")
                }
            )
        }
    }
}

其中,最关键的,就是订阅到编辑过的待办事项后,直接把它赋值给了当前正在编辑的待办事项,由于todoItems的英文响应式的,因此整个UITableView就被自动更新了。

现在,可以回过头思考之前遗留的一个问题了,在为什么TodoDetailViewController中我们使用了PublishSubject,而不是其他的主题呢?

这是因为其他的主题会向事件的订阅者发送一个当前的默认值,当我们在Segue公司中订阅事件的时候就会订阅到这个默认值。如果此时我们在新建的Todo,那么就会同时创建出来两个待办事项,一个是默认值,一个是用户自己添加的。这种行为,显然不是我们期望的。

下一步是什么?

以上,就是这一节的内容,其中,最重要的内容有两点:

  • 如何通过主题在控制器之间传递数据;
  • 在控制器之间传递数据的时候,如何正确的释放学科资源;

在下一节,我们将对保存待办事项列表的功能做一些修改,通过一个实际的例子,了解自定义可观察的应用场景。

你可能感兴趣的:(16.7Todo II - 如何通过Subject传递数据)