Mybatis-Plus指南
一、快速入门
配置数据库
# 建表
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
#插入数据
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
创建springboot工程,导入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
连接数据库配置
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimeZone=GMT%2b8
username: root
password: 1234567890
创建实体类(lombok)
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private int age;
private String email;
}
创建mapper接口继承BaseMapper
继承了BaseMapper接口后,基本的CRUD,Mybatis-Plus都已经帮你自动实现了
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.lzp.mybatis_plus.pojo.User;
import org.springframework.stereotype.Repository;
@Repository
public interface UserMapper extends BaseMapper<User> {
}
在启动类配置mapper接口扫描
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("com.lzp.mybatis_plus.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
测试
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
public void test1() {
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
二、配置日志
yml配置日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
控制台输出样式
Creating a new SqlSession
SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@643d2dae] was not registered for synchronization because synchronization is not active
JDBC Connection [HikariProxyConnection@737892411 wrapping com.mysql.cj.jdbc.ConnectionImpl@73ae0257] will not be managed by Spring
==> Preparing: SELECT id,name,age,email FROM user
==> Parameters:
<== Columns: id, name, age, email
<== Row: 1, Jone, 18, test1@baomidou.com
<== Row: 2, Jack, 20, test2@baomidou.com
<== Row: 3, Tom, 28, test3@baomidou.com
<== Row: 4, Sandy, 21, test4@baomidou.com
<== Row: 5, Billie, 24, test5@baomidou.com
<== Total: 5
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@643d2dae]
User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)
三、CRUD扩展
插入测试
插入测试
@Test
public void test2() {
User user = new User();
user.setAge(23);
user.setEmail("280711156@qq.com");
user.setName("李志鹏2");
int result = userMapper.insert(user);
System.out.println(result);
System.out.println(user);
}
主键生成策略
默认:ID_WORKER 全局唯一id
雪花算法:
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。
自增策略: AUTO
- 实体类主键上设置
@TableId(type = IdType.AUTO)
- 数据库主键设置为自增
不使用主键生成策略:NONE
手动设置id: INPUT
插入数据时需要自己手动设置id。
全局唯一id: UUID
常见的方式。可以利用数据库也可以利用程序生成,一般来说全球唯一。
字符串表示法: ID_WORKER_STR
更新测试
@Test
public void test3() {
User user = new User();
// 通过条件自动拼接动态sql
user.setId(5L);
user.setName("黄园娥");
int result = userMapper.updateById(user);
System.out.println(result);
}
自动填充
创建时间,修改时间,这个操作都是自动化完成的,不希望手动更新
方式一:数据库级别(工作中不允许修改数据库,不推荐使用)
1.在表中新增create_time和update_time字段,并设置默认值为CURRENT_TIMESTAMP, update_time设置随时间戳更新
2.在实体类中同步属性
3.再次测试更新操作时就会自动填充创建时间和更新时间
方式二:代码级别
1.删除数据库中设置的默认值和随时间戳更新配置
2.实体类中对应属性添加自动填充注解
@TableField(fill = FieldFill.INSERT) // 插入时自动填充
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) // 插入和更新时自动填充
private Date updateTime;
乐观锁
乐观锁:执行操作时,总是认为不会出现问题,无论干什么都不去上锁,如果出现了问题,再去更新值测试。
悲观锁:执行操作时,总是认为会出现问题,无论干什么都去上锁,再去执行操作。
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = newVersion where version = oldVersion
- 如果version不对时,就更新失败
#乐观锁:更新时要求version = 1,如果不等于则更新失败
-- A线程
update user set name = "lzp", version = version + 1 where id = 2 and version = 1;
-- B线程 B线程如果抢先完成,导致version = 2,会导致A线程更新失败!
update user set name = "lzp", version = version + 1 where id = 2 and version = 1;
测试Mybatis-Plus乐观锁的插件
-
给数据库增加version字段
-
实体类增加对应version属性
@Version private Integer version;
-
注册乐观锁插件
@MapperScan("com.lzp.mybatis_plus.mapper") @EnableTransactionManagement // 开启事务管理 @Configuration public class MybatisPlusConfig { // 注册乐观锁插件 @Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() { return new OptimisticLockerInterceptor(); } }
-
测试
// 乐观锁成功测试 @Test public void test4() { User user = userMapper.selectById(1L); user.setName("lizhipeng"); user.setEmail("280711156@qq.com"); userMapper.updateById(user); } // 乐观锁失败测试 @Test public void test5() { User user = userMapper.selectById(1L); user.setName("lizhipeng"); user.setEmail("280711156@qq.com"); // 模拟另一个线程在上一个还未执行更新操作时修改了数据 User user2 = userMapper.selectById(1L); user2.setName("huangyuane"); user2.setEmail("280711156@qq.com"); userMapper.updateById(user2); userMapper.updateById(user); // 更新失败 }
查询测试
根据id查询
@Test
public void test6() {
User user = userMapper.selectById(1L);
System.out.println(user);
}
批量查询
@Test
public void test7() {
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
条件查询map
@Test
public void test8() {
Map<String, Object> map = new HashMap<>(); // map可以设置多个条件
map.put("name", "李志鹏");
map.put("age", 23);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
在MyBatisPlusConfig中注册拦截器插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
测试分页
@Test
public void test9() {
Page<User> page = new Page<>(1, 5);
userMapper.selectPage(page, null);
List<User> users = page.getRecords();
users.forEach(System.out::println);
}
删除测试
根据id删除
@Test
public void test10() {
userMapper.deleteById(1293200249847857157L);
}
批量删除
@Test
public void test11() {
userMapper.deleteBatchIds(Arrays.asList(1293200249847857155L, 1293200249847857156L));
}
根据条件删除map
@Test
public void test12() {
Map<String, Object> map = new HashMap<>();
map.put("name", "李志鹏");
userMapper.deleteByMap(map);
}
逻辑删除
物理删除:直接从数据库中移除
逻辑删除:在数据库中没有移除,而是通过一个变量让它失效。deleted = 0 ==> deleted = 1
-
在数据库中添加一个逻辑删除字段deleted,默认值为0
-
实体类添加对应属性
@TableLogic private Integer deleted; // 逻辑删除
-
在MyBatisPlusConfig中注册逻辑删除插件
@Bean public ISqlInjector iSqlInjector() { return new LogicSqlInjector(); }
-
测试删除,发现数据库数据没有被移除,只是deleted字段被更新为1
性能分析插件
-
导入插件
@Bean @Profile({"dev", "test"}) // 设置dev,test环境开启,保证效率 public PerformanceInterceptor performanceInterceptor() { PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); performanceInterceptor.setMaxTime(100); // 单位:ms,设置sql最大执行时间,超时就不执行 performanceInterceptor.setFormat(true); // 开启sql格式化 return performanceInterceptor; }
-
测试
@Test public void test1() { List<User> users = userMapper.selectList(null); users.forEach(System.out::println); }
-
控住台会打印执行时间和格式化sql
Creating a new SqlSession SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2f7efd0b] was not registered for synchronization because synchronization is not active JDBC Connection [HikariProxyConnection@1015367506 wrapping com.mysql.cj.jdbc.ConnectionImpl@3ddeaa5f] will not be managed by Spring ==> Preparing: SELECT id,name,age,email,version,deleted,create_time,update_time FROM user WHERE deleted=0 ==> Parameters: <== Columns: id, name, age, email, version, deleted, create_time, update_time <== Row: 2, Jack, 20, test2@baomidou.com, 1, 0, 2020-08-12 14:03:57, 2020-08-12 16:16:25 <== Row: 3, Tom, 28, test3@baomidou.com, 1, 0, 2020-08-12 14:04:02, 2020-08-12 16:16:30 <== Row: 4, Sandy, 21, test4@baomidou.com, 1, 0, 2020-08-12 16:16:19, 2020-08-12 16:16:34 <== Row: 5, 黄园娥2, 0, test5@baomidou.com, 1, 0, 2020-08-12 16:16:22, 2020-08-12 09:54:43 <== Total: 4 Time:25 ms - ID:com.lzp.mybatis_plus.mapper.UserMapper.selectList Execute SQL: SELECT id, name, age, email, version, deleted, create_time, update_time FROM user WHERE deleted=0 Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2f7efd0b] User(id=2, name=Jack, age=20, email=test2@baomidou.com, version=1, deleted=0, createTime=Thu Aug 13 03:03:57 CST 2020, updateTime=Thu Aug 13 05:16:25 CST 2020) User(id=3, name=Tom, age=28, email=test3@baomidou.com, version=1, deleted=0, createTime=Thu Aug 13 03:04:02 CST 2020, updateTime=Thu Aug 13 05:16:30 CST 2020) User(id=4, name=Sandy, age=21, email=test4@baomidou.com, version=1, deleted=0, createTime=Thu Aug 13 05:16:19 CST 2020, updateTime=Thu Aug 13 05:16:34 CST 2020) User(id=5, name=黄园娥2, age=0, email=test5@baomidou.com, version=1, deleted=0, createTime=Thu Aug 13 05:16:22 CST 2020, updateTime=Wed Aug 12 22:54:43 CST 2020)
条件构造器测试
查询name不为null,email不为null,age大于15岁的用户
@Test
public void test1() {
// 查询name不为null,email不为null,age大于15岁的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name") // name不为null
.isNotNull("email") // email不为null
.ge("age", 15); // age大于15
List<User> users = userMapper.selectList(wrapper); // 多个条件
users.forEach(System.out::println);
}
查询name为黄园娥的用户
@Test
public void test2() {
// 查询name为黄园娥的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "黄园娥");
User user = userMapper.selectOne(wrapper);
System.out.println(user);
}
统计年龄在20~30岁之间的用户数
@Test
public void test3() {
// 统计年龄在20~30岁之间的用户数
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 20, 30);
Integer count = userMapper.selectCount(wrapper);
System.out.println(count);
}
查询名称中不包含a的用户,并且邮箱以t开头
@Test
public void test4() {
// 查询名称中不包含a的用户,并且邮箱以t开头
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name", "a")
.likeRight("email", "t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
id在子查询中查询
@Test
public void test5() {
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id在子查询中查询
wrapper.inSql("id", "select id from user where id > 3");
List<Object> objs = userMapper.selectObjs(wrapper);
objs.forEach(System.out::println);
}
查询所有,id倒序展示
@Test
public void test6() {
// 查询所有,id倒序展示
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
代码自动生成器
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
public class CodeGenerator {
public static void main(String[] args) {
// 构建一个代码自动生成器对象
AutoGenerator generator = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir"); // 获取项目目录
gc.setOutputDir(projectPath + "/src/main/java"); // 设置代码输入目录
gc.setAuthor("李志鹏"); // 设置作者
gc.setOpen(false); // 创建成功时是否自动打开所在文件夹
gc.setFileOverride(false); // 是否覆盖
gc.setServiceName("%sService"); // 设置service包名称
gc.setIdType(IdType.ID_WORKER); // 设置主键生成策略
gc.setDateType(DateType.ONLY_DATE); // 设置时间格式
gc.setSwagger2(true); // 设置swagger
generator.setGlobalConfig(gc);
// 设置数据源
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimeZone=GMT%2b8");
dataSource.setUsername("root");
dataSource.setPassword("1234567890");
dataSource.setDbType(DbType.MYSQL); // 设置数据库类型
generator.setDataSource(dataSource);
// 包的设置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setParent("com.lzp");
packageConfig.setModuleName("mybatis_plus");
packageConfig.setController("controller");
packageConfig.setService("service");
packageConfig.setMapper("mapper");
packageConfig.setEntity("pojo");
generator.setPackageInfo(packageConfig);
// 策略配置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("user"); // 设置需要映射的表名
strategyConfig.setNaming(NamingStrategy.underline_to_camel); // 对应实体类名称设置驼峰命名规则
strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel); // 对应属性名称设置驼峰命名规则
strategyConfig.setEntityLombokModel(true); // 设置lombok
strategyConfig.setVersionFieldName("version"); // 设置乐观锁字段
strategyConfig.setLogicDeleteFieldName("deleted"); // 设置逻辑删除字段
ArrayList<TableFill> tableFills = new ArrayList<>();
TableFill createTime = new TableFill("create_time", FieldFill.INSERT); // 创建时间插入时自动填充
TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE); // 更新时间插入和更新时自动填充
tableFills.add(createTime);
tableFills.add(updateTime);
strategyConfig.setTableFillList(tableFills); // 设置自动填充规则
strategyConfig.setRestControllerStyle(true); // 开启rest风格controller
strategyConfig.setControllerMappingHyphenStyle(true); // mapping中驼峰转连字符_
generator.setStrategy(strategyConfig);
// 执行代码自动生成
generator.execute();
}
}