简评:函数提前返回主要的好处是:将每个错误处理进行分离,审查代码时不需要考虑多种复杂异常,我们可以吧注意力集中在也业务逻辑中,调试代码时可以直接在异常中打断点。

提前返回

首先来看一下需要改进的代码示例,我们构建一个笔记应用使用 NotificationCenter API,当笔记内容有变化时 Notification 来通知笔记列表变更,代码如下:

class NoteListViewController: UIViewController {

@objc func handleChangeNotification(_ notification: Notification) {

let noteInfo = notification.userInfo?["note"] as? [String : Any]

if let id = noteInfo?["id"] as? Int {

if let note = database.loadNote(withID: id) {

notes[id] = note

tableView.reloadData()

}

}

}

}

上面的代码可以很好的工作,但是可读性差了点。因为这段代码包含多重缩进和类型转换。我们来尝试改进这段代码。

将方法提前返回,让我们函数尽可能的快的返回。

使用 guard 替代 if,以避免嵌套。

class NoteListViewController: UIViewController {

@objc func handleChangeNotification(_ notification: Notification) {

let noteInfo = notification.userInfo?["note"] as? [String : Any]

guard let id = noteInfo?["id"] as? Int else {

return

}

guard let note = database.loadNote(withID: id) else {

return

}

notes[id] = note

tableView.reloadData()

}

}

将函数提前返回能够将功能失败的情况处理得更加清晰,这不仅提高了可读性(更少的缩进,更少的嵌套),同时也有利于单元测试。

我们可以进一步改进代码,将获取 noteID 和类型转换的代码放在 Notification Extension 中,这样就将 handleChangeNotification 业务逻辑和具体细节分离开来。修改后代码如下所示:

private extension Notification {

var noteID: Int? {

let info = userInfo?["note"] as? [String : Any]

return info?["id"] as? Int

}

}

class NoteListViewController: UIViewController {

@objc func handleChangeNotification(_ notification: Notification) {

guard let id = notification.noteID else {

return

}

guard let note = database.loadNote(withID: id) else {

return

}

notes[id] = note

tableView.reloadData()

}

}

这种结构还大大简化了调试的难度,我们可以直接在每个 guard 中 return 中添加断点来截获所有失败情况,而不需要单步执行所有逻辑。

条件构造

当构造一个对象实例,非常普遍的需求是需要构建哪类对象取决于一系列的条件。

例如,启动应用程序时显示哪个 view controller 取决于:

是否已经登录。

用户是否已经完成入职流程(onboarding flow)。

我们对这些条件的的实现可能是一系列的 if 和 else 语句,如下所示:

func showInitialViewController() {

if loginManager.isUserLoggedIn {

if tutorialManager.isOnboardingCompleted {

navigationController.viewControllers = [HomeViewController()]

} else {

navigationController.viewControllers = [OnboardingViewController()]

}

} else {

navigationController.viewControllers = [LoginViewController()]

}

}

同样的提前返回和 guard 语句可以提升代码可读性,但是现在这种情况不是处理失败情况,而是在不同条件下构建不同 view controller。

现在来改进这段代码,使用轻量级的工程模式,将构造初始界面移动到专门的函数中,该函数返回匹配条件的view controller。如下所示:

func makeInitialViewController() -> UIViewController {

guard loginManager.isUserLoggedIn else {

return LoginViewController()

}

guard tutorialManager.isOnboardingCompleted else {

return OnboardingViewController()

}

return HomeViewController()

}

func showInitialViewController() {

let viewController = makeInitialViewController()

navigationController.viewControllers = [viewController]

}

由于 makeInitialViewController 方法是个纯函数(不影响外部状态,固定输入能够得到固定输出),实际上影响外部状态的只有一个地方 navigationController.viewControllers = [viewController] ,(在日常开发中状态如果没有得到很好的控制很容易引起 bug,所以使用更少状态和减少对状态的修改可以一定程度上减少 bug 出现的几率)。

条件控制

最后我们来看看,函数如何简化复杂的条件逻辑。我们来构建一个 view controller 来显示社交应用的评论功能,如果满足三个条件则运行用户对评论进行编辑。代码如下:

class CommentViewController: UIViewController {

override func viewDidLoad() {

super.viewDidLoad()

if comment.authorID == user.id {

if comment.replies.isEmpty {

if !comment.edited {

let editButton = UIButton()

...

view.addSubview(editButton)

}

}

}

...

}

}

这里使用了 3 个 if 嵌套逻辑,每次重新审查代码都会比较困扰,更具之前的经验我们可以对代码进行优化,添加 Comment extension:

extension Comment {

func canBeEdited(by user: User) -> Bool {

guard authorID == user.id else {

return false

}

guard comment.replies.isEmpty else {

return false

}

return !edited

}

}

class CommentViewController: UIViewController {

override func viewDidLoad() {

super.viewDidLoad()

if comment.canBeEdited(by: user) {

let editButton = UIButton()

...

view.addSubview(editButton)

}

...

}

}

原文:Early returning functions in Swift

参考阅读

评论可见,请评论后查看内容,谢谢!!!评论后请刷新页面。