Spring Boot 实战(11)整合 MyBatis-Plus
<properties>
<java.version>1.8</java.version>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.2.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
2. 在 application.properties 配置文件中添加 数据库的相关配置
数据库配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3
306/数据库名?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
mybatis 日志(控制台显示 sql 语句)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
3. 配置 MapperScan 注解
在 Spring Boot 启动类中添加 @MapperScan 注解
注解的作用是:扫描 Mapper 文件夹
@SpringBootApplication
@MapperScan("com.zxy.mpdemo.mapper")
public class MainApplication {
public static void main(String[] args) {
SpringApplication.run(MainApplication.class, args);
}
}
四、Mybatis-Plus 入门
1. 编写实体类
注意: 在此处使用了 Lombok 简化代码,不需要写 Getter 和 Setter 方法。需要在 Class 上面加 @Data 这个注解
User.java
@Data
public class User {
private Long id; // 用户 id
private String name; // 用户名
private Integer age; // 用户年龄
private String email; // 用户邮箱
}
2. 编写 Mapper 类
UserMapper.java
@Repository
public interface UserMapper extends BaseMapper<User> {
}
注意:
Mapper 需要继承 BaseMapper 接口,继承该接口后,无需编写 mapper.xml 文件,即可获得 CRUD 功能。
说明:
通用 CRUD 封装 BaseMapper 接口,为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器
泛型 T 为任意实体对象
3. 添加测试类,进行功能测试
@SpringBootTest
public class DemoTest {
@Autowired
private UserMapper userMapper;
/**
查询所有的用户
*/
@Test
public void testGetAllUser() {
List<User> users = userMapper.selectList(null);
for (int i = 0; i < users.size(); i++) {
System.out.println(users.get(i));
}
}
}
控制台输出结果:
User(id=1, name=parker, age=18, email=parker@126.com)
User(id=2, name=manu, age=16, email=manu@qq.com)
User(id=3, name=扬帆向海, age=19, email=yang@126.com)
五、分页
MyBatis Plus 自带分页插件,只要简单的配置即可实现分页功能
1. 创建配置类
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service..mapper")
public class MybatisPlusConfig {
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
// 设置请求的页面大于最大页后操作, true 调回到首页,false 继续请求 默认 false
// paginationInterceptor.setOverflow(false);
// 设置最大单页限制数量,默认 500 条,-1 不受限制
// paginationInterceptor.setLimit(500);
return paginationInterceptor;
}
}
2. 测试分页功能
/**
mp 实现分页
*/
@Test
public void testPage() {
// 创建 page 对象,传递两个参数:当前页和每页记录数
Page<User> page = new Page<>(1, 3);
// 分页查询
userMapper.selectPage(page, null);
// 通过 page 对象获取分页数据
List<User> records = page.getRecords(); // 每页数据
long current = page.getCurrent(); // 当前页
long pages = page.getPages();// 总页数
long total = page.getTotal();// 总记录数
long size = page.getSize();// 每页记录数
boolean previous = page.hasPrevious();// 是否有上一页
boolean next = page.hasNext();// 是否有下一页
System.out.println(records);
System.out.println(current);
System.out.println(pages);
System.out.println(total);
System.out.println(size);
System.out.println(previous);
System.out.println(next);
}
六、自动填充功能
项目中经常会遇到一些数据,每次都使用相同的方式填充,例如记录的创建时间,更新时间等。
我们可以使用 MyBatis Plus 的自动填充功能,完成这些字段的赋值工作:
1. 数据库表中添加自动填充字段
在 User 表中添加 datetime 类型的新的字段 create_time、update_time
2. 实体上添加注解
@Data
public class User {
// 为了节约篇幅,在此删除了其他属性字段
@TableField(fill = FieldFill.INSERT)
private Date createTime; // 创建时间
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime; // 修改时间
}
3. 实现元对象处理器接口
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
在 mp 执行添加操作的时候运行(会将 createTime 和 updateTime 加入到数据库中)
@param metaObject
*/
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
/**
在 mp 执行修改操作的时候运行
@param metaObject
*/
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
七、逻辑删除
物理删除:真实删除,将对应数据从数据库中删除,之后查询不到此条被删除数据
逻辑删除:假删除,将对应数据中代表是否被删除字段状态修改为“被删除状态”,之后在数据库中仍旧能看到此条数据记录
1.数据库中添加 deleted 字段
ALTER TABLE user
ADD COLUMN deleted
boolean
2. 实体类添加 deleted 字段
注意:需要加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解
@TableField(fill = FieldFill.INSERT)
@TableLogic // 用于逻辑删除的注解
private Integer deleted; // 逻辑删除标记
3. 元对象处理器接口添加 deleted 的 insert 默认值
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
// 添加逻辑删除的默认值
this.setFieldValByName("deleted", 0, metaObject);
}
4. application.properties 加入配置
此为默认值,如果你的默认值和 mp 默认的一样,该配置可无
0 表示没删除,1 表示删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
5. 在 MybatisPlusConfig 中注册 Bean
@EnableTransactionManagement // 事务
@Configuration // 标明是一个配置类
@MapperScan("com.zxy.mpdemo.mapper")
public class MybatisPlusConfig {
/**
逻辑删除
@return
*/
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
}
八、乐观锁
意图:
当要更新一条记录的时候,希望这条记录没有被别人更新
评论