JWT

概述

在 go-zero 中，我们通过 api 语言来声明 HTTP 服务，然后通过 goctl 生成 HTTP 服务代码，在之前我们系统性的介绍了 API 规范。

在 HTTP 服务开发中，服务认证也是经常会用到的一个功能，本文档将介绍如何在 api 文件中声明中间件。

JWT

JWT（JSON Web Token）是一种开放标准（RFC 7519），用于在网络应用间传递声明式信息。它是一种基于JSON的轻量级的身份验证和授权机制，用于在客户端和服务器之间安全地传输信息。

更多关于 jwt 的文档请参考

  1. 《JSON Web Tokens》
  2. 《JWT 认证》

我们来看一下在 api 文件中如何声明开启 jwt 认证

  1. syntax = "v1"
  3. type LoginReq {
  4.     Username string `json:"username"`
  5.     Password string `json:"password"`
  6. }
  8. type LoginResp {
  9.     ID string `json:"id"`
  10.     Name string `json:"name"`
  11. }
  13. type UserInfoReq {
  14.     ID string `json:"id"`
  15. }
  17. type UserInfoResp {
  18.     Name string `json:"name"`
  19. }
  21. service user-api {
  22.     @handler login
  23.     post /user/login (LoginReq) returns (LoginResp)
  24. }
  26. @server (
  27.     jwt: Auth // 开启 jwt 认证
  28. )
  29. service user-api {
  30.     @handler userInfo
  31.     post /user/info (UserInfoReq) returns (UserInfoResp)
  32. }

在上文中，我们通过在 @server 中来通过 jwt 关键字声明了开启 jwt 认证，且该 jwt 认证仅对其对应的路由有用，如上文中 jwt 仅对 /user/info 生效，对 /user/login 是不生效的，我们使用 Auth 来作为 jwt 的值，其在经过 goctl 进行代码生成后会转成 对应 jwt 配置。

下面简单看一下生成的 jwt 代码：

  • config.go
  • routes.go
  1. package config
  3. import "github.com/zeromicro/go-zero/rest"
  5. type Config struct {
  6.     rest.RestConf
  7.     Auth struct {// JWT 认证需要的密钥和过期时间配置
  8.         AccessSecret string
  9.         AccessExpire int64
  10.     }
  11. }

Config 结构体中的 Auth 字段就是我们通过在 api 语法文件中声明的值，这是代码生成后的结果。

  1. // Code generated by goctl. DO NOT EDIT.
  2. package handler
  4. import (
  5.     "net/http"
  7.     "go-zero-demo/user/internal/svc"
  9.     "github.com/zeromicro/go-zero/rest"
  10. )
  12. func RegisterHandlers(server *rest.Server, serverCtx *svc.ServiceContext) {
  13.     server.AddRoutes(
  14.         []rest.Route{
  15.             {
  16.                 Method:  http.MethodPost,
  17.                 Path:    "/user/login",
  18.                 Handler: loginHandler(serverCtx),
  19.             },
  20.         },
  21.     )
  23.     server.AddRoutes(
  24.         []rest.Route{
  25.             {
  26.                 Method:  http.MethodPost,
  27.                 Path:    "/user/info",
  28.                 Handler: userInfoHandler(serverCtx),
  29.             },
  30.         },
  31.         rest.WithJwt(serverCtx.Config.Auth.AccessSecret),
  32.     )
  33. }

在上文中，我们可以看到，我们声明的 jwt 其实在生成代码后通过 rest.WithJwt 来声明进行 jwt 认证了。

JWT - 图1注意

代码生成后的 jwt 认证，框架只做了服务端逻辑，对于 jwt token 的生成及 refresh token 仍需要开发者自行实现。