catface_backend_go/routers/web.go

package routers

import (
	"catface/app/global/consts"
	"catface/app/global/variable"
	// "catface/app/http/controller/captcha"	// 验证码组件
	// "catface/app/http/middleware/authorization"
	"catface/app/http/middleware/cors"
	validatorFactory "catface/app/http/validator/core/factory"
	// TODO validatorFactory "catface/app/http/validator/core/factory"
	"catface/app/utils/gin_release"
	"net/http"

	"github.com/gin-contrib/pprof"
	"github.com/gin-gonic/gin"
	"go.uber.org/zap"

)

// 该路由主要设置 后台管理系统等后端应用路由

func InitWebRouter() *gin.Engine {
	var router *gin.Engine
	// 非调试模式（生产模式） 日志写到日志文件
	if variable.ConfigYml.GetBool("AppDebug") == false {
		//1.gin自行记录接口访问日志，不需要nginx，如果开启以下3行，那么请屏蔽第 34 行代码
		//gin.DisableConsoleColor()
		//f, _ := os.Create(variable.BasePath + variable.ConfigYml.GetString("Logs.GinLogName"))
		//gin.DefaultWriter = io.MultiWriter(f)

		//【生产模式】
		// 根据 gin 官方的说明：[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
		// 如果部署到生产环境，请使用以下模式：
		// 1.生产模式(release) 和开发模式的变化主要是禁用 gin 记录接口访问日志，
		// 2.go服务就必须使用nginx作为前置代理服务，这样也方便实现负载均衡
		// 3.如果程序发生 panic 等异常使用自定义的 panic 恢复中间件拦截、记录到日志
		router = gin_release.ReleaseRouter()
	} else {
		// 调试模式，开启 pprof 包，便于开发阶段分析程序性能
		router = gin.Default()
		pprof.Register(router)
	}

	// 设置可信任的代理服务器列表,gin (2021-11-24发布的v1.7.7版本之后出的新功能)
	if variable.ConfigYml.GetInt("HttpServer.TrustProxies.IsOpen") == 1 {
		if err := router.SetTrustedProxies(variable.ConfigYml.GetStringSlice("HttpServer.TrustProxies.ProxyServerList")); err != nil {
			variable.ZapLog.Error(consts.GinSetTrustProxyError, zap.Error(err))
		}
	} else {
		_ = router.SetTrustedProxies(nil)
	}

	// 根据配置进行设置跨域
	if variable.ConfigYml.GetBool("HttpServer.AllowCrossDomain") {
		router.Use(cors.Next())
	}

	// TAG CORE ROUTER START ----------------------------------------------

	router.GET("/", func(context *gin.Context) {
		context.String(http.StatusOK, "Hello Havoc.")
	})

	// // 创建一个验证码路由
	// verifyCode := router.Group("captcha")
	// {
	// 	// 验证码业务，该业务无需专门校验参数，所以可以直接调用控制器
	// 	verifyCode.GET("/", (&captcha.Captcha{}).GenerateId)                          //  获取验证码ID
	// 	verifyCode.GET("/:captcha_id", (&captcha.Captcha{}).GetImg)                   // 获取图像地址
	// 	verifyCode.GET("/:captcha_id/:captcha_value", (&captcha.Captcha{}).CheckCode) // 校验验证码
	// }

	// 创建一个后端接口路由组
	backend := router.Group("admin")
	{
		// 	// 创建一个websocket,如果ws需要账号密码登录才能使用，就写在需要鉴权的分组，这里暂定是开放式的，不需要严格鉴权，我们简单验证一下token值
		// 	backend.GET("ws", validatorFactory.Create(consts.ValidatorPrefix+"WebsocketConnect"))
		//  【不需要token】中间件验证的路由  用户注册、登录
		noAuth := backend.Group("users")
		{
			noAuth.POST("weixinlogin", validatorFactory.Create(consts.ValidatorPrefix+"UsersWeixinLogin"))
			// 关于路由的第二个参数用法说明
			// 1.编写一个表单参数验证器结构体，参见代码：   app/http/validator/web/users/register.go
			// 2.将以上表单参数验证器注册，遵守 键 =》值 格式注册即可 ，app/http/validator/common/register_validator/web_register_validator.go  20行就是注册时候的键 consts.ValidatorPrefix+"UsersRegister"
			// 3.按照注册时的键，直接从容器调用即可 ：validatorFactory.Create(consts.ValidatorPrefix+"UsersRegister")
			// noAuth.POST("register", validatorFactory.Create(consts.ValidatorPrefix+"UsersRegister"))
			// 不需要验证码即可登陆
			// noAuth.POST("login", validatorFactory.Create(consts.ValidatorPrefix+"UsersLogin"))
			// 如果加载了验证码中间件，那么就需要提交验证码才可以登陆（本质上就是给登陆接口增加了2个参数：验证码id提交时的键：captcha_id 和 验证码值提交时的键 captcha_value，具体参见配置文件）
			//noAuth.Use(authorization.CheckCaptchaAuth()).POST("login", validatorFactory.Create(consts.ValidatorPrefix+"UsersLogin"))
		}
		// 	// 刷新token
		// refreshToken := backend.Group("users/")
		// {
		// 	// 刷新token，当过期的token在允许失效的延长时间范围内，用旧token换取新token
		// 	refreshToken.Use(authorization.RefreshTokenConditionCheck()).POST("refreshtoken", validatorFactory.Create(consts.ValidatorPrefix+"RefreshToken"))
		// }

		// 	// 【需要token】中间件验证的路由
		// 	backend.Use(authorization.CheckTokenAuth())
		// 	{
		// 		// 用户组路由
		// 		users := backend.Group("users/")
		// 		{
		// 			// 查询 ，这里的验证器直接从容器获取，是因为程序启动时，将验证器注册在了容器，具体代码位置：App\Http\Validator\Web\Users\xxx
		// 			users.GET("index", validatorFactory.Create(consts.ValidatorPrefix+"UsersShow"))
		// 			// 新增
		// 			users.POST("create", validatorFactory.Create(consts.ValidatorPrefix+"UsersStore"))
		// 			// 更新
		// 			users.POST("edit", validatorFactory.Create(consts.ValidatorPrefix+"UsersUpdate"))
		// 			// 删除
		// 			users.POST("delete", validatorFactory.Create(consts.ValidatorPrefix+"UsersDestroy"))
		// 		}
		//文件上传公共路由
		uploadFiles := backend.Group("upload/")
		{
			uploadFiles.POST("files", validatorFactory.Create(consts.ValidatorPrefix+"UploadFiles"))
		}
		// 	}

		animal := backend.Group("animal")
		{
			animal.GET("", validatorFactory.Create(consts.ValidatorPrefix+"AnimalList"))
			animal.GET("detail", validatorFactory.Create(consts.ValidatorPrefix+"AnimalDetail"))
			animal.POST("", validatorFactory.Create(consts.ValidatorPrefix+"AnimalCreate"))
			animal.GET("name", validatorFactory.Create(consts.ValidatorPrefix+"AnimalName"))

			animal.POST("like", validatorFactory.Create(consts.ValidatorPrefix+"AnimalLikeCreate"))
			animal.DELETE("like", validatorFactory.Create(consts.ValidatorPrefix+"AnimalLikeDelete"))

			animal.POST("catface", validatorFactory.Create(consts.ValidatorPrefix+"AnimalCatfaceGuess"))
		}

		// backend.Use(authorization.CheckTokenAuth()) // INFO token 检查
		// {
		encounter := backend.Group("encounter")
		{
			// GET 获取列表； POST 上传
			encounter.GET("", validatorFactory.Create(consts.ValidatorPrefix+"EncounterList"))
			encounter.GET(":encounter_id", validatorFactory.Create(consts.ValidatorPrefix+"EncounterDetail"))

			encounter.POST("", validatorFactory.Create(consts.ValidatorPrefix+"EncounterStore"))

			// Like / unlike
			encounter.POST("like", validatorFactory.Create(consts.ValidatorPrefix+"EncounterLikeCreate"))
			encounter.DELETE("like", validatorFactory.Create(consts.ValidatorPrefix+"EncounterLikeDelete"))
		}

		nlp := backend.Group("nlp")
		{
			nlp.POST("title", validatorFactory.Create(consts.ValidatorPrefix+"NlpTitle"))
		}

		rag := backend.Group("rag")
		{
			rag.GET("chat", validatorFactory.Create(consts.ValidatorPrefix+"RagChat"))
			rag.DELETE("", validatorFactory.Create(consts.ValidatorPrefix+"RagRelease"))
		}

		search := backend.Group("search")
		{
			search.GET("", validatorFactory.Create(consts.ValidatorPrefix+"SearchAll"))
		}

		knowledge := backend.Group("knowledge")
		{
			knowledge.GET("random", validatorFactory.Create(consts.ValidatorPrefix+"KnowledgeRandomList"))
		}

		doc := backend.Group("doc")
		{
			doc.POST("", validatorFactory.Create(consts.ValidatorPrefix+"DocUpload"))
		}
		// }
	}

	// //处理静态资源（不建议gin框架处理静态资源，参见 public/readme.md 说明 ） // INFO 已经交给 Nginx 了
	// router.Static("/public", "./public")             //  定义静态资源路由与实际目录映射关系
	// router.StaticFS("/dir", http.Dir("./public"))    // 将public目录内的文件列举展示
	// router.StaticFile("/abcd", "./public/readme.md") // 可以根据文件名绑定需要返回的文件名

	return router
}