MyBatis-Plus
官方地址:https://baomidou.com
1、简介
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性:
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
2、快速开始
1、新建表
DROP TABLE IF EXISTS user;
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)
);
DELETE FROM user;
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');
2、导入依赖
<!--mybatis-plus-->
<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
3、配置文件
spring:
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=utf8
driver-class-name: com.mysql.jdbc.Driver
#mybatis-plus
#配置日志,也就是控制台打印输出Sql语句
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
4、新建实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
5、编写接口继承BaseMapper类
@Repository
public interface UserMapper extends BaseMapper<User> {
}
6、启动类添加注解
@MapperScan("edu.hunnan.net.mapper")
7、测试
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
OK,连接成功
3、CRUD
1、插入
//插入测试
@Test
void insert(){
User user = new User();
user.setAge(10).setName("李四").setEmail("3124850@qq.com");
userMapper.insert(user);
}
可以看到这里没有设置id,id生成的策略是默认的
这里我们需要配置id主键生成策略
2、主键生成策略
实体类上添加注解
@TableId(type = IdType.AUTO)
private Long id;
注意设置数据库主键id自增,数据库需要勾选主键自增
所有策略
3、更新
//更新
@Test
void updata(){
User user = new User();
user.setId(5L);
user.setName("张三");
userMapper.updateById(user);
}
自动拼接SQL,类似MyBatis动态SQL语句
4、自动填充
1、数据库添加两个字段
插入时间,更新时间
2、实体类添加注解
//插入操作
@TableField(fill = FieldFill.INSERT)
private Date create_time;
//更新和插入
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updata_time;
3、添加工具类
@Component
public class MyBatisMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("create_time",new Date(),metaObject);
this.setFieldValByName("updata_time",new Date(),metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updata_time",new Date(),metaObject);
}
}
4、测试
5、查询
//查询
@Test
void select(){
//根据id
User user = userMapper.selectById(5L);
System.err.println(user);
//map查询
HashMap<String, Object> map = new HashMap<>();
map.put("name","张三");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
6、删除
//删除
@Test
void delect(){
//根据id
userMapper.deleteById(6);
//对象
User user = new User();
user.setId(5L);
userMapper.deleteById(user);
//map
HashMap<String, Object> map = new HashMap<>();
map.put("name","Sandy");
userMapper.deleteByMap(map);
}
7、分页查询
1、添加分页插件
@Configuration
@MapperScan("edu.hunnan.net.mapper")
public class MyBatisPlusConfig {
//配置分页插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor(){
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//数据库类型是MySql,因此参数填写DbType.MYSQL
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
2、测试
//分页查询
@Test
void limit(){
/**
* 参数一:第几页,参数二:显示几条
*/
Page<User> page = new Page<>(1,2);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
}
3、搜索+分页
<!--根据申请人id查询自己申请的会议 带搜索和分页功能-->
<select id="search2" resultType="edu.hunnan.net.pojo.TMeeting" >
<!--都不满足则查询所有-->
SELECT * FROM `t_meeting` tm
<where>
<!--根据申请人id查询自己申请的会议-->
<if test="userid != ''">
tm.userid=#{userid}
</if>
<!--会议时间 模糊查询-->
<if test="meetingDataTime != ''">
AND tm.meeting_data_time like concat('%', #{meetingDataTime},'%')
</if>
<!--会议地点 精准查询-->
<if test="meetingPlace != ''">
AND tm.meeting_place like #{meetingPlace}
</if>
<!--会议标题 模糊查询-->
<if test="meetingTitle != ''">
AND tm.meeting_title like concat('%',#{meetingTitle},'%')
</if>
<!--审批状态 精准查询-->
<if test="isStatus != ''">
AND tm.is_status like #{isStatus}
</if>
</where>
</select>
接口
Page<TMeetingUser> page,
4、代码自动生成器(新版)
1、导入依赖
<!--代码自动生成-->
<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-generator -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.2</version>
</dependency>
<!-- 模板引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
2、编写
官方地址:https://baomidou.com/pages/981406/
package edu.hunnan.net;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import java.util.Collections;
public class Auto {
public static void main(String[] args) {
String dbUrl = "jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=utf8";
String outPut = "src/main/java";
FastAutoGenerator.create("jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=utf8","root","123456")
.globalConfig(builder -> {
builder.author("向培") //作者
.outputDir(System.getProperty("user.dir")+"\\src\\main\\java") //输出路径(写到java目录)
.commentDate("yyyy-MM-dd")
.fileOverride(); //开启覆盖之前生成的文件
})
.packageConfig(builder -> {
builder.parent("edu.hunnan.net.mybatiplus")//目录
.moduleName("practice")
.entity("entity")
.service("service")
.serviceImpl("service.impl")
.controller("controller")
.mapper("mapper")
.xml("mapper")
.pathInfo(Collections.singletonMap(OutputFile.xml, System.getProperty("user.dir") +"\\src\\main\\resources\\mapper")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("user")
.addTablePrefix("p_")
.serviceBuilder()
.formatServiceFileName("%sService")
.formatServiceImplFileName("%sServiceImpl")
.entityBuilder()
.enableLombok()
.logicDeleteColumnName("deleted")
.enableTableFieldAnnotation()
.controllerBuilder()
.formatFileName("%sController")
.enableRestStyle()
.mapperBuilder()
.enableBaseResultMap() //生成通用的resultMap
.formatMapperFileName("%sMapper")
.enableMapperAnnotation()
.formatXmlFileName("%sMapper");
})
.execute();
}
}
5、工具
1、dao
@Mapper
@Repository
public interface CooperateWithMapper extends BaseMapper<CooperateWith> {
}
2、service
public interface CooperateWithService extends IService<CooperateWith> {
}
3、serviceimpl
@Service
public class CooperateWithServiceImpl extends ServiceImpl<CooperateWithMapper, CooperateWith> implements CooperateWithService {
}
拓展接口
集成他理由有很多方法,比如新增/保存是一个方法
4、获取自增id
@Options(useGeneratedKeys = true, keyProperty = "id", keyColumn = "id") //获取自增id
@Select("SELECT USERNAME,PASSWORD FROM user")
List<User> getUsersList();
5、逻辑删除
@TableLogic注解表示逻辑删除
1、在实体类中属性加上@TableLogic注解,表示该字段是逻辑删除字段。
2、增加注解后调用BaseMapper的deleteById(id)或者IService的removeById(id),是逻辑删除。如果没有增加该注解,是真删除。
3、@TableLogic注解参数
value = “未删除的值,默认值为0”
delval = “删除后的值,默认值为1”
如果不设置,就使用默认值
@TableLogic(value=“原值”,delval=“改值”)
1
4、 当使用了@TableLogic注解,调用update方法修改该字段的值是不会将该字段放入修改字段中,而是在条件字段中where条件后。
@TableLogic(value = "0",delval = "1")
private Integer isDel;
6、回顾配置文件
1、 type-aliases-package
简化操作 配置 type-aliases-package实体对象扫描包
1、为什么配置这个?
- 简单的说就是简化一个操作步骤
- 简化哪里的操作:简化xml文件中resultType中指定路径配置
2、哪里配置?
在项目的application配置文件中
//配置指定实体类文件路径,在使用的时候,会扫描这个文件下的内容
mybatis-plus.type-aliases-package=com.example.demo.domain
配置后就可以省去前面的路径,直接写类名
2、mapper-locations
1、mapper-locations
mapper-locations
是一个定义mapper接口
位置的属性,在xxx.yml或xxx.properties下配置,作用是实现mapper接口
配置
2、使用场景
- 当
mapper接口
和mapper接口对应的配置文件
在命名上相同 、所在的路径相同
,则mapper-locations可以不用配置,配置也不会生效。
如果mapper接口
和mapper接口对应的配置文件
在命名上不同或所在的路径不同
,配置mapper-locations才能实现接口的绑定。实现mapper接口
的绑定需要在配置文件中配置:
mybatis.mapper-locations=classpath:mapper/*Mapper.xml
- mapper接口:com.liuzeyu.mapper.UserMapper.java
- mapper接口对应的配置文件:mapper.UserMapper.xml
7、踩坑记录
1、解决@TableField(value = “**”) 字段不生效
故障原因:数据库字段与实体类字段不一致
解决方案
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!-- 全局参数 -->
<settings>
<!-- 使全局的映射器启用或禁用缓存 -->
<setting name="cacheEnabled" value="true" />
<!-- 允许JDBC 支持自动生成主键 -->
<setting name="useGeneratedKeys" value="true" />
<!-- 配置默认的执行器.SIMPLE就是普通执行器;REUSE执行器会重用预处理语句(prepared statements);BATCH执行器将重用语句并执行批量更新 -->
<setting name="defaultExecutorType" value="SIMPLE" />
<!-- 指定 MyBatis 所用日志的具体实现 -->
<setting name="logImpl" value="SLF4J" />
<!-- 使用驼峰命名法转换字段 -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
</configuration>
2、若依框架使用不了MyBatisPlus
解决方案:将SqlSessionFactoryBean修改成MybatisSqlSessionFactoryBean
@Bean
public MybatisSqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) throws Exception
{
String typeAliasesPackage = env.getProperty("mybatis.typeAliasesPackage");
String mapperLocations = env.getProperty("mybatis.mapperLocations");
String configLocation = env.getProperty("mybatis.configLocation");
typeAliasesPackage = setTypeAliasesPackage(typeAliasesPackage);
VFS.addImplClass(SpringBootVFS.class);
final MybatisSqlSessionFactoryBean sessionFactory = new MybatisSqlSessionFactoryBean ();
sessionFactory.setDataSource(dataSource);
sessionFactory.setTypeAliasesPackage(typeAliasesPackage);
sessionFactory.setMapperLocations(resolveMapperLocations(StringUtils.split(mapperLocations, ",")));
sessionFactory.setConfigLocation(new DefaultResourceLoader().getResource(configLocation));
return sessionFactory;
}