Appearance
Web服务器
基础介绍
在due框架中，Web服务器是基于fiber框架的二次封装。在继承fiber框架的所有优点的同时，还提供了符合due框架的调用接口，为游戏开发中的Web场景提供完善的解决方案。
跨域支持
框架原生支持跨域，你只需要在启动配置里设置跨域配置即可开启跨域
Swagger支持
为了为广大开发者提供较好的开发体验，Web服务器已原生支持了Swagger的组件。使用方法也非常简单，只需要通过配置项开启即可打开swagger访问支持。
- 安装swag
bash
$ go install github.com/swaggo/swag/cmd/swag@latest全局中间件
你可以在创建Web服务器的时候使用http.WithMiddlewares()来设置全局中间件。中间件支持http.Handler和fiber.Handler两种类型的中间件
示例代码
以下完整示例详见：web
go
package main
import (
"fmt"
"github.com/dobyte/due/component/http/v2"
"github.com/dobyte/due/v2"
"github.com/dobyte/due/v2/codes"
"github.com/dobyte/due/v2/log"
"github.com/dobyte/due/v2/utils/xtime"
)
// @title API文档
// @version 1.0
// @host localhost:8080
// @BasePath /
func main() {
// 创建容器
container := due.NewContainer()
// 创建HTTP组件
component := http.NewServer()
// 初始化应用
initApp(component.Proxy())
// 添加网格组件
container.Add(component)
// 启动容器
container.Serve()
}
// 初始化应用
func initApp(proxy *http.Proxy) {
// 路由器
router := proxy.Router()
// 注册路由
router.Get("/greet", greetHandler)
}
// 请求
type greetReq struct {
Message string `json:"message"`
}
// 响应
type greetRes struct {
Message string `json:"message"`
}
// 路由处理器
// @Summary 测试接口
// @Tags 测试
// @Schemes
// @Accept json
// @Produce json
// @Param request body greetReq true "请求参数"
// @Response 200 {object} http.Resp{Data=greetRes} "响应参数"
// @Router /greet [get]
func greetHandler(ctx http.Context) error {
req := &greetReq{}
if err := ctx.Bind().JSON(req); err != nil {
return ctx.Failure(codes.InvalidArgument)
}
log.Info(req.Message)
return ctx.Success(&greetRes{
Message: fmt.Sprintf("I'm server, and the current time is: %s", xtime.Now().Format(xtime.DateTime)),
})
}生成文档
- 生成swagger文件
bash
$ swag init --parseDependency- 删除无用的docs.go文件
bash
$ rm -rf ./docs/docs.go启动服务
bash
$ go run main.go
____ __ ________
/ __ \/ / / / ____/
/ / / / / / / __/
/ /_/ / /_/ / /___
/_____/\____/_____/
┌──────────────────────────────────────────────────────┐
| [Website] https://github.com/dobyte/due |
| [Version] v2.2.1 |
└──────────────────────────────────────────────────────┘
┌────────────────────────Global────────────────────────┐
| PID: 40628 |
| Mode: debug |
└──────────────────────────────────────────────────────┘
┌─────────────────────────Http─────────────────────────┐
| Name: http |
| Url: http://192.168.2.202:8080 |
| Swagger: http://192.168.2.202:8080/swagger |
| Registry: - |
| Transporter: - |
└──────────────────────────────────────────────────────┘启动配置
这里仅展示Web服务器（Http）相关配置参数，如需了解更多模块的参数配置，请查看启动配置
toml
# 进程号
pid = "./run/web.pid"
# 开发模式。支持模式：debug、test、release（设置优先级：配置文件 < 环境变量 < 运行参数 < mode.SetMode()）
mode = "debug"
# 统一时区设置。项目中的时间获取请使用xtime.Now()
timezone = "Local"
# 容器关闭最大等待时间。支持单位：纳秒（ns）、微秒（us | µs）、毫秒（ms）、秒（s）、分（m）、小时（h）、天（d）。默认为0
shutdownMaxWaitTime = "0s"
# http服务器配置
[http]
# 服务器名称
name = "http"
# 服务器监听地址，默认为:8080
addr = ":8080"
# 秘钥文件
keyFile = ""
# 证书文件
certFile = ""
# 跨域配置
[http.cors]
# 是否启用跨域
enable = true
# 允许跨域的请求源。默认为[]，即为允许所有请求源
allowOrigins = []
# 允许跨域的请求方法。默认为["GET", "POST", "HEAD", "PUT", "DELETE", "PATCH"]
allowMethods = []
# 允许跨域的请求头部。默认为[]，即为允许所有请求头部
allowHeaders = []
# 当允许所有源时，根据CORS规范不允许携带凭据。默认为false
allowCredentials = false
# 允许暴露给客户端的头部。默认为[]，即为允许暴露所有头部
exposeHeaders = []
# 浏览器缓存预检请求结果的时间。默认为0
maxAge = 0
# 是否允许来自私有网络的请求。设置为true时，响应头Access-Control-Allow-Private-Network会被设置为true。默认为false
allowPrivateNetwork = false
# swagger配置
[http.swagger]
# 是否启用文档
enable = true
# API文档标题
title = "API文档"
# URL访问基础路径
basePath = "/swagger"
# swagger文件路径
filePath = "./docs/swagger.json"
[log]
# 日志输出文件
file = "./log/due.log"
# 日志输出级别，可选：debug | info | warn | error | fatal | panic
level = "debug"
# 日志输出格式，可选：text | json
format = "text"
# 是否输出到终端
stdout = true
# 时间格式，标准库时间格式
timeFormat = "2006/01/02 15:04:05.000000"
# 堆栈的最低输出级别，可选：debug | info | warn | error | fatal | panic
stackLevel = "error"
# 文件最大留存时间，d:天、h:时、m:分、s:秒
fileMaxAge = "7d"
# 文件最大尺寸限制，单位（MB）
fileMaxSize = 100
# 文件切割方式
fileCutRule = "day"
# 是否启用调用文件全路径
callerFullPath = true
# 是否启用分级存储
classifiedStorage = false