Swift后端Vapor中的数据校验

Validation

亲，我的已不再维护和更新了，所有文章都迁移到了我的个人博客：https://mikefighting.github.io/，欢迎交流。

服务端在有数据请求时需要对数据进行校验然后返回响应的校验结果，比如要求必须输入邮箱，必须输入电话等，Validation工具给我们提供了非常方便的常用操作，接下来就对其使用过程做以总结（本文用到的是Validation 1.2.0版本）。

Vapor中添加Validation依赖包

在Package.swift文件中添加如下的依赖，比如：

.Package(url: "https://github.com/vapor/vapor.git", majorVersion: 2),
.Package(url: "https://github.com/vapor/validation-provider.git", majorVersion: 1)

之后要执行vapor clean或者rm -rf .build Package.pins，然后执行vapor update或者swift package update，这样才可以安装好依赖。

校验实例

Alphanumeric校验

接下来我们来做一个简单的校验，校验输入的字符串是否是a-z或者0-9在请求中加入如下代码：

   get("alpha") { request in
               guard let input = request.data["input"]?.string else {
                   throw Abort.badRequest
               }
               let validInput = try input.tested(by: OnlyAlphanumeric())
               return "validated:\\(validInput)"
   }

我们运行程序，然后在PostMan中输入http://localhost:8080/[email protected]，这时会得到下面的返回值：

    {"identifier":"Validation.ValidatorError.failure","reason":"Internal Server Error","debugReason":"OnlyAlphanumeric failed validation: [email protected] is not alphanumeric","error":true}

这也就说明了，我们传输的问本内容不符合alphanumeric。
然后我们将URL改为http://localhost:8080/alpha?input=example123，然后就会看到我们的返回值

validated:example

邮箱校验

我们可以利用EmailValidator来做邮箱的校验，方法同上面一样：

get("email") { request in
            guard let input = request.data["input"]?.string else {
                throw Abort.badRequest
            }
            let validaInput = try input.tested(by: EmailValidator())
            return "validated:\\(validaInput)"
    }     

然后我们输入URL：http://localhost:8080/[email protected]，然后就会的到：

Validated: [email protected]

其余自带校验工具

校验类	功能	用法
Unique	输入内容是否唯一	someCharacter.tested(by: Unique())
Compare	输入内容的数值比较	int.tested(by:Compare.greaterThan(1))
Contains	输入的内容是否包含某个	someArray.tested(by: Contains("1"))
Count	输入的内容个数	someArray.tested(by: Count.max(2))
Equals	输入的内容是否相同	someConent.tested(by: Equals.init("equal"))
In	输入内容是否被包含	input.tested(by: In.init(["1","2","3"]))

创建自己的校验工具

通过参考工具自带的Equals.Swift：

/// Validates that matches a given input
public struct Equals: Validator where T: Validatable, T: Equatable {
    /// The value expected to be in sequence
    public let expectation: T

    /// Initialize a validator with the expected value
    public init(_ expectation: T) {
        self.expectation = expectation
    }

    public func validate(_ input: T) throws {
        guard input == expectation else {
            throw error("\\(input) does not equal expectation \\(expectation)")
        }
    }
}

从这里面我们可以看出，只要遵守Validator协议，并且实现其validate方法即可。

参考文件：
https://github.com/vapor/validation/blob/master/Tests/ValidationTests/ValidationConvenienceTests.swift