Gin+JWT+Air热部署的简单实践
这是我参与「第三届青训营 -后端场」笔记创作活动的的第2篇笔记。
- Gin+JWT的Demo
- 尝试使用Air实现热部署 最近在字节后端青训营的学习中,初步体验了Gin框架,并打算结合JWT和Air实践一下。
参考教程:
什么是JWT
首先要知道JWT是什么,JSON Web Token(JWT)
是一个常用语HTTP的客户端和服务端间进行身份认证和鉴权的标准规范,使用JWT可以允许我们在用户和服务器之间传递安全可靠的信息。
token的意思是“令牌”,是用户身份的验证方式,最简单的token组成:
uid(用户唯一标识)
+time(当前时间戳)
+sign(签名,由token的前几位+盐以哈希算法压缩成一定长度的十六进制字符串)
,同时还可以将不变的参数也放进token。
JWT Token组成部分:
- header: 用来指定使用的算法(HMAC SHA256 RSA)和token类型(如JWT)
- payload: 包含声明(要求),声明通常是用户信息或其他数据的声明,比如用户id,名称,邮箱等. 声明可分为三种: registered,public,private
- signature: 用来保证JWT的真实性,可以使用不同的算法
记录使用Air遇到的坑
这真是一个大坑。在输入air init
命令,生成.air.toml
文件之后,将生成的.air.toml
文件内容替换如下:
# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件
# 工作目录
# 使用 . 或绝对路径,请注意 `tmp_dir` 目录必须在 `root` 目录下
root = "."
tmp_dir = "tmp"
[build]
# 只需要写你平常编译使用的shell命令。你也可以使用 `make`
# Windows平台示例: cmd = "go build -o tmp\main.exe ."
cmd = "go build -o ./tmp/main ."
# 由`cmd`命令得到的二进制文件名
# Windows平台示例:bin = "tmp\main.exe"
bin = "tmp/main"
# 自定义执行程序的命令,可以添加额外的编译标识例如添加 GIN_MODE=release
# Windows平台示例:full_bin = "tmp\main.exe"
full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
# 监听以下文件扩展名的文件.
include_ext = ["go", "tpl", "tmpl", "html"]
# 忽略这些文件扩展名或目录
exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
# 监听以下指定目录的文件
include_dir = []
# 排除以下文件
exclude_file = []
# 如果文件更改过于频繁,则没有必要在每次更改时都触发构建。可以设置触发构建的延迟时间
delay = 1000 # ms
# 发生构建错误时,停止运行旧的二进制文件。
stop_on_error = true
# air的日志文件名,该日志文件放置在你的`tmp_dir`中
log = "air_errors.log"
[log]
# 显示日志时间
time = true
[color]
# 自定义每个部分显示的颜色。如果找不到颜色,使用原始的应用程序日志。
main = "magenta"
watcher = "cyan"
build = "yellow"
runner = "green"
[misc]
# 退出时删除tmp目录
clean_on_exit = true
之所以没有按照上面教程所说,手动创建
.air.conf
文件,是因为手动创建的.air.conf
文件会变成Read Only
,后续无法修改,非常麻烦。所以我们根据github官方的推荐,使用air init
命令,生成.air.toml
文件。
上述文件是李文周老师博客提供了一些汉化注释,大体还是github官方的air_example.toml
文件(github.com/cosmtrek/ai…)。就是这个官方文件,让我踩了一个大坑。
注意看,上述.air.toml
文件和官方的air_example.toml
文件中,通过go build生成可执行文件时,是将其命名为main
而不是main.exe
,这就导致后续无论怎么启动air
,都会报错:找不到/tmp/main.exe
,因为我们生成的是tmp.main
文件。
所以我们要将.air.toml
文件修改如下:
# [Air](https://github.com/cosmtrek/air) TOML 格式的配置文件
# 工作目录
# 使用 . 或绝对路径,请注意 `tmp_dir` 目录必须在 `root` 目录下
root = "."
tmp_dir = "tmp"
[build]
# 只需要写你平常编译使用的shell命令。你也可以使用 `make`
# Windows平台示例: cmd = "go build -o tmp\main.exe ."
cmd = "go build -o ./tmp/main.exe ."
# 由`cmd`命令得到的二进制文件名
# Windows平台示例:bin = "tmp\main.exe"
bin = "tmp/main"
# 自定义执行程序的命令,可以添加额外的编译标识例如添加 GIN_MODE=release
# Windows平台示例:full_bin = "tmp\main.exe"
#full_bin = "APP_ENV=dev APP_USER=air ./tmp/main"
full_bin = "./tmp/main"
# 监听以下文件扩展名的文件.
include_ext = ["go", "tpl", "tmpl", "html"]
# 忽略这些文件扩展名或目录
exclude_dir = ["assets", "tmp", "vendor", "frontend/node_modules"]
# 监听以下指定目录的文件
include_dir = []
# 排除以下文件
exclude_file = []
# 如果文件更改过于频繁,则没有必要在每次更改时都触发构建。可以设置触发构建的延迟时间
delay = 1000 # ms
# 发生构建错误时,停止运行旧的二进制文件。
stop_on_error = true
# air的日志文件名,该日志文件放置在你的`tmp_dir`中
log = "air_errors.log"
[log]
# 显示日志时间
time = true
[color]
# 自定义每个部分显示的颜色。如果找不到颜色,使用原始的应用程序日志。
main = "magenta"
watcher = "cyan"
build = "yellow"
runner = "green"
[misc]
# 退出时删除tmp目录
clean_on_exit = true
这样一来,我们直接在控制台输入air
,就可以启动Air实现热部署了。
Tips:修改完代码后
Ctrl+S
,会立马重新部署。但是自动等待一会等AIr检测到更新了,也会重新部署的。
要想停止Air,直接在控制台Ctrl+C
即可。
最后好像还是有个bug,就是
Ctrl+C
之后tmp文件夹并不能成功删掉,后续需要的话要手动删除。
JWT的实践
在代码都编写完成后,可以进行测试了。
首先登录,localhost:8080/api/user/login
,这样就得到token了:
先不在header中携带token,看看能否跑通localhost:8080/api/test/ga1
:
可以发现不携带token是无法访问的,说明我们的JWTAuth()中间件是生效的。
最后在header中携带token:
心得
在学习的过程在还是必须要手写代码,这样不仅能加大学习效率,更可以很明确开发过程,到后面就越写越快了。
还有就是,遇到bug了不能只参考那一篇博客,要善于使用搜索引擎,特别是去GitHub上看README,源码或者Issues。