RuoYi-Vue-Pro项目新建模块时Controller包路径的注意事项

在基于RuoYi-Vue-Pro框架进行二次开发时，新建模块是一个常见的操作。本文主要讲解在新建模块过程中关于Controller包路径配置的关键注意事项，帮助开发者避免常见的404错误问题。

包路径与API访问路径的映射关系

RuoYi-Vue-Pro框架采用了清晰的包结构设计，其中Controller的包名直接决定了API的访问路径前缀：

• controller.admin包中的Controller：对应/admin-api/前缀
• controller.app包中的Controller：对应/app-api/前缀
• controller.user包中的Controller：对应/user-api/前缀

这种设计使得API路由更加规范，便于管理和维护。

常见错误场景分析

许多开发者在新建模块时，容易犯以下错误：

1. 将本应放在controller.app包中的Controller类错误地放置在controller.user包中
2. 没有注意到框架的包路径与API前缀的映射关系
3. 在测试时使用了错误的API前缀访问接口

例如，当开发者将AppDemoTestController放在controller.user包中，却尝试通过/app-api/demo/test/get路径访问时，就会遇到404 Not Found错误。

正确的配置方法

1. 确定API类型：首先明确你要开发的API类型是管理后台(admin)、用户端(user)还是应用端(app)

2. 创建对应包结构：

   • 管理后台API：controller.admin
   • 用户端API：controller.user
   • 应用端API：controller.app

3. 编写Controller：在正确的包路径下创建Controller类

4. 测试验证：使用正确的API前缀进行测试

其他相关注意事项

1. Swagger文档显示：确保在yudao-server模块的pom.xml中添加了对新建模块的依赖，否则Swagger文档中不会显示新增的API接口

2. API文档查找：Swagger文档中的测试项默认没有按字母排序，查找时需要仔细

3. 模块依赖管理：新建模块后，需要在主项目的依赖管理部分添加对新模块的引用

通过遵循上述规范和注意事项，开发者可以避免在RuoYi-Vue-Pro项目中新建模块时遇到的各种路由和访问问题，提高开发效率和代码质量。