在本课中,你将为FoodTracker应用定义并测试一个数据模型(data model)。数据模型代表的是存储在应用中的信息的结构。
学习目标
在本课结束的时候,你将能够:
- 创建一个数据模型
- 为自定义类编写可失败的初始化器
- 从概念上理解可失败和不可失败初始化器之间的区别
- 通过编写和运行单元测试来测试数据模型
创建数据模型
现在你将创建一个数据模型来存储那些要在场景中显示的信息。为了做到这一点,你定义一个包含名字(name)、照片(photo)、评分(rating)的类。
创建一个新的数据模型类
- 选择File > New > File (或者按下Command-N)。
- 在出现的对话框的顶部,选择iOS。
- 选择Swift 文件,点击Next。
由于你给数据模型定义了一个基类,意味着它不需要从其他类中继承,所以它的创建方式和之前的RatingControl类创建方式不同。 - 在Save As字段,键入Meal。
- 默认保存位置是你的项目目录。
Group 选项默认是应用名字,FoodTracker’。在Targets部分,应用被选中,而应用册测试没有被选中。 - 其他的不变,点击Create。
Xcode创建名为Meal.swift的文件。如有必要,在Project navigator中,拖拽Meal.swift文件把它放置到其他Swift文件的下面。
在Swift中,你可以用String表示名字、用UIImage表示照片、用Int表示评分。因为菜品总是有名字和评分,但不一定有照片,所以UIImage设置为可选(optional)。
为菜品定义数据模型
-
如果助理编辑器开着,则返回到标准编辑器。
- 打开Meal.swift。
- 改变import语句,用UIKit代替Foundation
import UIKit
当一个Xcode创建一个新swift文件,默认情况下会导入(import)Foundation框架,让你在代码中使用Foundation数据结构。由于你将要使用来自UIKit框架的类,所以你需要导入UIKit。然而,导入了UIKit就能访问Foundation,所以你可以删除冗余的包含Foundation的代码。
- 在import语句后面,添加如下代码:
class Meal {
//MARK: Properties
var name: String
var photo: UIImage?
var rating: Int
}
这些代码定义了你需要存储的数据的基本属性。你使用变量(var)来替代常量(let)是因为你将需要在Meal对象的整个生命周期中对它们进行修改。
- 在属性的下面,添加代码来声明一个初始化器。
//MARK: Initialization
init(name: String, photo: UIImage?, rating: Int) {
}
回想一下,初始化器方法能准备一个类的实例来使用,它需要为每个属性设置一个初始化值,并执行任何其他的设置和初始化操作。
- 通过设置属性等于参数值来填写基本的实现。
// Initialize stored properties.
self.name = name
self.photo = photo
self.rating = rating
但是,如果你尝试创建一个使用了不正确值的Meal将会发生什么,比如给评分一个空值或者一个负值?你需要返回nil来表示这个项目不能被创建,并已设置了一个默认值。你需要添加代码来检查这种情况,如果失败则返回nil。
- 紧跟着初始化存储属性代码下面,添加如下代码:
// Initialization should fail if there is no name or if the rating is negative.
if name.isEmpty || rating < 0 {
return nil
}
这个代码验证传入参数,如果它们包含无效值则返回nil。
注意,编译器会提示一个错误,“Only failable initializers can return nil (只有可失败初始化器能返回nil)”
-
点击错误图标显示fix-it信息。
- 双击fix it来更新你的初始化器。现在初始化器应该是这样的:
init?(name: String, photo: UIImage?, rating: Int) {
可失败初始化器总是使用init?或者init!。这些初始化器分别返回可选类型(optional)值或隐式解包可选类型(implicitly unwrapped optional)值。可选类型能同时包含有效值和nil。你必须检查是否可选类型有一个值,然后在使用之前安全的解包这个值。隐式解包可选类型也是可选类型,但是系统会对它们进行隐式解包。在本例中,你的初始化器返回一个可选类型对象,Meal?
现在,你的init?(name: String, photo: UIImage?, rating: Int)初始化器看上去是这样的:
init?(name: String, photo: UIImage?, rating: Int) {
// Initialization should fail if there is no name or if the rating is negative.
if name.isEmpty || rating < 0 {
return nil
}
// Initialize stored properties.
self.name = name
self.photo = photo
self.rating = rating
}
进一步探索
正如你在本系列课程后面看到的,可失败初始化器较难使用,因为你需要在使用之前对它的返回可选类型进行解包。一些程序员比较喜欢使用assert()和precondition()方法强行执行初始化器。这些方法在它们检测到错误的时候终止应用。这意味着在调用初始化器之前,调用代码必须有有效数据。
更多关于初始化器的信息,查看Initialization。关于在代码中添加内联性检查和前提条件的信息,查看assert(::file:line:)和precondition(::file:line:)
检查点:通过选择Product > Build(或按下Command-B)来构建项目。你还没有使用新类来做任何事情,但是构建可以给编译器一个机会来证实没有输入错误。如果你有,根据编译器提供的错误或警告信息来修复它,然后再回顾一下本课中的说明,确保每件事都如它描述的那样。
测试你的数据
虽然你的数据模型代码已经构建,但是你还没有把它并入到应用中。因此,很难判断你已经正确的实现了每件事,如你可能遇到在运行时未考虑到的边缘情况。
为了解决这种不确定,你可以写单元测试。Unit tests(单元测试)是使用小型的、独立的代码片段,来确保它们的行为正确。Meal类是单元测试完美的候选人。
查看FoodTracker的单元测试文件
-
在project navigator中点击FoodTrackerTests文件旁的小三角来展开它。
- 打开FoodTrackerTests.swift。
花一点时间来理解这个文件中迄今为止的代码。
import XCTest
@testable import FoodTracker
class FoodTrackerTests: XCTestCase {
override func setUp() {
super.setUp()
// Put setup code here. This method is called before the invocation of each test method in the class.
}
override func tearDown() {
// Put teardown code here. This method is called after the invocation of each test method in the class.
super.tearDown()
}
func testExample() {
// This is an example of a functional test case.
// Use XCTAssert and related functions to verify your tests produce the correct results.
}
func testPerformanceExample() {
// This is an example of a performance test case.
self.measure {
// Put the code you want to measure the time of here.
}
}
}
代码从导入(import)XCText框架到你的应用开始。
注意,代码在导入你的应用的时候使用了@testable属性。这给了你的测试文件访问你的应用代码内部元素的入口。记住,Swift默认对所有代码中的类型、变量、属性、初始化方法、以及函数进行内部访问控制。如果你没有明确的标记一个项目是文件私有或私有,那么你就可以从测试访问它。
XCTest框架是Xcode的测试框架。单元测试本身在一个类中被定义,FoodTrackerTests,它继承自XCTestCase。这些代码注释解释了 setUp() 和 tearDown()方法,以及两个测试用例:testExample() 和testPerformanceExample().
你能写的测试的主要类型是函数测试(检查它们是否能得到你期望的值)和性能测试(检查代码是否如你期望的那样快)。因为你还没有写过任何很影响性能的代码,所以你将只需要写一些函数测试。
测试用例是简单的方法,它们是作为单元测试的一部分由系统自动运行的。为了创建测试用例,创建一个方法,方法名要以test开头。最好给你的测试用例描述性的名字。这些名字可以让你在以后很容易的识别单个测试。例如,一个测试检查Meal类的初始化代码,可以命名为testMealInitialization。
为Meal对象初始化编写单元测试
- 在 FoodTrackerTests.swift中,你不需要任何模版创建的方法。删除这些模版方法。你的菜品跟踪测试应该是下面这样的:
import XCTest
@testable import FoodTracker
class FoodTrackerTests: XCTestCase {
}
- 在结束的花括号之前,添加如下内容:
//MARK: Meal Class Tests
- 在注释下面,添加一个新的测试用例:
// Confirm that the Meal initializer returns a Meal object when passed valid parameters.
func testMealInitializationSucceeds() {
}
当单环测试运行的时候系统自动的运行这个测试用例。
- 添加测试到测试用例,测试使用0分和最高分来进行:
// Zero rating
let zeroRatingMeal = Meal.init(name: "Zero", photo: nil, rating: 0)
XCTAssertNotNil(zeroRatingMeal)
// Highest positive rating
let positiveRatingMeal = Meal.init(name: "Positive", photo: nil, rating: 5)
XCTAssertNotNil(positiveRatingMeal)
如果初始化器如预想般工作,则调用init(name:, photo:, rating:)将成功。XCTAssertNotNil通过检查返回的Meal对象是否为nil来证明这一点。
- 现在在Meal类的初始化失败的情况下添加测试用例。添加下面的方法到testMealInitializationSucceeds()方法下面。
// Confirm that the Meal initialier returns nil when passed a negative rating or an empty name.
func testMealInitializationFails() {
}
再次,当单元测试运行的时候,系统会自动运行测试单元。
- 现在添加测试代码来测试使用无效参数调用初始化器的情况。
// Negative rating
let negativeRatingMeal = Meal.init(name: "Negative", photo: nil, rating: -1)
XCTAssertNil(negativeRatingMeal)
// Empty String
let emptyStringMeal = Meal.init(name: "", photo: nil, rating: 0)
XCTAssertNil(emptyStringMeal)
如果初始化器如预想般工作,这些对init(name:, photo:, rating:)的调用会失败。XCTAssertNil通过检查返回的Meal对象是否为nil来这时它。
- 到现在为止,这些测试都应该是成功的。现在测试一个错误的情况。在负评分和空字符串测试代码之间添加下面的代码:
// Rating exceeds maximum
let largeRatingMeal = Meal.init(name: "Large", photo: nil, rating: 6)
XCTAssertNil(largeRatingMeal)
你的单元测试类应该看上去是这样的:
class FoodTrackerTests: XCTestCase {
你能添加额外的子类到你的FoodTrackerTests目标来添加额外的测试用例。选择Product > Test (或者按下 Command-U)来同时运行所有的单元测试。你也可以运行一个单独的测试。
检查点:通过选择Product > Test 菜单项运行单元测试。 testMealInitializationSucceeds()测试用例将成功,而testMealInitializationFails()测试用例会失败。
注意Xcode在左侧自动打开的Test navigator,高亮显示失败的测试。
在编辑器窗口显示当前打开文件的结果。在本例中,如果测试用例的一个或多个方法失败的时候这个用例也就失败。如果测试方法的一个或多个测试失败这个方法也就失败。在本例中,只有XCTAssertNil(largeRatingMeal)测试失败了。
Test navigator还列出了通过测试用例分组的各种测试方法。点击测试方法可以在编辑器中导航到它的代码。右侧的图标显示了这个测试方法是成功还是失败。你能通过移动鼠标到成功或失败的图标上来返回一个测试方法。当图标变成一个播放箭头图标时,点击它。
就像你看到的,单元测试帮助捕捉你代码中的错误。它们还能帮你定义你的类期望的行为。在本例中,Meal类的初始化器在你传递一个空字符串或者负评分时会失败,但是传递一个大于5的值的时候不失败。要回去修复它。
修改错误
- 在Meal.swift中,找到init?(name:, photo:, rating:)方法。
- 你可以修改if子句,但是复杂的布尔表达式会让理解变得困难。这里可以使用一系列检查来替代它。而且,因为你在执行代码之前验证数据,所以要使用guard语句。
guard(保护)语句声明了一个条件,这个条件必须为真,以便执行guard语句后面的代码被执行。如果条件为假是,保护语句后面的else分支必须退出当前的代码块(例如,通过调用 return, break, continue, throw,或者一个类似fatalError(_:file:line:)不需要返回的方法)。
替换此代码:
// Initialization should fail if there is no name or if the rating is negative.
if name.isEmpty || rating < 0 {
return nil
}
用下面的代码:
// The name must not be empty
guard !name.isEmpty else {
return nil
}
// The rating must be between 0 and 5 inclusively
guard (rating >= 0) && (rating <= 5) else {
return nil
}
你的init?(name:, photo:, rating:)方法应该看上去是这样的:
init?(name: String, photo: UIImage?, rating: Int) {
// The name must not be empty
guard !name.isEmpty else {
return nil
}
// The rating must be between 0 and 5 inclusively
guard (rating >= 0) && (rating <= 5) else {
return nil
}
// Initialize stored properties.
self.name = name
self.photo = photo
self.rating = rating
}
检查点:使用单元测试运行应用。所有的测试用例都应该通过。
单元测试是编写代码的重要部分,因为它帮助你不活你可能忽略的错误。就像它们的名字所示,保持单元测试模块化石重要的。每个测试应该检查一个特定的基本类型行为。如果你写长的复杂的单元测试,就难以跟踪错误。
小结
在本课中,你构建了一个模型(model)类来持有你的应用数据。你还比较了常规初始化器和可失败初始化器之间的区别。最后,你添加了几个单元测试来帮助你找到代码中的错误并修复它们。
在稍后的课程中,你将在应用的代码中使用模型对象来创建和管理菜品列表。但是,在你做这些之前,你需要学习如何使用表视图(table view)来呈现菜品列表。
注意
想看本课的完整代码,下载这个文件并在Xcode中打开。
下载文件