今天,我们使用gin框架将压力机做成一个web服务。
我们引入gin框架:
代码语言:javascript复制go get github.com/gin-gonic/gin
在项目根目录新建一个routers目录,并在routers目录下新建:cors.go router.go router_group.go三个文件。
router.go文件主要是我们编辑路由时使用,目的是统一对web服务的接口进行管理。
代码语言:javascript复制router.go
package routers
import "github.com/gin-gonic/gin"
/*
路由配置
*/
func initRouters(groups *gin.RouterGroup) {
{
groups.POST("/run/testObject/") //运行测试对象接口, url: http://*****/engine/run/testObject/
}
}
cors.go主要是进行跨域配置,如:前端调用我们的后端服务
cors.go
package routers
import (
"github.com/gin-gonic/gin"
"net/http"
)
/*
跨域配置
需要在路由使用前进行使用
*/
func cors() gin.HandlerFunc {
return func(ctx *gin.Context) {
method := ctx.Request.Method
ctx.Header("Access-Control-Allow-Origin", "*")
ctx.Header("Access-Control-Allow-Headers", "Content-Type,AccessToken,X-CSRF-Token, Authorization, Token, x-token")
ctx.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE, PATCH, PUT")
ctx.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Content-Type")
ctx.Header("Access-Control-Allow-Credentials", "true")
if method == "OPTIONS" {
ctx.AbortWithStatus(http.StatusNoContent)
}
ctx.Next()
}
}
router_group.go主要是实现一个路由组,我们可以定义一个路由的统一前缀,对接口进行分类管理。
代码语言:javascript复制router_group.go
package routers
import "github.com/gin-gonic/gin"
/*
路由组
*/
func NewRouterGroup() (handler *gin.Engine) {
handler = gin.Default()
handler.Use(cors()) // 使用跨域配置,在路由使用前进行使用跨域配置
group := handler.Group("engine")
initRouters(group)
return
}
目前总体项目结构如下:
这样我们就把我们web服务的路由表配置好了,下面我们使用go自带的http,开启并进行服务监听。
在main.go文件中新建runService()函数,并在main方法中调用。
代码语言:javascript复制package main
import (
"context"
"fmt"
"kitchen-engine/global/config"
"kitchen-engine/global/log"
"kitchen-engine/routers"
"net/http"
"os"
"os/signal"
"syscall"
"time"
)
// 初始化函数,在main函数之前运行
func init() {
// 初始化配置信息
config.InitConfig()
// 初始化日志配置
log.InitLogger(config.YC)
}
/*
启动服务并监听
*/
func runService() {
handler := routers.NewRouterGroup()
engineServer := &http.Server{
// 我们的服务地址是本机的ip:8000端口,这个可以根据自己的需求修改
Addr: "0.0.0.0:8000",
Handler: handler,
// 控制服务器解析请求报头的键和值(包括请求行)时将读取的最大字节数。它不限制请求体的大小。如果为零,则使用DefaultMaxHeaderBytes。
MaxHeaderBytes: 1 << 20,
}
go func() {
// 启动http服务
if err := engineServer.ListenAndServe(); err != nil {
log.Logger.Error(fmt.Sprintln("engineServer出错: ", err.Error()))
return
}
log.Logger.Debug("engine服务启动成功")
}()
/// 接收终止信号
quit := make(chan os.Signal)
signal.Notify(quit, syscall.SIGINT, syscall.SIGTERM)
<-quit
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := engineServer.Shutdown(ctx); err != nil {
log.Logger.Info("注销成功")
}
}
func main() {
log.Logger.Debug("yc: ", config.YC)
runService()
//// 一个类型中的字段,可以重置,也可以使用默认值,在go中,所有的类型的初始值,都是字段类型的0值,比如string的初始值是""空字符串,int类型的初始值是0等等
//httpClientSettings := model.HttpClientSettings{
// Name: "测试厨房",
// NoDefaultUserAgentHeader: true,
// MaxConnDuration: 1000,
// AdvancedOptions: model.AdvancedOptions{
// Tls: model.Tls{
// IsVerify: true,
// VerifyType: 1,
// },
// },
//}
//
//headers := []model.Header{
// model.Header{
// Field: "name",
// Value: "你好",
// },
//}
//
//httpRequest := model.HttpRequest{
// Url: "https://www.baidu.com",
// Method: "GET",
// HttpClientSettings: httpClientSettings,
// Headers: headers,
//}
//
//client.RequestHttp(httpRequest)
log.Logger.Info("欢迎使用zap日志")
}
解释一下为什么我们使用了gin还要在使用net/http进行服务启动,是因为我们需要接受控制台的终止信号,使用gin很难完成,所以我们使用http的Shutdown函数。
代码语言:javascript复制运行结果如下:
配置文件:D:workspacegoplanetseven-daykitchen-engineopen.yaml初始化成功
2023-06-29T16:24:15.151 0800 DEBUG kitchen-engine/main.go:62 yc: {{test /data/logs/runner-go-info.log /data/logs/runner-go-err.log true}}
[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
using env: export GIN_MODE=release
using code: gin.SetMode(gin.ReleaseMode)
[GIN-debug] POST /engine/run/testObject/ --> kitchen-engine/routers.cors.func1 (3 handlers)
好了,本次章节结束。下章,我们将我们的testObject接口进行实现。