Files
gin-vue-admin/aiDoc/examples/backend/router-example.md
T
15e6e7685c update:发布2.9.2版本 (#2211)
* feat: 调整AI工作模式,更符合harness基准

* feat: 添加BusinessDB字段到PluginInitializeGorm结构体,并增加相关测试用例

* [middleware/jwt.go]: fix #2192 issues bug

* docs: add auto plugin design spec

* chore: ignore worktrees directory

* feat: 调整代码辅助能力至插件

* feat: 添加警告条组件,提示授权用户访问限制

* fix: 修正商业用途版权声明链接

* feat: 调整agent.md 更加节省token

* fix: 修改casbin版本为v3

* feat: 更新JSONMap和JSONSlice类型,优化GORM数据类型处理

* feat: 添加数据库就绪通知机制,优化插件注册流程

* feat: 重构API路径和描述,优化代码生成器和模板配置分组

* feat: 优化 person 页面的 css 作用域限制

* feat: 更新 vite 至 vite8

* 新增:MCP工具为指定URL的角色ID授权

* fix: 增加文件名合法性检查,拒绝包含非法字符的文件写入

* chore: 更新CI配置,升级Node.js和Go版本,调整checkout和setup动作版本

* feat: 为数据库连接增加最大复用时间配置

* feat: 为各数据库连接配置增加最大连接生命周期设置

* feat: 更新插件注册逻辑并优化API和菜单组件的标签显示

* feat: 更新版本号至v2.9.2并添加新插件路径信息

---------

Co-authored-by: taincheng <zhangtc@gmail.com>
Co-authored-by: Azir-11 <2075125282@qq.com>
Co-authored-by: lanxi <1220lanxi@gmail.com>
2026-05-11 13:48:18 +08:00

1.5 KiB

Router 示例

这个文件负责什么

Router 层负责路由分组、中间件挂载和处理函数绑定,不承载业务逻辑。

什么时候应该这样写

  • 新增模块路由
  • 区分需要操作日志和不需要操作日志的接口
  • 对某类路由统一挂载权限或认证中间件

推荐写法示例

package system

import (
	"github.com/flipped-aurora/gin-vue-admin/server/middleware"
	"github.com/gin-gonic/gin"
)

type OrderRouter struct{}

func (r *OrderRouter) InitOrderRouter(Router *gin.RouterGroup) {
	orderRouter := Router.Group("order").Use(middleware.OperationRecord())
	orderRouterWithoutRecord := Router.Group("order")

	{
		orderRouter.POST("createOrder", orderApi.CreateOrder)
		orderRouter.PUT("updateOrder", orderApi.UpdateOrder)
		orderRouter.DELETE("deleteOrder", orderApi.DeleteOrder)
	}
	{
		orderRouterWithoutRecord.POST("getOrderList", orderApi.GetOrderList)
		orderRouterWithoutRecord.GET("findOrder", orderApi.FindOrder)
	}
}

为什么这样写

  • 写操作和读操作分组清晰,方便挂不同中间件
  • 路由层只做绑定,职责边界简单明确
  • 和项目现有 InitXxxRouter 命名方式一致

常见错误

  • 在路由文件里写业务逻辑
  • 所有接口都挂同一种中间件,导致读接口也被记录操作日志
  • 直接引用数据库或 Service,而不是引用 API 处理函数

真实参考文件

  • server/router/system/sys_user.go
  • server/router/system/enter.go