Vapor文档学习九:Validation

Vapor提供了几种不同的方法验证发送到应用的数据。让我们从最常见的方法开始。

Common Usage

默认包含了几种便捷实用的validator,你可以使用它们来验证发送到应用的数据,也可以将他们组合使用,或者使用自定义的验证方法。

最常见的验证数据的方法:

class Employee {
    var email: Valid<Email>
    var name: Valid<Name>

    init(request: Request) throws {
        name = try request.data["name"].validated()
        email = try request.data["email"].validated()
    }
}

这是一个典型的Employee模型,具有emailname属性。 通过将这两个属性声明为Valid<>类型,来确保这些属性只能包含有效的数据。 Swift类型检查系统将阻止任何未通过验证的数据被存储。

存储的Valid<>类型的属性,必须调用validated()方法,这样就可以通过 request.data返回的数据进行访问了。

Email是Vapor中包含的validator,但是Name不是。我们来看看如何创建validator

Valid<OnlyAlphanumeric>
Valid<Email>
Valid<Unique<T>>
Valid<Matches<T>>
Valid<In<T>>
Valid<Contains<T>>
Valid<Count<T>>

Validators vs. ValidationSuites

validators可以有多个配置,例如CountContains

let name: Valid<Count<String>> = try "Vapor".validated(by: Count.max(5))

上面是的代码用来验证一个字符串最多不超过5个字符,但是Valid<Count>只能验证固定数值,并不能准确的告诉我们字符串的具体长度。这个被验证的字符串长度可能小于3,也可能超过100万。
因此,Validator并不是像程序所希望的那样安全。ValidationSuite就是用来补充这个缺点的。将多个ValidatorValidationSuites组合在一起,来准确的判断什么样的数据需要被验证。

Custom Validator

这是一个创建ValidationSuite的例子:

class Name: ValidationSuite {
    static func validate(input value: String) throws {
        let evaluation = OnlyAlphanumeric.self
            && Count.min(5)
            && Count.max(20)

        try evaluation.validate(input: value)
    }
}

自定义Validator,只需要创建一个方法,使用其他validator或者逻辑来实现自定义验证的逻辑。上面我们创建了一个Name验证器,只通过由字母和数字组成的字符串,并且字符长度为5~20。

Combining Validator

在上面的Name验证器中,我们使用&&连接了validator,同样的也可以使用||。(“且”和“或”的逻辑)
也可以使用!对验证器取反。(“非”的逻辑)

let symbols = input.validated(by: !OnlyAlphanumeric.self)

Testing Validity

validated() throw是最常用的进行验证的方法,此外还有两个方法:

let passed = input.passes(Count.min(5))
let valid = try input.tested(Count.min(5))

passes()返回一个Bool类型,表示验证是否通过。tested()表示是否是否通过验证,如果未通过验证的话则会抛出异常。
validated()不同的是,validated()返回的是Valid<>类型,而tested()返回的是被验证数据的原始类型。

Validation Failures

Vapor会在ValidationMiddleware中自动捕获验证失败的信息。你也可以自己捕获失败信息,或者为特定的验证失败情况自定义response

do {
    //validation here
} catch let error as ValidationErrorProtocol {
    print(error.message)
}

<b>总结:</b>Validate提供了数据验证的方法,我们可以使用ValidationSuite进行组合已满足我们自定义的需求。
passes()tested()是区别于validated()的验证方式,返回值不同可以方便我们进行不同的操作。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容