目录
官网:
MyBatis-Plushttps://baomidou.com/
项目代码在码云上:
MybatisPlus: 用来简化代码,快速开发https://gitee.com/DZ_QY/mybatis-plus.git
入门案例:
(1)首先创建数据库mybatis_plus
(2)创建user表
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)
);
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');
-- 真实开发中,version(乐观锁)、deleted(逻辑删除)、gmt_create(创建时间)、gmt_modified(更新时间)
(3)使用springboot初始化项目
(4)导入相关依赖(mybatis_plus依赖)
注意:使用mybatis可以帮助我们节省大量的代码,尽量不要同时导入mybatis和mybatis_plus。
<!-- 数据库驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus -->
<!-- mybatis-plus 是自己开发,并非官方的! -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
(5)连接数据库:
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同com.mysql.cj.jdbc.Driver、需要增加时区的配置
serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
使用mybatis-plus之后编写代码
(1)pojo【使用lombok】:
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
(2)mapper接口:
// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作都已经编写完成了
// 你不需要像以前的配置一大堆文件了!
}
(3)在主启动类上去扫描我们的mapper包下的所有接口:
@MapperScan("com.kuang.mapper")
(4)测试:
@SpringBootTest
class MybatisPlusApplicationTests {
// 继承了BaseMapper,所有的方法都来自己父类
// 我们也可以编写自己的扩展方法!
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 参数是一个 Wrapper ,条件构造器,这里我们先不用 null
// 查询全部用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
配置日志
我们所有的sql默认是不可见的,我们可以通过日志来查看它是怎样执行的。
在配置文件中进行配置:
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
在执行过程中我们可以清楚地发现mybatis_plus帮助我们实现的sql语句是怎样的,如下所示:
CRUD扩展:
insert插入操作
(1)代码测试:
// 测试插入
@Test
public void testInsert(){
User user = new User();
user.setName("狂神说Java");
user.setAge(3);
user.setEmail("24736743@qq.com");
int result = userMapper.insert(user); // 帮我们自动生成id
System.out.println(result); // 受影响的行数
System.out.println(user); // 发现,id会自动回填
}
(2)运行结果:
主键生成策略
默认 ID_WORKER 全局唯一id
分布式系统唯一id生成:https://www.cnblogs.com/haoxinyue/p/5208136.html
public enum IdType {
AUTO(0), // 数据库id自增
NONE(1), // 未设置主键
INPUT(2), // 手动输入
ID_WORKER(3), // 默认的全局唯一id
UUID(4), // 全局唯一id uuid
ID_WORKER_STR(5); //ID_WORKER 字符串表示法
}
雪花算法简介:
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为 毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味 着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。可以保证几乎全球唯 一!
注意:此时我们需要配置主键自增(AUTO),那么数据库中的主键id一定是自增。
//在id字段上添加注解
@TableId(type = IdType.AUTO)
更新操作
测试代码:
// 测试更新
@Test
public void testUpdate(){
User user = new User();
// 通过条件自动拼接动态sql
user.setId(6L);
user.setName("关注公众号:狂神说");
user.setAge(18);
// 注意:updateById 但是参数是一个 对象!
int i = userMapper.updateById(user);
System.out.println(i);
}
运行结果:
自动填充
创建时间、修改时间!这些操作一般都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册中所有的数据库表:gmt_create(创建时间)、gmt_modified(修改时间)几乎所有的表都要配置上,同时需要自动化!
数据库级别(工作中不允许修改数据库)
(1)在表中新增字段 create_time, update_time,默认值为:CURRENT_TIMESTAMP
(2)在实体类中添加这两个属性,重新测试插入方法
private Date createTime;
private Date updateTime;
(3)此时数据库中新增数据的时间与我们当前时间保持一致。
代码级别
(1)删除数据库的默认值
(2)此时实体类字段属性上需要增加注解
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
(3)在application.properties中配置日志,显示具体的执行过程
#配置日志,显示具体的执行过程
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
(4)编写处理器来处理该注解
//一定不要忘记把处理器添加到IOC容器中
//这些策略要想被识别,就丢到Springboot里面
@Component
//添加日志
@Slf4j
public class MyMMetaObjectHandler implements MetaObjectHandler {
//插入时候的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert .....");
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新时候的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update info......");
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
(5)测试插入
(6)测试更新操作,观察时间的变化
乐观锁机制
乐观锁 : 故名思意十分乐观,它总是认为不会出现问题,无论干什么不上锁!如果出现了问题, 就再次更新值测试。
悲观锁:故名思意十分悲观,它总是认为总是出现问题,无论干什么都会上锁!再去操作!
乐观锁的实现方式:
- 取出记录时,获取当前 version
- 更新时,带上这个version
- 执行更新时, set version = newVersion where version = oldVersion
- 如果version不对,就更新失败
测试使用乐观锁插件:
(1)给数据库中增加version字段,设定一个默认值1
(2)在实体类中添加相应的字段
@Version//乐观锁Version注解
private Integer version;
(3)注册乐观锁插件
直接在配置类中添加mapper扫描和开启事务管理的注解,此时主启动项中可以省略这些注解:
@MapperScan("com.zhao.mapper") //扫描mapper文件夹
@EnableTransactionManagement //开启事务管理
@Configuration //配置类
public class MyBatisPlusConfig {
//注册乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInnerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
(4)测试乐观锁插件(如果没有乐观锁,就会覆盖插队线程的值)
//测试乐观锁成功
@Test
public void testoptimisticLocker(){
//查询用户信息
User user = userMapper.selectById(7l);
//执行修改操作
user.setAge(2);
//更新用户信息
userMapper.updateById(user);
}
//测试乐观锁失败
@Test
public void testoptimisticLocker2(){
User user = userMapper.selectById(7l);
user.setAge(2);
//模拟另外一个线程进行了插队操作
User user2 = userMapper.selectById(7l);
user2.setAge(22);
userMapper.updateById(user2);
//乐观锁多次尝试提交
userMapper.updateById(user);// 如果没有乐观锁就会覆盖插队线程的值!
//总结:存在多线程进行操作时,一定要加上乐观锁
}
普通查询
//测试查询操作
@Test
public void testSelectById(){
User user = userMapper.selectById(7l);
System.out.println(user);
}
//批量查询【使用数组工具类】
@Test
public void testSelectBatchIds(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(3,7, 8));
users.forEach(System.out::println);
}
//条件查询(通过map集合)
@Test
public void testSelectByMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","奥利给");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
(1)在配置类中注册分页插件
//注册分页插件
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
(2)测试,直接使用Page对象即可
@Test
public void testPage(){
// 参数一:当前页
// 参数二:页面大小
// 使用了分页插件之后,所有的分页操作也变得简单
Page<User> page = new Page<>(1,2);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
物理删除操作
从数据库中直接移除:
//删除操作
@Test
public void deleteById(){
userMapper.deleteById(3l);
}
// 通过id批量删除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1l,2l));
}
// 通过map删除
@Test
public void testDeleteMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","奥利给");
userMapper.deleteByMap(map);
}
逻辑删除操作
逻辑删除【并不是真正的删除】,类似于回收站,防止数据的丢失
(1)在数据表中增加一个 deleted 字段,默认为0
(2)实体类中增加属性
@TableLogic//逻辑删除注解
private Integer deleted;
(3)在配置类中配置逻辑删除组件
//配置逻辑删除组件
@Bean
public ISqlInjector iSqlInjector(){
return new LogicSqlInjector();
}
(4)在application.properties中配置逻辑删除
# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
(5)测试:
执行上方物理删除的代码,我们在数据库中发现数据还存在,只是deleted的状态发生了变化。
此时测试查询操作,我们可以发现查询的时候会自动过滤掉被逻辑删除的字段:
性能分析插件
在平时的开发中,经常会遇到一些慢sql。
作用:性能分析拦截器,用于输出每条 SQL 语句及其执行时间
MP也提供性能分析插件,如果超过这个时间就停止运行!
(1)在application.properties中配置环境
#配置环境为开发(dev)或者测试(test)
spring.profiles.active=dev
(2)在配置文件中注册SQL执行效率插件
/**
* SQL执行效率插件
*/
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启,保证我们的效率
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(100); // ms设置sql执行的最大时间,如果超过了则不执行
performanceInterceptor.setFormat(true); // 是否格式化代码
return performanceInterceptor;
}
(3)测试:只要超过了规定时间就会抛出异常
@Test
void contextLoads() {
// 参数是一个 Wrapper ,条件构造器,这里我们先不用 null
// 查询全部用户
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
条件构造器【重要】
作用:我们写一些复杂的sql就可以使用它来替代;这里通过举几个常见的例子来进行说明
(1)查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
@Test
void contextLoads() {
// 查询name不为空的用户,并且邮箱不为空的用户,年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println); // 和我们刚才学习的map对比一下
}
(2)查询名字狂神说
@Test
void test2(){
// 查询名字狂神说
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","狂神说");
User user = userMapper.selectOne(wrapper); // 查询一个数据,出现多个结果使用List 或者 Map
System.out.println(user);
}
(3)查询年龄在 20 ~ 30 岁之间的用户人数
@Test
void test3(){
// 查询年龄在 20 ~ 30 岁之间的用户人数
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30); // 区间
Integer count = userMapper.selectCount(wrapper);// 查询结果数
System.out.println(count);
}
(4)模糊查询
// 模糊查询
@Test
void test4(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 t%
wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
(5)id 在子查询中查出来
@Test
void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询中查出来
wrapper.inSql("id","select id from user where id<3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
(6)通过id进行排序
@Test
void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
wrapper.orderByAsc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
代码自动生成器
在今后的工作中可以拿来直接使用:
package com.zhao;
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 mpg = new AutoGenerator();
// 配置策略
// 1、全局配置
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的I前缀
gc.setIdType(IdType.ID_WORKER);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
//2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus? useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.zhao");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user_say","user"); // 设置要映射的表名,通过逗号隔开
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动lombok;
strategy.setLogicDeleteFieldName("deleted");
// 自动填充配置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); //执行
}
}
项目总体目录结构如下: