Revel的模块化是目录契约而非插件,需手动注册、平铺路由、规范模板路径且热重载需额外配置watch.dir。

模块化在 Revel 中不是插件,而是目录契约
Revel 的“模块化”和主流框架的 module 或 package 概念不同——它不支持动态加载、运行时注册或独立路由表。所谓模块,本质是符合 app/ 目录结构约定的子目录集合,必须手动在 app/init.go 中显式注册,否则控制器不会被路由识别、模板无法定位、Filter 不会注入。
常见错误现象:把 app/modules/user 当成独立模块,写了 UserController 和 user/index.html,但访问 /user 仍 404;日志里没有 RouterFilter matched 记录。
- 模块目录必须放在
app/下,且名称不能带点(如app/modules/user合法,app/modules/user.v1会被忽略) - 每个模块需包含自己的
controllers/、models/、views/子目录,结构必须和根app/一致 - 必须在
app/init.go的init()函数中调用revel.InterceptFunc(...)或revel.BuiltinFilter(...)显式挂载其 Filter,否则中间件链不生效 - 模块内控制器方法的路由仍需写进根
conf/routes文件,Revel 不会自动扫描子目录
如何让模块的控制器被路由识别
Revel 路由器只扫描 app/controllers/ 下的文件,不会递归查找 app/modules/*/controllers/。要让模块控制器可用,你得把它“拉平”到主控制器层。
推荐做法是用 Go 的包别名 + 控制器转发,而不是复制代码或改路径:
- 在
app/modules/user/controllers/user.go中定义type UserController struct { *revel.Controller },方法保持首字母大写(如Index()) - 在根
app/controllers/app.go中引入该包:import usermodule "my-app/app/modules/user/controllers" - 新增一个转发控制器:
func (c AppController) UserIndex() revel.Result { return usermodule.UserController{&c.Controller}.Index() } - 在
conf/routes中照常写:GET /user App.UserIndex
这样既复用了模块逻辑,又满足了 Revel 的路由约束,避免了 revel.InterceptFunc 注册失败或 c.Render 找不到模板的问题。
模块间共享模型与服务的正确姿势
模块之间不能直接 import 彼此的 controllers 包,但可以安全共享 models 和 services——前提是它们不依赖 Revel 的全局变量(如 revel.AppConfig)或请求上下文(如 *revel.Controller)。
容易踩的坑:
- 在
app/modules/payment/models/order.go中写import "github.com/revel/revel"→ 编译报循环依赖 - 在
app/modules/user/services/auth.go中直接调用revel.INFO.Printf→ 模块测试时 panic,因为revel.Init尚未执行 - 把数据库连接池(如
*gorm.DB)作为全局变量放models/db.go→ 多租户场景下连接混用
正确做法:
- 将核心模型(如
User、Order)统一放在app/models/,各模块只 import 它们 - 服务层函数签名不接收
*revel.Controller,而是接收明确依赖(如db *gorm.DB、cfg Config),由调用方传入 - 需要日志或配置时,用接口抽象:
type Logger interface { Infof(string, ...interface{}) },测试时可 mock
模块热重载失效?检查这三个地方
Revel 的热重载默认只监听 app/ 和 conf/ 目录,不包括 app/modules/ 下的任何子目录。改了模块代码却没触发重建,不是框架 bug,而是配置缺失。
解决办法只有两个有效路径:
- 把模块目录软链接进
app/(如ln -s ../modules/user app/user),让它成为app/user/controllers,这样热重载自然生效 - 修改
conf/app.conf,添加自定义监听路径:watch.dir = app/modules/user,app/modules/payment(注意用英文逗号分隔,无空格) - 绝对不要改
revel.Run源码或 patchfsnotify—— 这类操作在升级 Revel 后必然失效
最常被忽略的是:即使加了 watch.dir,如果模块内模板路径写成 app/modules/user/views/index.html,Revel 依然找不到它——模板必须按约定映射到 app/views/User/Index.html,否则渲染永远空白。











