若依框架（RuoYi）作为一个基于Spring Boot和MyBatis的快速开发平台，提供了强大的代码生成器功能。通过代码生成器，开发者可以迅速创建基础的CRUD（增删改查）代码，大幅提高开发效率。本文将详细介绍若依框架代码生成器的使用方法，包括基本操作、模板定制、常见问题解决等方面，帮助开发者更好地掌握和利用这一工具。
一、代码生成器概述
若依代码生成器主要用于从数据库表生成对应的实体类、Mapper接口、Service层和Controller层代码，以及相应的前端页面代码。它通过读取数据库元数据（表结构和字段信息），自动生成标准化的代码模板，减少手工编码的工作量。
二、代码生成器基本使用方法
-
准备工作： 确保已经正确配置了数据源，使得若依框架能够访问到目标数据库。数据源配置在
application-dev.yml文件中，如下所示：spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://localhost:3306/ruoyi?useUnicode=true&characterEncoding=utf8&serverTimezone=UTCusername: rootpassword: your_password -
进入代码生成器界面： 启动若依框架后，使用管理员账户登录后台管理系统，导航到“系统工具” -> “代码生成” 页面。此时，你会看到数据库中所有表的列表。
-
选择表生成代码： 在表列表中，选择你要生成代码的表，点击“生成”按钮，弹出代码生成配置界面。
-
配置生成选项： 在代码生成配置界面，可以设置生成代码的包路径、模块名称、作者信息等。具体配置项包括：
- 包路径：Java类的包路径，如
com.ruoyi.project.system.user。 - 模块名称：生成代码所属模块，如
system。 - 作者：生成代码的作者信息。
- 生成路径：代码生成后的保存路径。
配置完成后，点击“生成”按钮，即可生成对应的代码文件。
- 包路径：Java类的包路径，如
-
查看生成代码： 生成的代码文件会存放在项目的
ruoyi-generator/src/main/java目录下。生成的代码包括以下几个部分：- 实体类：对应数据库表的实体类，通常位于
domain包下。 - Mapper接口：数据访问层接口，位于
mapper包下。 - Service层：业务逻辑层接口和实现类，位于
service包下。 - Controller层：控制器类，位于
controller包下。 - 前端页面：生成对应的Vue.js页面文件，位于
ruoyi-ui/src/views目录下。
- 实体类：对应数据库表的实体类，通常位于
三、代码生成器模板定制
若依框架的代码生成器使用Freemarker模板引擎进行模板生成，开发者可以根据实际需求定制自己的代码模板。
-
模板文件位置： 模板文件通常位于
ruoyi-generator/src/main/resources/vm目录下，包括：java/domain.java.vm：实体类模板。java/mapper.java.vm：Mapper接口模板。java/service.java.vm：Service接口模板。java/serviceImpl.java.vm：Service实现类模板。java/controller.java.vm：Controller类模板。
-
修改模板文件： 以实体类模板
domain.java.vm为例，打开文件，修改模板内容，例如：package ${packageName};import java.io.Serializable; import java.util.Date;/*** ${table.comment} 实体类* * @author ${author}* @date ${datetime}*/ public class ${ClassName} implements Serializable {private static final long serialVersionUID = 1L;<#list columns as column>/** ${column.comment} */private ${column.javaType} ${column.columnName};</#list><#list columns as column>public ${column.javaType} get${column.columnName?cap_first}() {return ${column.columnName};}public void set${column.columnName?cap_first}(${column.javaType} ${column.columnName}) {this.${column.columnName} = ${column.columnName};}</#list> }这里使用了Freemarker的模板语法，
${packageName}、${ClassName}等变量会被实际的值所替换。 -
添加自定义模板： 如果需要添加新的模板，例如生成DTO类或者其他自定义类，可以在
vm目录下创建新的模板文件，并在代码生成器的配置中添加相应的模板路径。
四、常见问题解决
-
生成代码后编译错误：
- 检查生成的代码包路径是否正确，确保与项目结构一致。
- 确认数据库表结构与生成代码中的字段类型和名称匹配。
-
无法获取数据库表：
- 检查数据源配置是否正确，确保数据库连接正常。
- 确认数据库中是否存在指定的表，并且表名不包含特殊字符。
-
模板修改未生效：
- 确保修改后的模板文件已保存，并且路径和名称正确。
- 若依框架可能会缓存模板文件，尝试重启项目以清除缓存。
五、深入定制与扩展
若依框架的代码生成器不仅能够生成标准的CRUD代码，还可以进行更深层次的定制和扩展，以满足复杂业务需求。
-
复杂查询生成： 可以在模板中添加复杂查询的生成逻辑，例如多表关联查询、动态条件查询等。在
mapper.java.vm模板中，添加自定义的查询方法：public List<${ClassName}> customQuery(@Param("param") String param); -
生成API文档： 可以在生成的Controller类中添加注释，以便集成Swagger等API文档生成工具。例如，在
controller.java.vm模板中添加Swagger注解：@ApiOperation("${table.comment}查询") @GetMapping("/list") public List<${ClassName}> list() {// 查询逻辑 } -
生成前端代码： 若依框架支持生成前端Vue.js代码，可以在前端模板文件中添加自定义逻辑，例如表单校验、动态表单生成等。在
ruoyi-ui/src/views/module目录下，可以找到生成的前端文件，进行定制修改。
六、实际案例分享
结合实际项目，我们来分享一个使用若依代码生成器的案例。
-
需求描述： 某项目需要管理用户信息，包括用户名、邮箱、电话号码等基本信息，需要实现用户的增删改查功能，并且需要支持复杂查询和分页功能。
-
步骤详解：
-
创建数据库表：
CREATE TABLE user_info (id BIGINT PRIMARY KEY AUTO_INCREMENT,username VARCHAR(50) NOT NULL,email VARCHAR(50) NOT NULL,phone VARCHAR(20),create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP ); -
使用代码生成器生成代码：
- 在后台管理系统中，选择
user_info表，配置生成选项，生成代码。
- 在后台管理系统中，选择
-
查看生成代码：
- 生成的实体类
UserInfo.java、Mapper接口UserInfoMapper.java、Service层UserInfoService.java、Controller层UserInfoController.java以及前端Vue.js文件。
- 生成的实体类
-
定制复杂查询：
-
在
UserInfoMapper.java中添加自定义查询方法：public List<UserInfo> findByEmail(@Param("email") String email); -
在
UserInfoMapper.xml中添加对应的SQL语句：<select id="findByEmail" parameterType="String" resultType="UserInfo">SELECT * FROM user_info WHERE email = #{email} </select>
-
-
测试功能：
- 启动项目，进行功能测试，确保用户信息的增删改查功能正常，复杂查询和分页功能正常。
-
结论
若依框架的代码生成器不仅可以大幅提高开发效率，还可以通过灵活的模板定制，满足各种复杂的业务需求。从基本的CRUD代码生成到高级的自定义查询、API文档生成和前端页面生成，若依代码生成器都能够提供强大的支持。通过掌握代码生成器的使用方法和定制技巧，开发者可以更加高效地进行项目开发和维护。希望本文的详细介绍，能够帮助你更好地理解和利用若依框架的代码生成器，打造出高质量的企业级应用。
