如何在Akka HTTP中封装身份验证路由并返回自定义上下文类

结论 #

Akka HTTP 没有内置同时支持从请求头、查询参数读取令牌并完成身份校验的directive，你可以通过组合现有内置directive快速实现自定义的认证逻辑，完全符合你的需求：优先读请求头令牌，不存在时自动降级读取查询字符串的authToken参数，校验完成后直接返回你自定义的AuthenticatedContext上下文。

实现示例 #

首先定义业务模型：

case class User(id: Long, username: String)
case class AuthenticatedContext(authToken: String, user: User)

自定义authenticateToken directive：

import akka.http.scaladsl.server.Directives._
import akka.http.scaladsl.server.Rejection
import akka.http.scaladsl.model.StatusCodes._

// 自定义认证失败拒绝类型，也可直接使用框架内置的AuthenticationFailedRejection
case object InvalidTokenRejection extends Rejection

val authenticateToken = {
  // 核心逻辑：优先匹配请求头令牌，匹配失败自动降级匹配查询参数令牌
  val extractToken = headerValueByName("MyApp-Token") | parameter("authToken")
  
  extractToken.flatMap { token =>
    // 替换为实际的数据库查询逻辑，通过令牌查询对应的用户信息
    val authenticatedContext = queryUserByToken(token)
    authenticatedContext match {
      case Some(context) => provide(context)
      case None => reject(InvalidTokenRejection)
    }
  }.handleRejections(
    RejectionHandler.newBuilder()
      .handle { case InvalidTokenRejection => complete(Unauthorized, "无效或缺失的访问令牌") }
      .result()
  )
}

// 模拟数据库查询方法，实际开发替换为真实DAO调用
// 如果是异步查询，可将flatMap替换为flatMapAsync适配Future返回值
def queryUserByToken(token: String): Option[AuthenticatedContext] = {
  if (token == "abc123") Some(AuthenticatedContext(token, User(1, "test_user")))
  else None
}

使用方式 #

和你期望的用法完全一致：

val secureRoutes =
  authenticateToken { authenticatedContext =>
    path("v1" / "board") {
      get {
        complete(s"board#index route ${authenticatedContext.user.username}")
      }
    }
  }

补充说明 #

• 可根据实际需求修改headerValueByName的参数调整请求头的键名，比如替换为x-authToken
• 如果需要区分令牌缺失、令牌无效等不同错误场景，可以拆分自定义拒绝类型实现更细的错误提示
• 若令牌校验逻辑涉及异步IO（如异步数据库查询、远程调用鉴权服务），仅需要将flatMap替换为flatMapAsync即可适配Future类型的返回值

内容的提问来源于stack exchange，提问作者Blankman