Nimble：让SwiftObjective-C测试变得更优雅的匹配库

文章目录

- 什么是Nimble？
- 为什么选择Nimble？
- 安装Nimble
- - [使用Swift Package Manager](#使用Swift Package Manager)
  - 使用CocoaPods
  - 使用Carthage
- Nimble基础用法
- 自定义匹配器
- 与Quick框架结合使用
- 实用技巧
- 常见问题解决
- 总结

大家好！今天要和大家分享一个我最近爱上的开源库 ------ Nimble。作为iOS开发者，写测试总是那个"应该做但总不太想做"的任务（太真实了！）。但自从用上Nimble，测试代码写起来不仅更轻松，还变得相当有趣！

什么是Nimble？

Nimble是一个专为Swift和Objective-C设计的匹配库，它让你的测试代码读起来就像自然语言一样流畅。如果你曾被XCTest那些长长的断言语法折磨过，Nimble绝对会让你眼前一亮！

它通常与Quick（一个行为驱动开发的测试框架）搭配使用，但完全可以单独和XCTest一起使用。这种灵活性让它适用于各种测试场景。

为什么选择Nimble？

使用原生XCTest写断言时，通常会写成这样：

swift 复制代码

XCTAssertEqual(result, 42, "计算结果应该是42")
XCTAssertTrue(isLoggedIn, "用户应该已登录")

这些代码...能用，但不够优雅。

而用Nimble后，你可以这样写：

swift 复制代码

expect(result).to(equal(42))
expect(isLoggedIn).to(beTrue())

看出区别了吗？Nimble的语法更接近自然语言，读起来像是"期望结果等于42"，这让测试代码的意图更清晰，尤其是当你有一堆测试需要阅读和维护的时候！

安装Nimble

安装Nimble超级简单。你可以选择以下几种方式：

使用Swift Package Manager

这是我最推荐的方式！在你的Package.swift文件中添加：

swift 复制代码

dependencies: [
    .package(url: "https://github.com/Quick/Nimble.git", from: "12.0.0")
]

使用CocoaPods

在你的Podfile中添加：

ruby 复制代码

pod 'Nimble', '~> 12.0.0'

然后运行 pod install 就搞定了！

使用Carthage

在Cartfile中添加：

复制代码

github "Quick/Nimble" ~> 12.0.0

然后运行 carthage update 即可。

Nimble基础用法

接下来，让我们看看Nimble最基本（也是最常用）的几种匹配方式！

基本匹配

最简单的匹配是检查相等性：

swift 复制代码

// 检查是否相等
expect(2 + 2).to(equal(4))

// 检查是否为真
expect(userIsActive).to(beTrue())

// 检查是否为nil
expect(optionalValue).to(beNil())

这样的代码读起来就像是在描述你的期望，非常直观！

近似匹配

处理浮点数时，Nimble提供了便捷的近似匹配：

swift 复制代码

// 检查浮点数是否接近某个值
expect(3.14159).to(beCloseTo(3.14, within: 0.01))

这比手动计算误差范围要直观多了！

集合匹配

Nimble对集合类型的匹配特别强大：

swift 复制代码

// 检查数组是否包含特定元素
expect(["苹果", "香蕉", "橙子"]).to(contain("香蕉"))

// 检查数组是否有特定顺序
expect(["首先", "然后", "最后"]).to(beginWith("首先"))
expect(["首先", "然后", "最后"]).to(endWith("最后"))

// 检查字典是否包含键值对
expect(["name": "小明", "age": 25]).to(haveKey("name"))

这些匹配器让你可以精确地表达对集合的期望，而不需要复杂的循环和条件判断。

异步测试

这可能是Nimble最闪亮的部分了！异步测试一直是iOS测试的痛点，但Nimble让它变得超简单：

swift 复制代码

// 等待异步操作完成
waitUntil { done in
    fetchUserProfile() { result in
        expect(result.isSuccess).to(beTrue())
        done()
    }
}

// 或者更简洁的方式
expect { () -> Int? in
    // 这里是异步操作
    return await fetchValue()
}.toEventually(equal(expectedValue))

Nimble的异步测试支持让你不必再为那些恼人的超时和竞争条件头疼了！

自定义匹配器

Nimble真正强大的地方在于，你可以创建自己的匹配器来满足特定需求。比如，我们可以创建一个检查字符串是否是有效电子邮件的匹配器：

swift 复制代码

func beValidEmail() -> Predicate<String> {
    return Predicate { expression in
        guard let value = try expression.evaluate() else {
            return PredicateResult(status: .fail, message: .fail("值为nil"))
        }
        
        // 简单的邮箱验证逻辑
        let pattern = "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,64}"
        let isMatch = value.range(of: pattern, options: .regularExpression) != nil
        
        return PredicateResult(
            bool: isMatch,
            message: .expectedCustomValueTo("是有效的邮箱地址", actual: "\(value)")
        )
    }
}

// 使用自定义匹配器
expect("test@example.com").to(beValidEmail())
expect("invalid-email").toNot(beValidEmail())

这种可扩展性让Nimble能够适应几乎任何测试场景，真是太棒了！

与Quick框架结合使用

虽然Nimble可以单独使用，但它与Quick框架的组合简直就是黄金搭档。Quick提供了行为驱动开发风格的测试结构，与Nimble的自然语言断言一起使用，能让测试代码既结构清晰又易于理解：

swift 复制代码

import Quick
import Nimble

class LoginViewControllerSpec: QuickSpec {
    override func spec() {
        describe("LoginViewController") {
            var viewController: LoginViewController!
            
            beforeEach {
                viewController = LoginViewController()
                viewController.loadViewIfNeeded()
            }
            
            context("当用户输入有效凭证时") {
                beforeEach {
                    viewController.usernameField.text = "validUser"
                    viewController.passwordField.text = "validPass"
                    viewController.loginButton.sendActions(for: .touchUpInside)
                }
                
                it("应该开始登录过程") {
                    expect(viewController.isLoggingIn).to(beTrue())
                }
            }
            
            context("当密码字段为空时") {
                beforeEach {
                    viewController.usernameField.text = "validUser"
                    viewController.passwordField.text = ""
                    viewController.loginButton.sendActions(for: .touchUpInside)
                }
                
                it("应该显示错误信息") {
                    expect(viewController.errorLabel.isHidden).to(beFalse())
                    expect(viewController.errorLabel.text).to(contain("密码"))
                }
            }
        }
    }
}

这种组织方式让测试代码读起来就像是一份详细的功能规范，非常适合团队协作和代码维护！

实用技巧

使用Nimble一段时间后，我总结了一些实用技巧（踩过的坑，哈哈）：

合理使用toNot和notTo - 这两个功能完全一样，只是语法不同，选择一种在团队中统一使用即可。
测试失败时提供自定义消息 - 可以让错误更具描述性：
swift 复制代码
```
expect(user.isAdmin).to(beTrue(), description: "管理员用户应该有管理权限")
```
对于复杂对象，使用containElementSatisfying - 检查集合中是否存在符合特定条件的元素：
swift 复制代码
```
expect(users).to(containElementSatisfying { user in
    user.name == "张三" && user.age > 30
})
```
记住toEventually有超时设置 - 默认是1秒，可以根据需要调整：
swift 复制代码
```
expect(value).toEventually(equal(expectedValue), timeout: .seconds(5))
```
使用satisfyAnyOf和satisfyAllOf组合多个期望 - 当你需要检查多个条件时非常有用：
swift 复制代码
```
expect("密码123").to(satisfyAnyOf(
    haveCount(8),
    contain("!")
))
```

常见问题解决

使用Nimble时可能会遇到一些常见问题，这里分享几个解决方案：

编译错误"Ambiguous use of 'expect'" - 通常是因为你项目中有多个测试框架提供了expect函数。确保导入顺序正确，或者使用完全限定名称Nimble.expect()。
测试运行时间过长 - 检查是否有toEventually匹配器没有触发完成条件，导致一直等到超时。
与SwiftUI结合测试 - SwiftUI的测试可能需要特别注意视图的生命周期，确保在正确的时机执行断言。
错误消息不够明确 - 尝试使用自定义描述或创建专门的匹配器来提供更具体的失败信息。

总结

Nimble真的改变了我对iOS测试的看法。它让测试代码不再是枯燥的技术负担，而是一种清晰表达期望的方式。主要优势包括：

自然语言风格的断言，提高了代码可读性
强大的异步测试支持
丰富的内置匹配器
良好的可扩展性
与Quick框架的完美结合

如果你还在使用XCTest原生断言，强烈建议尝试一下Nimble！它会让你的测试代码更清晰、更易于维护，说不定还能提高你写测试的积极性呢！（这点我深有体会！）

最后，测试不仅仅是为了通过CI/CD流程，更是为了确保你的代码按预期工作，并在将来的重构中保持稳定。好的测试工具能让这个过程更加顺畅，而Nimble无疑是iOS开发中最好的测试工具之一。

希望这篇教程对你有所帮助！开始使用Nimble，让你的测试代码也能变得优雅起来吧！

参考资料：

Nimble GitHub 仓库

Nimble 官方文档

Quick 测试框架