使用JWT做RESTful API的身份验证-Go语言实现

简介: 在 使用Golang和MongoDB构建 RESTful API已经实现了一个简单的 RESTful API应用,但是对于有些API接口需要授权之后才能访问,在这篇文章中就用 jwt 做一个基于Token的身份验证,关于 jwt 请访问 JWT有详细的说明,而且有各个语言实现的库,请根据需要使用对应的版本。

在 使用Golang和MongoDB构建 RESTful API已经实现了一个简单的 RESTful API应用,但是对于有些API接口需要授权之后才能访问,在这篇文章中就用 jwt 做一个基于Token的身份验证,关于 jwt 请访问 JWT有详细的说明,而且有各个语言实现的库,请根据需要使用对应的版本。

需要先安装 jwt-go 接口 go get github.com/dgrijalva/jwt-go
新增注册登录接口,并在登录时生成token

自定义返回结果,并封装 helper/utils.go

1type Response struct {
 2    Code int         `json:"code"`
 3    Msg  string      `json:"msg"`
 4    Data interface{} `json:"data"`
 5}
 6
 7func ResponseWithJson(w http.ResponseWriter, code int, payload interface{}) {
 8    response, _ := json.Marshal(payload)
 9    w.Header().Set("Content-Type", "application/json")
10    w.WriteHeader(code)
11    w.Write(response)
12}

模型 models/user.go

1type User struct {
2    UserName string `bson:"username" json:"username"`
3    Password string `bson:"password" json:"password"`
4}type JwtToken struct {
5    Token string `json:"token"`
6}

控制器 controllers/user.go

1func Register(w http.ResponseWriter, r *http.Request) {
 2    var user models.User
 3    err := json.NewDecoder(r.Body).Decode(&user)    if err != nil || user.UserName == "" || user.Password == "" {
 4        helper.ResponseWithJson(w, http.StatusBadRequest,
 5            helper.Response{Code: http.StatusBadRequest, Msg: "bad params"})        return
 6    }
 7    err = models.Insert(db, collection, user)   if err != nil {
 8        helper.ResponseWithJson(w, http.StatusInternalServerError,
 9            helper.Response{Code: http.StatusInternalServerError, Msg: "internal error"})
10    }
11}
12
13func Login(w http.ResponseWriter, r *http.Request) {
14    var user models.User
15    err := json.NewDecoder(r.Body).Decode(&user)    if err != nil {
16        helper.ResponseWithJson(w, http.StatusBadRequest,
17            helper.Response{Code: http.StatusBadRequest, Msg: "bad params"})
18    }
19    exist := models.IsExist(db, collection, bson.M{"username": user.UserName})  if exist {
20        token, _ := auth.GenerateToken(&user)
21        helper.ResponseWithJson(w, http.StatusOK,
22            helper.Response{Code: http.StatusOK, Data: models.JwtToken{Token: token}})
23    } else {
24        helper.ResponseWithJson(w, http.StatusNotFound,
25            helper.Response{Code: http.StatusNotFound, Msg: "the user not exist"})
26    }
27}

生成Token auth/middleware.go

1func GenerateToken(user *models.User) (string, error) {
2    token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{       "username": user.UserName,
3    //"exp":      time.Now().Add(time.Hour * 2).Unix(),// 可以添加过期时间
4    })  return token.SignedString([]byte("secret"))//对应的字符串请自行生成,最后足够使用加密后的字符串
5}

http中间件
go http的中间件实现起来很简单,只需要实现一个函数签名func(http.Handler) http.Handler的函数即可。

1func middlewareHandler(next http.Handler) http.Handler{    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request){
2        // 执行handler之前的逻辑
3        next.ServeHTTP(w, r)
4        // 执行完毕handler后的逻辑
5    })
6}

我们使用的 mux 作为路由,本身支持在路由中添加中间件,改造一下之前的路由逻辑
routes/routes.go

1type Route struct {
2    Method     string
3    Pattern    string
4    Handler    http.HandlerFunc
5    Middleware mux.MiddlewareFunc //添加中间件
6}
7
8func NewRouter() *mux.Router {
9    router := mux.NewRouter()   for _, route := range routes {
10        r := router.Methods(route.Method).
11            Path(route.Pattern)
12    //如果这个路由有中间件的逻辑,需要通过中间件先处理一下        if route.Middleware != nil {
13            r.Handler(route.Middleware(route.Handler))
14        } else {
15            r.Handler(route.Handler)
16        }
17    }   return router
18}

实现身份验证的中间件
auth/middleware.go
验证的信息放在http Header中

1func TokenMiddleware(next http.Handler) http.Handler {    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 2        tokenStr := r.Header.Get("authorization")       if tokenStr == "" {
 3            helper.ResponseWithJson(w, http.StatusUnauthorized,
 4                helper.Response{Code: http.StatusUnauthorized, Msg: "not authorized"})
 5        } else {
 6            token, _ := jwt.Parse(tokenStr, func(token *jwt.Token) (interface{}, error) {               if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
 7                    helper.ResponseWithJson(w, http.StatusUnauthorized,
 8                        helper.Response{Code: http.StatusUnauthorized, Msg: "not authorized"})                  return nil, fmt.Errorf("not authorization")
 9                }               return []byte("secret"), nil
10            })          if !token.Valid {
11                helper.ResponseWithJson(w, http.StatusUnauthorized,
12                    helper.Response{Code: http.StatusUnauthorized, Msg: "not authorized"})
13            } else {
14                next.ServeHTTP(w, r)
15            }
16        }
17    })
18}

对需要验证的路由添加中间件

1register("GET", "/movies", controllers.AllMovies, auth.TokenMiddleware) //需要中间件逻辑
2register("GET", "/movies/{id}", controllers.FindMovie, nil)//不需要中间件复制代码

验证
登录之后,返回对应的token信息

1//请求 post http://127.0.0.1:8080/login
2//返回
3
4{    "code": 200,    "msg": "",    "data": {        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImNvZGVybWluZXIifQ.pFzJLU8vnzWiweFKzHRsawyWA2jfuDIPlDU4zE92O7c"
5    }
6}

获取所有的电影信息时

1//请求 post http://127.0.0.1:8080/movies
2在 Header中设置 "authorization":token
3如果没有设置header会报 401 错误
4
5{    "code": 401,    "msg": "not authorized",    "data": null
6}

源码 Github

原文发布时间为:2018-07-19
本文作者:CoderMiner
本文来自云栖社区合作伙伴“Golang语言社区”,了解相关信息可以关注“Golang语言社区

相关文章
|
8月前
|
XML JSON API
识别这些API接口定义(http,https,api,RPC,webservice,Restful api ,OpenAPI)
本内容介绍了API相关的术语分类,包括传输协议(HTTP/HTTPS)、接口风格(RESTful、WebService、RPC)及开放程度(API、OpenAPI),帮助理解各类API的特点与应用场景。
|
10月前
|
缓存 安全 API
RESTful与GraphQL:电商API接口设计的技术细节与适用场景
本文对比了RESTful与GraphQL这两种主流电商API接口设计方案。RESTful通过资源与HTTP方法定义操作,简单直观但可能引发过度或欠获取数据问题;GraphQL允许客户端精确指定所需字段,提高灵活性和传输效率,但面临深度查询攻击等安全挑战。从性能、灵活性、安全性及适用场景多维度分析,RESTful适合资源导向场景,GraphQL则适用于复杂数据需求。实际开发中需根据业务特点选择合适方案,或结合两者优势,以优化用户体验与系统性能。
|
6月前
|
人工智能 自然语言处理 测试技术
Apipost智能搜索:只需用业务语言描述需求,就能精准定位目标接口,API 搜索的下一代形态!
在大型项目中,API 数量庞大、命名不一,导致“找接口”耗时费力。传统工具依赖关键词搜索,难以应对语义模糊或命名不规范的场景。Apipost AI 智能搜索功能,支持自然语言查询,如“和用户登录有关的接口”,系统可理解语义并精准匹配目标接口。无论是新人上手、模糊查找还是批量定位,都能大幅提升检索效率,降低协作成本。从关键词到语义理解,智能搜索让开发者少花时间找接口,多专注核心开发,真正实现高效协作。
|
10月前
|
JSON 编解码 API
Go语言网络编程:使用 net/http 构建 RESTful API
本章介绍如何使用 Go 语言的 `net/http` 标准库构建 RESTful API。内容涵盖 RESTful API 的基本概念及规范,包括 GET、POST、PUT 和 DELETE 方法的实现。通过定义用户数据结构和模拟数据库,逐步实现获取用户列表、创建用户、更新用户、删除用户的 HTTP 路由处理函数。同时提供辅助函数用于路径参数解析,并展示如何设置路由器启动服务。最后通过 curl 或 Postman 测试接口功能。章节总结了路由分发、JSON 编解码、方法区分、并发安全管理和路径参数解析等关键点,为更复杂需求推荐第三方框架如 Gin、Echo 和 Chi。
|
9月前
|
缓存 边缘计算 前端开发
从业务需求到技术栈:电商API选型RESTful还是GraphQL?这5个维度帮你决策
在数字经济时代,电商平台的竞争已延伸至用户体验与系统效能。作为连接前后端及各类服务的核心,API接口的架构设计至关重要。本文对比RESTful与GraphQL两大主流方案,从电商场景出发,分析两者的技术特性、适用场景与选型逻辑,帮助开发者根据业务需求做出最优选择。
|
9月前
|
JSON JavaScript 前端开发
Python+JAVA+PHP语言,苏宁商品详情API
调用苏宁商品详情API,可通过HTTP/HTTPS发送请求并解析响应数据,支持多种编程语言,如JavaScript、Java、PHP、C#、Ruby等。核心步骤包括构造请求URL、发送GET/POST请求及解析JSON/XML响应。不同语言示例展示了如何获取商品名称与价格等信息,实际使用时请参考苏宁开放平台最新文档以确保兼容性。
|
XML JSON API
Understanding RESTful API and Web Services: Key Differences and Use Cases
在现代软件开发中,RESTful API和Web服务均用于实现系统间通信,但各有特点。RESTful API遵循REST原则,主要使用HTTP/HTTPS协议,数据格式多为JSON或XML,适用于无状态通信;而Web服务包括SOAP和REST,常用于基于网络的API,采用标准化方法如WSDL或OpenAPI。理解两者区别有助于选择适合应用需求的解决方案,构建高效、可扩展的应用程序。
|
机器学习/深度学习 设计模式 API
Python 高级编程与实战:构建 RESTful API
本文深入探讨了使用 Python 构建 RESTful API 的方法,涵盖 Flask、Django REST Framework 和 FastAPI 三个主流框架。通过实战项目示例,详细讲解了如何处理 GET、POST 请求,并返回相应数据。学习这些技术将帮助你掌握构建高效、可靠的 Web API。
|
6月前
|
存储 安全 Java
【Golang】(4)Go里面的指针如何?函数与方法怎么不一样?带你了解Go不同于其他高级语言的语法
结构体可以存储一组不同类型的数据,是一种符合类型。Go抛弃了类与继承,同时也抛弃了构造方法,刻意弱化了面向对象的功能,Go并非是一个传统OOP的语言,但是Go依旧有着OOP的影子,通过结构体和方法也可以模拟出一个类。
336 2
|
8月前
|
Cloud Native 安全 Java
Go:为云原生而生的高效语言
Go:为云原生而生的高效语言
513 1