easy-gin

gin使用封装,简单易用,方便在项目中集成应用

1. 集成easy-logrus
2. 集成swagger
3. 配置方便
4. 更多功能计划后续集成，以方便使用（常用web开发：orm, redis, mongodb, jwt, auth2等）

在线预览地址

easy-gin-demo

使用介绍

package main

import (
	"fmt"
	"os"
	"os/signal"
	"syscall"

	easygin "github.com/ajdwfnhaps/easy-gin"
	mw "github.com/ajdwfnhaps/easy-gin/middleware"
	"github.com/ajdwfnhaps/easy-gin/sample/routers/api"
)

func main() {

	//创建应用程序 使用配置文件
	//r := easygin.New("conf/config.toml")
	r := easygin.Default("conf/config.toml")

	//使用跨域请求中间件
	r.UseCors()

	//使用logrus日志组件
	//指定api路径规则才记录日志
	apiPrefixes := []string{"/api/"}
	r.UseLogrusConf(mw.AllowPathPrefixNoSkipper(apiPrefixes...))

	//注册路由
	r.RegisterRouter(api.RouterHanlder)

	//使用swagger
	r.UseSwagger(SetSwaggerInfo)

	//使用静态站点中间件
	r.UseWWWRoot()

	//启动
	r.Run()

	//处理退出信号
	handleSignal()
}

func handleSignal() {
	c := make(chan os.Signal)
	signal.Notify(c, syscall.SIGHUP, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
	select {
	case <-c:
		fmt.Println("服务退出")
	}
}

RouterHanlder 方法

//RouterHanlder 定义所有api路由
func RouterHanlder(app *gin.Engine) error {

	g := app.Group("/api")

	v1 := g.Group("/v1")
	{
		// 注册/api/v1/demos
		gDemo := v1.Group("demos")
		{
			cDemo := NewDemoController()
			// gDemo.GET("", cDemo.Query)
			gDemo.GET(":id", cDemo.Get)
			gDemo.POST("", cDemo.Create)
			// gDemo.PUT(":id", cDemo.Update)
			// gDemo.DELETE(":id", cDemo.Delete)
			// gDemo.PATCH(":id/enable", cDemo.Enable)
			// gDemo.PATCH(":id/disable", cDemo.Disable)
		}
	}

	return nil
}

config.toml

#版本号
version="1.0.0"

# 运行模式(debug:调试,test:测试,release:正式)
run_mode = "debug"

# 静态站点目录(也可以启动服务时使用-www指定)
www = ""

# http配置
[http]
# http监听地址
host = "0.0.0.0"
# http监听端口
port = 8078
# 证书路径
cert_file = ""
# 证书密钥
key_file = ""
# http优雅关闭等待超时时长(单位秒)
shutdown_timeout = 30


# 日志配置
[log]
# 应用编号
app_no=100101
# 应用名称
app_name="样例Api服务"
# 日志级别(1:fatal 2:error,3:warn,4:info,5:debug)
log_level = 5
# 日志格式（支持输出格式：text/json）
format = "json"
# 日志输出(支持：stdout/stderr/file/multi)
# output = "multi"
# 指定日志输出的文件路径
output_file = "logs/app"
# 是否禁用自定义时间戳显示
disable_custom_timestamp = false
# 是否禁用行号信息显示(WarnLevel以上才会显示)
disable_line_hook = false
# 设置保留天数
log_file_max_age = 7
# 设置每天分割日志文件
log_file_rotation_time = 86400
# 设置日志文件名规则
log_file_path_format = ".%Y-%m-%d.log"

# swagger文档
[swagger]
on=1
title = "Swagger Example API"
description="swagger文档描述 demo 测试服务接口介绍"
version="1.0"
#host=""
base_path="/"
schemes=["http"]

# 跨域请求
[cors]
# 是否启用
enable = false
# 允许跨域请求的域名列表(*表示全部允许)
allow_origins = ["*"]
# 允许跨域请求的请求方式列表
allow_methods = ["GET","POST","PUT","DELETE","PATCH"]
# 允许客户端与跨域请求一起使用的非简单标头的列表
allow_headers = []
# 请求是否可以包含cookie，HTTP身份验证或客户端SSL证书等用户凭据
allow_credentials = true
# 可以缓存预检请求结果的时间（以秒为单位）
max_age = 7200

详细可参考测试用例 集成应用参考

运行效果如下图：

todo列表：

• response封装
• 日志中间件完善(easy-logrus)
• 跨域配置
• auth中间件开发
• 集成swagger
• 提供统一注册路由方法等。。。

扩展

• easy-logrus包
• easy-tool包
• easy-mqtt包
• easy-tcp-server包
• easy-gorm包
• 服务治理相关包
• Golang学习文档整理.bk