MyBatisPlus
特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
- 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
- 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
- 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
- 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
- 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
- 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
- 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
- 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
- 内置性能分析插件：可输出 SQL 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
- 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
支持数据库
任何能使用
MyBatis进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。
- MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
- 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库
快速入门
导入Pom配置文件
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--3.mybatis-plus 版本很重要3.0.5-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--4.h2-->
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.4.200</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>
连接数据库配置
#数据库连接配置
spring.datasource.username=root
spring.datasource.password=123456
#mysql5~8 驱动不同driver-class-name 8需要增加时区的配置serverTimezone=UTC
#useSSL=false 安全连接
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
编写实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private int id;
private String name;
private Integer age;
private String email;
}
编写实体类对应的mapper接口
//在对应的接口上面继承一个基本的接口 BaseMapper@Repository//代表持久层public interface UserMapper extends BaseMapper<User> { //所有CRUD操作都编写完成了，不用像以前一样配置一大堆文件}
在主启动类添加@MapperScan注解
@MapperScan("com.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
进行Test测试
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
}
结果
配置日志
#配置日志 log-impl:日志实现
mybatis-plus.configuration.logimpl=org.apache.ibatis.logging.stdout.StdOutImpl
CRUD扩展
Insert
@Test
public void insertTest(){
User user = new User();
user.setName("陈平安");
user.setAge(18);
user.setEmail("12345");
Integer result = userMapper.insert(user);//会帮我们自动生成id
System.out.println(result);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
数据库插入的id的默认值为:全局的唯—id
主键生成策略
源码解释
public enum IdType {
AUTO(0), //数据库id自增
NONE(1),//未设置主键
INPUT(2),//手动输入
ID_WORKER(3),//默认的全局唯一id
UUID(4),//全局唯一id uuid
ID_WORKER_STR(5);//ID_WORKER 字符表示法
**
}
分布式系统唯一Id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html
- Twitter的snowflake算法
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心（北京、香港···），5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。
*主键自增：AUTO 我们需要配置主键自增*
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
@TableId(type = IdType.AUTO)
private int id;
private String name;
private Integer age;
private String email;
}
Update
@Test
public void updateTest(){
User user = new User();
user.setId(6L);
user.setName("安");
user.setAge(18);
user.setEmail("12345");
int i = userMapper.updateById(user);
System.out.println(i);//受影响的行数
}
所有的sql都是自动动态配置的
自动填充
创建时间、更改时间！ 这些操作一般都是自动化完成，我们不希望手动更新
阿里巴巴开发手册︰几乎所有的表都要配置 gmt_create、gmt_modified ！而且需要自动化
方式一：数据库级别（工作中不允许修改数据库级别）
1、在表中增加字段：create_time,update_time
CURRENT_TIMESTAMP
2、再次测试插入或更新方法，我们需要在实体类中同步！
private Date createTime;
private Date updateTime;
方式二：代码级别
1、删除数据库的默认值，更新操作！
2、实体类字段属性上需要增加注解
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)//插入时添加时间
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)//插入和更新时添加时间
private Date updateTime;
3.编写处理器来处理这个注解即可！
@Slf4j//输出日志
@Component//注入springboot
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入时操作
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ...");
// default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
this.setFieldValByName("createTime", new Date(),metaObject);
this.setFieldValByName("updateTime", new Date(),metaObject);
}
//更新时操作
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime", new Date(),metaObject);
}
}
4.测试插入/更新，观察时间
@Test
public void insertTest(){
User user = new User();
user.setName("平安");
user.setAge(18);
user.setEmail("12345");
Integer result = userMapper.insert(user);//会帮我们自动生成id
System.out.println(result);//受影响的行数
System.out.println(user);//通过日志发现id会自动回填
}
@Test
public void updateTest(){
User user = new User();
user.setId(6L);
user.setName("chen安");
user.setAge(18);
user.setEmail("12345");
int i = userMapper.updateById(user);
System.out.println(i);//受影响的行数
}
乐观锁&悲观锁
乐观锁：顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不上锁!如果出现了问题,再次更新值测试
悲观锁：顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!
乐观锁实现方式:
- 取出记录时,获取当前version
- 更新时,带上这个version
- 执行更新时,set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
1、给数据库中增加version字段
2、实体类加对应的字段
@Version//乐观锁注解
private int version;
3、注册组件
@MapperScan("com.mapper")//扫描mapper文件夹
@EnableTransactionManagement//自动管理事务
@Configuration
public class MybatisPlusConfig {
/**
* 旧版
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
4、测试
//测试乐观锁成功
@Test
public void testOptimisticLocker(){
//查询用户信息
User user = userMapper.selectById(1L);
//修改信息
user.setName("宁姚");
user.setEmail("12344566");
//执行操作
userMapper.updateById(user);
}
//测试乐观锁失败 多线程下
@Test
public void testOptimisticLocker2(){
//查询用户信息
User user = userMapper.selectById(1L);
//修改信息
user.setName("宁姚1");
user.setEmail("12344566");
//模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
//修改信息
user2.setName("宁姚2");
user2.setEmail("12344566");
userMapper.updateById(user2);
//执行操作
userMapper.updateById(user);//如果没有乐观锁就会覆盖插队线程的值
}
Select
通过id查询单个用户
@Test
public void testselectByid(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
通过id查询多个用户
@Test
public void testselectBatchIds(){
List<User> user = userMapper.selectBatchIds(Arrays.asList(1L,2L,3L));
user.forEach(System.out::println);
}
条件查询 通过map封装
@Test
public void testMap(){
HashMap<String,Object> map = new HashMap<>();
//条件
map.put("name","平安");
map.put("age","18");
List<User> userList = userMapper.selectByMap(map);
userList.forEach(System.out::println);
}
分页查询
配置拦截器组件
//分页插件
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
直接使用page对象
//分页查询
@Test
public void page(){
//参数一current：当前页 参数二size：页面大小
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println("总页数==>"+page.getTotal());
}
Delete
@Test
//通过id删除
public void testDeleteById(){
userMapper.deleteById(1L);
}
@Test
//通过id批量删除
public void testDeleteBatchIds(){
userMapper.deleteBatchIds(Arrays.asList(5L,6L));
}
@Test
//通过map条件删除
public void testD(){
HashMap<String, Object> map = new HashMap<>();
map.put("age","18");
map.put("name","chen安");
userMapper.deleteByMap(map);
}
逻辑删除
1、在数据表中增加一个deleted字段
2、实体类中添加对应属性
@TableLogic//逻辑删除
private Integer deleted;
3、配置！
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
#配置逻辑删除 没删除的为0 删除的为1mybatis-plus.global-config.db-config.logic-delete-value=1mybatis-plus.global-config.db-config.logic-not-delete-value=0
测试
@Test
public void deleteByid(){
userMapper.deleteById(1L);
}
发现： 记录还在，deleted变为1
再次测试查询被删除的用户，发现查询为空
性能分析插件
MybatisPlus也提供了性能分析插件，如果超过这个时间就停止运行！
性能分析拦截器作用：用于输出每条sql语句及其执行时间
1.、导入插件
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100);//设置sql最大执行时间*ms，如果超过了则不执行
performanceInterceptor.setFormat(true);//开启sql格式化
return performanceInterceptor;
}
要在SpringBoot中配置环境为dev或test环境！
#设置开发环境
spring.profiles.active=dev
2、测试
@Test
void contextLoads() {
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
条件构造器
Wrapper
测试
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//查询name不为空,邮箱不为空,年龄大于等于12
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.isNotNull("name")
.isNotNull("email")
.ge("age", 12)
;
userMapper.selectList(queryWrapper).forEach(System.out::println);
}
@Test
//查询名字为chen安
void test2() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.eq("name", "chen安");
User user = userMapper.selectOne(queryWrapper);//查询一个数据
System.out.println(user);
}
@Test
//查询年龄20到30岁之间的
void test3() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.between("age", 20, 30);//区间
Integer count = userMapper.selectCount(queryWrapper);
System.out.println(count);//查询结果数
userMapper.selectList(queryWrapper).forEach(System.out::println);//查询结果
}
@Test
//模糊查询
//name中不含e的 email中t开头的
void test4() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
//左和右 t%
.notLike("name", "e")
.likeRight("email", "t");
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
maps.forEach(System.out::println);
}
@Test
//模糊查询
id 在子查询中查出来
void test5() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.inSql("id","select id from user where id<3");
List<Object> objects = userMapper.selectObjs(queryWrapper);
objects.forEach(System.out::println);
}
@Test
//通过id进行排序 升序
void test6() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.orderByAsc("id");
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
@Test
//通过id进行排序 降序
void test7() {
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper
.orderByDesc("id");
List<User> users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);
}
代码自动生成器
重点
设置要映射的表名 可以填入多个值
strategy.setInclude(“”,“”,“”,);
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotaion.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 Code {
public static void main(String[] args) {
//构建一个代码自动生成器 对象
AutoGenerator autoGenerator = new AutoGenerator();
//配置策略
//1.全局配置
GlobalConfig globalConfig = new GlobalConfig();
String property = System.getProperty("user.dir");
globalConfig.setOutputDir(property + "/src/main/java");
//作者
globalConfig.setAuthor("陈平安");
//是否打开文件管理器
globalConfig.setOpen(false);
//是否覆盖原来生成的
globalConfig.setFileOverride(false);
//去service的I前缀
globalConfig.setServiceName("%sService");
//默认初始的算法 ID_WORKER 默认的全局唯一id
globalConfig.setIdType(IdType.ID_WORKER);
//设置日期类型,普通类型
globalConfig.setDateType(DateType.ONLY_DATE);
//生成swagger 文档
globalConfig.setSwagger2(true);
//全局生成器
autoGenerator.setGlobalConfig(globalConfig);
//2.配置数据源
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=GMT%2B8");
dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("123456");
dataSourceConfig.setDbType(DbType.MYSQL);
autoGenerator.setDataSource(dataSourceConfig);
//3.包的配置
PackageConfig packageConfig = new PackageConfig();
//生成模块的名字
packageConfig.setModuleName("blog");
packageConfig.setParent("com");
packageConfig.setEntity("entity");
packageConfig.setMapper("mapper");
packageConfig.setService("service");
packageConfig.setController("controller");
autoGenerator.setPackageInfo(packageConfig);
//4.策略
StrategyConfig strategy = new StrategyConfig();
//设置要映射的表名
strategy.setInclude("user");
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);//lombok自动
//逻辑删除
strategy.setLogicDeleteFieldName("deleted");
//自动填充配置
TableFill createTime = new TableFill("createTime", FieldFill.INSERT);
TableFill updateTime = new TableFill("updateTime", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
//乐观锁
strategy.setVersionFieldName("version");
//驼峰命名
strategy.setRestControllerStyle(true);
//下划线拼接 localhost:8080/hello_id_2
strategy.setControllerMappingHyphenStyle(true);
autoGenerator.setStrategy(strategy);
//执行
autoGenerator.execute();
}
}
el(true);//lombok自动
//逻辑删除
strategy.setLogicDeleteFieldName("deleted");
//自动填充配置
TableFill createTime = new TableFill("createTime", FieldFill.INSERT);
TableFill updateTime = new TableFill("updateTime", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
//乐观锁
strategy.setVersionFieldName("version");
//驼峰命名
strategy.setRestControllerStyle(true);
//下划线拼接 localhost:8080/hello_id_2
strategy.setControllerMappingHyphenStyle(true);
autoGenerator.setStrategy(strategy);
//执行
autoGenerator.execute();
}
}
本文含有隐藏内容，请 开通VIP 后查看