webkit是用于快捷生成web项目的小工具，集成了一些常见功能，如：平滑关闭、日志切分、参数校验等；
如果要对此项目的模板进行修改、添加功能，template文件夹下改动后，执行以下命令重新生成模板的静态文件
statik -src=./template -dest=./ -f
- 安装
go install github.com/hanluolin/webkit@latest- 使用
在指定路径下生成模板项目
webkit
#> webkit v1.0.7
#> 请输入项目名称（默认'test_webkit'）：
#> 请输入项目路径（默认'./'）：
#> 请选择数据库（pg、dm 默认pg）：版本>=v1.0.7才有此选项在生成的项目中直接内置了一些常见功能
main.go
...
// 带有平滑退出的超时控制
ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second)
defer cancel()
// 关闭 HTTP 服务器
if err := server.Shutdown(ctx); err != nil {
zap.S().Fatal("Server shutdown:", err)
}
zap.S().Info("Server exited")
...- 初始化
main.go
...
// logger.DefaultLog() 默认只输出到终端，debug级别
logger.Init(logger.DefaultLog())
defer logger.Sync()
...可以根据需要调整配置项
kit/logger/logger.go
type Option struct {
Path string // 日志文件路径
Level string // 日志级别，debug info warn error panic fatal
MaxSize int // 文件多大开始切分
MaxBackups int // 保留文件个数
MaxAge int // 文件保存多少天，maxBackups和maxAge都设置为0，则不会删除任何日志文件，全部保留
Json bool // 是否用json格式
Std bool // 是否输出到控制台
}- 初始化
main.go
...
config.InitByEnv() // 从环境变量加载配置
// config.InitByFile("config.yaml") // 从配置文件加载配置（viper库），支持yaml、json、toml等多种格式
...集成了validator库
- 初始化
main.go
if err := validator.Init(); err != nil {
zap.S().Fatal(err)
}- 使用
在参数字段上写tag即可，更多tag参考validator库
type TestValidatorReq struct {
Name string `json:"name" binding:"required,min=3,max=50"`
Email string `json:"email" binding:"required,email" errMsg:"自定义错误信息:邮箱错误咯"`
Password string `json:"password" binding:"required,min=6"`
}- 集成了中文翻译器
{
"code": 400001,
"message": "参数错误, name长度必须至少为3个字符",
"data": null
}
- 自定义字段名
// tag中加入 name="xxx"
type TestValidatorReq struct {
Password string `json:"password" binding:"required,min=3,max=50" name="密码"`
}
// 若该字段校验失败，响应的message会将字段"password"替换为"密码"
{
"code": 400001,
"message": "参数错误, 密码长度必须至少为3个字符",
"data": null
}- 自定义错误信息
// tag中加入 errMsg="xxx"
type TestValidatorReq struct {
Email string `json:"email" binding:"required,email" errMsg:"自定义错误信息-邮箱错误咯"`
}
// 若该字段校验失败，响应的message会替换为自定义的errMsg
{
"code": 400001,
"message": "参数错误, 自定义错误信息-邮箱错误咯",
"data": null
}- 结合了zap，gorm日志将由zap代理
- 错误处理，controller层使用Fail方法进行响应时，Fail方法内对gorm的err做了处理，避免返回数据库的详细错误信息，而是将错误信息打到log
data, err := service.HelloSvc.SayHi()
if err != nil {
Fail(ctx, enum.FailedGetData, err)
return
}- 集成go-redis
- aop封装，以aop方式加入缓存切面
- Cacheable：执行回调函数前会查询缓存，若key不存在则执行回调，将回调执行结果放入缓存，若key存在，将数据映射到参数v(应传入指针)且不执行回调函数
- Put：执行回调函数后，将回调执行结果放入缓存，与Cacheable不同的是Put不会进行前置查询，常用于更新操作
- Evict：执行回调函数后，删除该key的缓存
- Put和Evict有以ByDynamicKey为后缀的扩展，可通过回调函数的返回值来设定key
- 示例：kit/cache/redis_aop_test.go
kit/cache/redis_aop_test.go
func TestCacheable(t *testing.T) {
type User struct {
ID int `json:"id"`
Name string `json:"name"`
Money float64 `json:"money"`
OK bool `json:"ok"`
}
// 初始化
Init(&redis.Options{Addr: "127.0.0.1:6379"})
ctx := context.Background()
var user User
// 若key不存在，回调函数执行，并将结果放入缓存，下次再执行key已存在，不执行回调，而是将数据映射到user指针
if err := Cacheable(ctx, "test", &user, func() (data interface{}, err error) {
log.Println("数据库查询等操作，执行了...")
return User{
ID: 1,
Name: "test",
}, nil
}, time.Minute*10); err != nil {
log.Fatal(err)
}
log.Println("res", user)
}-
ordermap.go 支持序列化、反序列化的有序map
-
util.CallApi 接口调用
- 普通调接口
var ( req = map[string]interface{}{"name": "lorin"} // 定义接口参数 resp param.TestResp // 定义接口响应 ) if err = util.CallApi("http://127.0.0.1/api/v1/xxx", "POST", 10*time.Second, &req, &uploadResp); err != nil { return fmt.Errorf("API调用错误: %v", err) } fmt.Println(resp)
- 传文件
fileBytes, err := os.ReadFile("/xx/xx.docx") if err != nil { return err } fileHeader := &util.CustomFileHeader{ FileBytes: fileBytes, Filename: info.Name(), Size: info.Size(), } // 上传文件 var uploadResp param.FileUploadResp // 定义接口响应 if err = util.CallApi("http://127.0.0.1/api/v1/upload", "POST", 120*time.Second, fileHeader, &uploadResp); err != nil { return fmt.Errorf("文件上传失败: %v", err) } fmt.Println(uploadResp)