⛪ 专栏地址 系列教程更新中
🚀 文章介绍: 在开发过程中免不了与数据库的交互,其中模板类的编写如果手动编写会耗费大量时间,这里可引入MybatisPlus的Mybatis-plus-generator进行代码模板映射生成提高开发效率
🚀 源码获取: 项目中的资料可以通过文章底部公众号戳联系我获取
文章导航
- 什么是lombok
- 使用方式
- Lombok常用注解
- 增强版ORM框架-Mybatis plus
- 整体依赖参考
- Mybatis-plus-generator代码自动生成工具
- Mybatis-plus-generator依赖引入
- Mybatis-plus-generator使用流程
什么是lombok
-
一个优秀的Java代码库,简化了Java的编码,为Java代码的精简提供了一种方式
-
你是否发现每个JavaBean都会写getter,setter,equals,hashCode和toString的模板代码,特别的多于没技术
-
lombok消除Java的冗长代码,尤其是对于简单的Java对象,只要加上注解就行
使用方式
- 顶层parent项目添加依赖进行版本管理 ( 如果是微服务项目可在顶层进行依赖统一管理,单体项目则直接依赖引入即可 )
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
<scope>provided</scope>
</dependency>
-
需要的module项目里面再引入
-
添加IDE工具对Lombok的支持
- 点击File-- Settings设置界面,安装Lombok插件,然后重启idea
- 项目中添加(通用项目在common添加,单体项目可直接添加)
<!--common引入-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--其他微服务引入common->
<dependency>
<groupId>net.xiaochan</groupId>
<artifactId>xicoahan-common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<!--如果是单体项目不是微服务项目,则直接添加即可-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
</dependency>
Lombok常用注解
常见注解
-
@Getter/@Setter
- 作用类上,生成所有成员变量的getter/setter方法
- 作用于成员变量上,生成该成员变量的getter/setter方法
-
@ToString
- 作用于类,覆盖默认的toString()方法
-
@EqualsAndHashCode
- 作用于类,覆盖默认的equals和hashCode
-
@NoArgsConstructor
- 生成无参构造器
-
@AllArgsConstructor
- 生成全参构造器
-
@Data
- 作用于类上,是以下注解的集合
- @ToString
- @EqualsAndHashCode
- @Getter
- @Setter
- @RequiredArgsConstructor
- 作用于类上,是以下注解的集合
-
@Log / @Slf4j
-
作用于类上,生成日志变量, 用于记录日志, 已经在web项目中添加log依赖
-
如果不生效,记得检查下面的配置,另外重新更新下lombok插件,重启idea
-
使用方法 在类上注释 @Slf4j
log.info{}
增强版ORM框架-Mybatis plus
-
背景
-
写一个数据库表的crud接口,编写实体类-》编写Controller-》编写Service-》编写DAO-》-》编写XML文件
-
特别是管理后台,多数都是简单的CRUD,用普通的mybatis有的鸡肋
-
介绍
-
官网 https://baomidou.com/
-
是一个 Mybatis 的增强工具,在 Mybatis 的基础上只做增强不做改变,为简化开发、提高效率而生
-
是怎么增强的呢?已经封装好了一些crud方法,我们不需要再写xml了,直接调用这些方法就行,类似JPA但优于JPA
-
依赖引入
<dependencies>
<!-- Spring Boot Starter -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- Mybatis Plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.x.x</version><!-- 使用最新版本,根据你的需求替换x为具体版本号 例如 3.4.0 -->
</dependency>
<!-- MySQL Connector -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- 其他依赖... -->
</dependencies>
- 注意点
MyBatis-Plus默认遵循数据库字段使用下划线命名、Java实体类属性使用驼峰命名的约定。在执行SQL查询时,MyBatis-Plus会自动将Java实体类属性的驼峰命名转换为对应的数据库字段的下划线命名。
整体依赖参考
- 这里提供一个完整从maven依赖可供项目构建版本参考
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>gpt-test</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<parent>
<artifactId>spring-boot-starter-parent</artifactId>
<groupId>org.springframework.boot</groupId>
<version>2.5.3</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.httpcomponents.client5/httpclient5 -->
<dependency>
<groupId>org.apache.httpcomponents.client5</groupId>
<artifactId>httpclient5</artifactId>
<version>5.2.1</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--mybatis plus和springboot整合-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<!-- 指定该Main Class为全局的唯一入口 -->
<mainClass>com.yopai.App</mainClass>
</configuration>
<executions>
<execution>
<goals>
<goal>repackage</goal><!--可以把依赖的包都打包到生成的Jar包中-->
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
Mybatis-plus-generator代码自动生成工具
Mybatis-plus-generator(Mybatis-Plus 代码生成器)是 Mybatis-Plus
的一个子模块,作用是根据数据库表结构自动生成对应的实体类、Mapper接口、Mapper映射文件和Service接口等代码。它大大简化了开发者的工作量,提高了开发效率。
以下是关于 Mybatis-plus-generator 的一些介绍
- 自动生成代码:根据数据库表结构快速生成实体类、Mapper 接口、XML 映射文件以及 Service 接口等相关代码,减少手动编写重复性代码的工作。
- 自定义配置:Mybatis-plus-generator 支持自定义配置,例如包名、类名前缀/后缀、父类等。这样可以按照项目需求生成符合规范的代码。
- 模板引擎支持:内置 Velocity 和 Freemarker 两种模板引擎,可根据个人喜好选择使用哪种模板引擎来生成代码。4
- 插件扩展机制:Mybatis-plus-generator 提供了插件扩展机制,允许开发者编写自定义插件来扩展或修改生成器的功能。
- 简单易用:Mybatis-plus-generator 使用简单,只需在项目中添加依赖并进行简单配置即可使用。同时也提供了 Maven 插件和命令行方式来运行生成器。
Mybatis-plus-generator依赖引入
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!-- velocity -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
- application.properties配置
server.port=3008
spring.datasource.driver-class-name =com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxx?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username =root
spring.datasource.password =xxxx
Mybatis-plus-generator使用流程
- 数据库表内容示例 使用user库 下面有两个表 对应的数据格式如下 可在测试类里面进行生成
- 模板生成代码示例
public class MyBatisPlusGenerator {
public static void main(String[] args) {
//1. 全局配置
GlobalConfig config = new GlobalConfig();
// 是否支持AR模式
config.setActiveRecord(true)
// 作者
.setAuthor("xiaochan")
// 生成路径,最好使用绝对路径,window路径是不一样的 这里方便自己粘贴复制 所以不直接生成在项目文件
.setOutputDir("C:/Users/MI/Desktop/demo/src/main/java")
// 文件覆盖
.setFileOverride(true)
// 主键策略
.setIdType(IdType.AUTO)
.setDateType(DateType.ONLY_DATE)
// 设置生成的service接口的名字的首字母是否为I,默认Service是以I开头的
.setServiceName("%sService")
//实体类结尾名称
.setEntityName("%sDO")
//生成基本的resultMap
.setBaseResultMap(true)
//不使用AR模式
.setActiveRecord(false)
//生成基本的SQL片段
.setBaseColumnList(true);
//2. 数据源配置
DataSourceConfig dsConfig = new DataSourceConfig();
// 设置数据库类型
dsConfig.setDbType(DbType.MYSQL)
.setDriverName("com.mysql.cj.jdbc.Driver")
//TODO TODO TODO TODO
.setUrl("jdbc:mysql://127.0.0.1:3306/user?useSSL=false&serverTimezone=UTC")
.setUsername("用户名")
.setPassword("密码");
//3. 策略配置globalConfiguration中
StrategyConfig stConfig = new StrategyConfig();
//全局大写命名
stConfig.setCapitalMode(true)
// 数据库表映射到实体的命名策略
.setNaming(NamingStrategy.underline_to_camel)
//使用lombok
.setEntityLombokModel(true)
//使用restcontroller注解
.setRestControllerStyle(true)
// 生成的表, 支持多表一起生成,以数组形式填写
.setInclude("user","address");
//4. 包名策略配置
PackageConfig pkConfig = new PackageConfig();
pkConfig.setParent("net.xiaochan")
.setMapper("mapper")
.setService("service")
.setController("controller")
.setEntity("model")
.setXml("mapper");
//5. 整合配置
AutoGenerator ag = new AutoGenerator();
ag.setGlobalConfig(config)
.setDataSource(dsConfig)
.setStrategy(stConfig)
.setPackageInfo(pkConfig);
//6. 执行操作
ag.execute();
System.out.println("=======Done 相关代码生成完毕 ========");
}
}
- 运行结果 可以看到对应生成的模板内容 有controller mapper model 跟impl 这里复制自己需要的内容进项目即可
- 每个文件的代码内容如下
@RestController
@RequestMapping("/addressDO")
public class AddressController {
}
@RestController
@RequestMapping("/userDO")
public class UserController {
}
public interface AddressMapper extends BaseMapper<AddressDO> {
}
public interface UserMapper extends BaseMapper<UserDO> {
}
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("address")
public class AddressDO implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
/**
* 用户id
*/
private Long userId;
/**
* 是否默认收货地址:0->否;1->是
*/
private Integer defaultStatus;
/**
* 收发货人姓名
*/
private String receiveName;
/**
* 收货人电话
*/
private String phone;
/**
* 省/直辖市
*/
private String province;
/**
* 市
*/
private String city;
/**
* 区
*/
private String region;
/**
* 详细地址
*/
private String detailAddress;
private Date createTime;
}
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("user")
public class UserDO implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.AUTO)
private Long id;
/**
* 昵称
*/
private String name;
/**
* 密码
*/
private String pwd;
/**
* 头像
*/
private String headImg;
/**
* 用户签名
*/
private String slogan;
/**
* 0表示女,1表示男
*/
private Integer sex;
/**
* 积分
*/
private Integer points;
private Date createTime;
/**
* 邮箱
*/
private String mail;
/**
* 盐,用于个人敏感信息处理
*/
private String secret;
}
<mapper namespace="net.xdclass.mapper.UserMapper">
<!-- 通用查询映射结果 -->
<resultMap id="BaseResultMap" type="net.xdclass.model.UserDO">
<id column="id" property="id" />
<result column="name" property="name" />
<result column="pwd" property="pwd" />
<result column="head_img" property="headImg" />
<result column="slogan" property="slogan" />
<result column="sex" property="sex" />
<result column="points" property="points" />
<result column="create_time" property="createTime" />
<result column="mail" property="mail" />
<result column="secret" property="secret" />
</resultMap>
<!-- 通用查询结果列 -->
<sql id="Base_Column_List">
id, name, pwd, head_img, slogan, sex, points, create_time, mail, secret
</sql>
</mapper>
<!-- 通用查询映射结果 -->
<resultMap id="BaseResultMap" type="net.xdclass.model.AddressDO">
<id column="id" property="id" />
<result column="user_id" property="userId" />
<result column="default_status" property="defaultStatus" />
<result column="receive_name" property="receiveName" />
<result column="phone" property="phone" />
<result column="province" property="province" />
<result column="city" property="city" />
<result column="region" property="region" />
<result column="detail_address" property="detailAddress" />
<result column="create_time" property="createTime" />
</resultMap>
<!-- 通用查询结果列 -->
<sql id="Base_Column_List">
id, user_id, default_status, receive_name, phone, province, city, region, detail_address, create_time
</sql>
</mapper>
- 到这里 代码提效工具 模板生成工具配置演示完成
- 项目中通过使用这些工具可以减少许多耗费时间的操作