Java EasyCode 结合MyBatis-Plus 自动生成代码使用指南
EasyCode 是一款用于简化 Java 开发的 IntelliJ IDEA 插件,可以帮助您快速生成代码。MyBatis-Plus 是 MyBatis 的一个增强工具,提供了许多实用的功能,如通用 Mapper、通用 Service、分页插件等。本文将详细介绍如何使用 EasyCode 结合 MyBatis-Plus 自动生成代码。
1. 安装 EasyCode 插件
请参考我的文章中的 安装 EasyCode 插件 部分创建SpringBoot项目。
2.创建Spring Boot项目
请参考我的文章中的 创建Spring Boot项目 部分安装 EasyCode 插件。本次 demo
的代码目录结构如下:
3. 添加 MyBatis-Plus 依赖
在项目的 pom.xml
文件中添加 MyBatis-Plus 的依赖:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-extension</artifactId>
<version>3.3.1</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1</version>
</dependency>
请注意,上述版本号可能会随着新版本的发布而发生变化。请确保使用您从官方网站复制的版本号。
4. 配置 MyBatis-Plus
在项目的application.yaml
文件中配置 MyBatis-Plus。相关配置请根据自己的情况进行修改,比如数据库IP、账号密码等;例如:
server:
port: 8080
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://ip:3306/数据库名?useSSL=false&serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8
username: username
password: password
5. 使用 EasyCode 自动生成 MyBatis-Plus 代码
EasyCode 可以帮助您快速生成 MyBatis-Plus 的实体类、Mapper、Service 和 Controller。以下是使用 EasyCode 自动生成这些代码的步骤:
-
添加数据源,在IDEA右侧的数据库点击添加。
-
数据库连接成功后,右键单击数据库中的某个表(例如,
demo表
),点击Generate Code
。
-
选择对应的
Package
,下拉框选择MybatisPlus
, 然后Template
勾选All
,具体配置如下图。
-
点击
确定
之后,生成的代码结构如下图;在DemoApplication
中加入MapperScan
注解,扫描所有的dao
(ps:记得配置application.yaml
文件和pom.xml
文件,具体参考前面的步骤!)。
-
至此,但是还有个小问题,数据库分页查询还不能完全生效,
MyBatis-Plus
分页插件未配置,所以还要在配置类中添加一个PaginationInterceptor
类型的Bean
,如下所示:package com.example.demo.config; import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * mybatis-plus配置 */ @Configuration public class MybatisPlusConfig { /** * 分页插件 */ @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); } }
代码结构如下图:
ps:接口请求中通过参数current(页码)
和size(每页数量)
来控制分页查询。
6. 自定义 EasyCode 模板
EasyCode 允许您自定义代码生成模板,以便根据您的需求生成特定格式的代码。以下是自定义 EasyCode 模板的步骤:
-
打开 IntelliJ IDEA 设置窗口,选择
EasyCode
。 -
在
Template Setting
选项卡中,您可以看到所有可用的代码生成模板。 -
选择要自定义的模板,然后在右侧的编辑器中修改模板内容。
-
您可以使用 EasyCode 提供的变量和函数来自定义模板。例如,
${table.className}
表示实体类名,${table.pkColumn.fieldName}
表示主键字段名等。 -
自定义模板完成后,点击
Apply
按钮保存更改。 -
实战举例,如使用
MyBatis-plus
自动生成代码时,刚才的MyBatis-Plus
分页插件可以添加到模板中进行生成:
在MybatisPlus
组下新增一个模板文件,本示例命名为MyBatisPlusConfig.java.vm
,可根据自己的需要进行命名
模板代码:##设置回调 $!callback.setFileName($tool.append("MybatisPlusConfig", ".java")) $!callback.setSavePath($tool.append($tableInfo.savePath, "/config")) #if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}config; import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * mybatis-plus配置 */ @Configuration public class MybatisPlusConfig { /** * 分页插件 */ @Bean public PaginationInterceptor paginationInterceptor() { return new PaginationInterceptor(); } }
保存成功后,在使用EasyCode
生成代码时,勾选添加的模板
该模板会生成一个
config
包,并在congfig
包下生成一个MybatisPlusConfig
的java类,类中的代码和前面手动添加的一致
现在,当您使用 EasyCode
生成代码时,将使用您自定义的模板生成代码。
总结
EasyCode 是一款强大的 IntelliJ IDEA 插件,可以帮助您快速生成 Java 代码,提高开发效率。结合 MyBatis-Plus,您可以更轻松地生成实体类、Mapper、Service 和 Controller。本文介绍了如何安装和使用 EasyCode