Vapor文档学习十五:ROUTING - Route Parameters

传统的Web框架通常都是使用字符串作为路由参数名称和参数类型,这就为路由出错埋下了隐患。 Vapor利用Swift闭包,提供了更加安全、更加直观的访问路由参数的方法。

Type Safe

创建一个类型安全的路由,只需要使用Type来替换路径中的一部分:

drop.get("users", Int.self) { request, userId in
    return "You requested User #\(userId)"
}

上面创建了一个匹配users/:id的路由,:idInt类型下面。作为对比,下面来演示如何手动判断路由参数的写法:

drop.get("users", ":id") { request in
  guard let userId = request.parameters["id"]?.int else {
    throw Abort.badRequest
  }

  return "You requested User #\(userId)"
}

我们看到类型安全的路由不仅少了3行代码,还可以避免发生运行时的错误(比如:id拼写错误)。

String Initializable

所有遵守StringInitializable协议的类型都可以作为类型安全路由的参数,默认包含以下类型:

  • String
  • Int
  • Model

String是最常用的,并且总是可以匹配的。Int只会匹配可以转换为整数的字符串,Model只会匹配通过字符串标识可以在数据库查到的模型。
之前的示例可以更加简化:

drop.get("users", User.self) { request, user in
  return "You requested \(user.name)"
}

这里提供的标识符会被用于自动查找用户。比如请求了/users/5User模型会自动查找标识为5的user,如果查找到了则请求成功,并且执行闭包,否则会抛出为查找到用户的异常。

下面是model没有遵守StringInitializable协议的情况下的写法:

drop.get("users", Int.self) { request, userId in
  guard let user = try User.find(userId) else {
    throw Abort.notFound
  }

    return "You requested User #\(userId)"
}

类型安全的路由总共可以为每一个路由减少6行代码。

Protocol

自定义类型遵守StringInitializable十分简单:

// StringInitializable的定义
public protocol StringInitializable {
    init?(from string: String) throws
}

Model类实现协议方法:

extension Model {
    public init?(from string: String) throws {
        if let model = try Self.find(string) {
            self = model
        } else {
            return nil
        }
    }
}

init既可以返回nil,也可以抛出异常。这样你可以抛出自定义的异常,也可以通过返回nil使用默认的方法处理异常。

Limits

目前类型安全的路由限制只能有三个参数,可以通过使用group来解决这个问题。

drop.group("v1", "users") { users in
  users.get(User.self, "posts", Post.self) { request, user, post in
    return "Requested \(post.name) for \(user.name)"
  }
}

上面是处理/v1/users/:userId/posts/:postId路由请求的结果。如果你呼吁增加更多类型安全路由,我们可以考虑将限制数提高一些。

Manual

综上所述,你依然可以使用传统的路由(非类型安全的路由)来处理特别复杂的情况。

drop.get("v1", "users", ":userId", "posts", ":postId", "comments", ":commentId") { request in
  let userId = try request.parameters.extract("userId") as Int
  let postId = try request.parameters.extract("postId") as Int
  let commentId = try request.parameters.extract("commentId") as Int

  return "You requested comment #\(commentId) for post #\(postId) for user #\(userId)"
}

request.parameters属性用来提取URI path编码的参数(比如/v1/users/1具有参数:userId,等于"1")。参数作为查询的一部分进行传递的情况下(e.g. /v1/search-user?userId=1),应该使用request.data(e.g. let userId = request.data["userId"]?.string)。

除了返回可选值外,请求参数可以作为字典来访问,也可以使用extract语法访问。

Groups

手动使用参数也适用于group

let userGroup = drop.grouped("users", ":userId")
userGroup.get("messages") { req in
    let user = try req.parameters.extract("userId") as User
}

总结:本章主要介绍了路由参数设置的方法,类型安全的路由可以极大的简化我们的代码,但是具有最多3个参数的限制。通过使用group可以解决这个问题。处理复杂的情况下,我们依然可以使用普通的路由模式。

你可能感兴趣的:(Vapor文档学习十五:ROUTING - Route Parameters)