赞
踩
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作,BaseMapper
强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求,以后简单的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 操作智能分析阻断,也可自定义拦截规则,预防误操作
使用第三方组件:
步骤
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)
);
-- 真实开发中必备字段:version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modified
插几条数据
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');
3、建个SpringBoot项目
删掉没用的文件
导入依赖
pom
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
说明:我们使用mybatis-plus可以节省我们大量的代码,尽量不要同时导入mybatis和mybatis-plus! 版本的差异!
4、连接数据库
这一步和 mybatis 一样
application.yml
spring:
#配置数据源
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf-8
username: root
password: 123456
#配置日志,我们所用的sql现在是不可见的,我们希望知道他是怎么执行的,所以我们必须要查看日志!
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
5、编写代码
mybatis-plus的使用步骤: 引入依赖 -> 创建pojo -> 实现dao接口(不用写mapper.xml文件,只需要在启动器上配置 mapper 扫描路径即可)-> 使用
实体类
package com.kuang.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
dao 接口
package com.kuang.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.kuang.pojo.User;
//在对应的Mapper上继承基本的类baseMapper
public interface UserMapper extends BaseMapper<User> { //指定泛型
//所有的CRUD已经编写完成
//不需要像以前的配置一些xml
}
启动类中添加 @MapperScan
注解 (非常重要,别写错了!)
package com.kuang;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.kuang.mapper")//扫描mapper文件夹
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
6、测试
package com.kuang; import com.kuang.mapper.UserMapper; import com.kuang.pojo.User; import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; import javax.annotation.Resource; import java.util.List; @SpringBootTest public class MybatisPlusTest { //继承了BaseMapper,所有方法都来自父类 //我们可以编写自己的拓展方法 @Resource private UserMapper userMapper; @Test public void testSelect() { System.out.println(("----- selectAll method test ------")); //参数是一个Wrapper,条件结构器,这里先不用 填null //查询所有的用户 List<User> userList = userMapper.selectList(null); userList.forEach(System.out::println); } }
执行 testSelect(),结果如下
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)
插入一条记录: int insert(T entity);
插入类型T:实体对象
@Test
public void testInsert() {
User user = new User();
user.setName("张三");
user.setAge(100);
user.setEmail("123@qq.com");
int result = userMapper.insert(user); //帮我们生成id
System.out.println(result); //受影响的行数
System.out.println(user); //发现id会自动回填
}
主键生成策略:
数据库插入的 id 为全局默认的 id(ID_WORKER
)
我们需要配置主键自增:
@TableId(type =IdType.AUTO)
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String name;
private Integer age;
private String email;
}
其余参数的含义:
public enum IdType { AUTO(0), //数据可id自增 NONE(1), //未设置主键 INPUT(2), //手动输入 ID_WORKER(3), //默认的全局唯一id UUID(4), //全局唯一id uuid ID_WORKER_STR(5); // ID_WORKEK 字符串表示法 private int key; private IdType(int key) { this.key = key; } public int getKey() { return this.key; } }
分布式系统唯一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。可以保证几乎全球唯一
再插入一个李四:id 确实自增了
动态sql
注意:updateById()参数是 一个对象!
//测试更新
@Test
public void testUpdate(){
User user = new User();
user.setId(2L);
user.setName("阿大");
//注意:updateById()参数是 一个对象!
int i = userMapper.updateById(user);
System.out.println(i);
}
创建时间、修改时间!这些个操作都是自动化完成的,我们不希望手动更新!
阿里巴巴开发手册:所有的数据库表:gmt_create .gmt_modified几乎所有的表都要配置上!而且需要自动化!
方式一:数据库级别(工作中是不允许修改数据库的)
1.在表中新增字段 create_time , update_time
两个字段都勾选:
2.再次测试插入方法,我们需要先把实体类同步
private Data creatTime;
private Data updateTime;
@Test
public void testUpdate(){
User user = new User();
user.setId(2L);
user.setAge(18);
user.setName("阿大");
//注意:updateById()参数是 一个对象!
int i = userMapper.updateById(user);
System.out.println(i);
}
方式二:代码级别
1.删除数据库所有字段的默认值
2.实体类字段属性上添加注解
//记住用util包下的Date!!
//字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3.编写处理器来处理这个注解
package com.kuang.handler; import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler; import lombok.extern.slf4j.Slf4j; import org.apache.ibatis.reflection.MetaObject; import org.springframework.stereotype.Component; import java.util.Date; @Slf4j @Component //把处理器加到IOC容器中 public class MyMetaObjectHandler implements MetaObjectHandler { //插入时的填充策略 @Override public void insertFill(MetaObject metaObject) { log.info("Start insert fill.... "); this.setFieldValByName("createTime",new Date(),metaObject); this.setFieldValByName("updateTime",new Date(),metaObject); } //更新时的填充策略 @Override public void updateFill(MetaObject metaObject) { log.info("Start update fill.... "); this.setFieldValByName("updateTime",new Date(),metaObject); } }
4.测试插入
@Test
public void testInsert() {
User user = new User();
user.setName("王八");
user.setAge(160);
user.setEmail("222@qq.com");
int result = userMapper.insert(user); //帮我们生成id
System.out.println(result); //受影响的行数
System.out.println(user); //发现id会自动回填
}
成功!
乐观锁:顾名思义十分乐观,他总是认为不会出现问题,无论干什么都不去上锁!如果出现了问题,再次更新值测试
悲观锁:顾名思义十分悲观,他总是认为出现问题,无论干什么都会上锁!再去操作!
我们这里主要讲解 乐观锁机制!
乐观锁实现方式:
案例:
1、给 user 表增加字段 version,默认值设为 1
现有数据的 version 都设置成 1
2、实体类 User 增加相应字段
@Version //乐观锁的注解
private Integer version;
3、注册组件
package com.kuang.config; import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor; import org.mybatis.spring.annotation.MapperScan; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.transaction.annotation.EnableTransactionManagement; @Configuration @EnableTransactionManagement @MapperScan("com.kuang.mapper")//主启动类上的这个注解可以去掉了 public class MyBatisPlusConfig { //注册乐观锁插件 @Bean public OptimisticLockerInterceptor optimisticLockerInterceptor() { return new OptimisticLockerInterceptor(); } }
4、测试一下
模拟成功的情况
@Test
public void testOptimisticLocker() {
// 1、查询用户信息
User user = userMapper.selectById(1L);
// 2、修改用户信息
user.setName("狂神");
user.setEmail("156420988@qq.com");
// 3、执行更新操作
userMapper.updateById(user);
}
version 更新为 2
模拟失败的情况
@Test public void testOptimisticLocker2() { //模拟线程1 User user = userMapper.selectById(1L); user.setName("狂神22"); user.setEmail("100000@qq.com"); //此时线程2插队执行 User user2 = userMapper.selectById(1L); user2.setName("狂神33"); user2.setEmail("1111111@qq.com"); userMapper.updateById(user2); //抢先 update userMapper.updateById(user); }
可以看到,线程 1 的修改并未生效!
//测试查询 @Test public void testSelectById(){ User user = userMapper.selectById(1L); System.out.println(user); } //测试批量查询 @Test public void testSelectBatchId(){ List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3)); users.forEach(System.out::println); } //按条件查询之--使用Map操作 @Test public void testSelectBatchIds(){ HashMap<String, Object> map = new HashMap<>(); map.put("name","狂神33"); map.put("age","18"); List<User> users = userMapper.selectByMap(map); users.forEach(System.out::println); }
分页在网站使用的十分之多!
1、原始的 limit 进行分页
2、pageHelper第三方插件
3、mybatis-plus其实也内置了分页插件!
如何使用?
配置拦截器组件即可
MyBatisPlusConfig 类
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
测试分页:
//测试分页查询
@Test
public void testPage() {
// 参数一:当前页
// 参数二:页面大小
// 使用了分页插件之后,所有的分页操作也变得简单了
Page<User> page = new Page<>(2, 5);
userMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
//获取总数
page.getTotal();
}
根据 entity 条件,删除记录: int delete(@Param(Constants.WRAPPER) Wrapper wrapper);
删除(根据ID 批量删除): int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
根据 ID 删除: int deleteById(Serializable id);
根据 columnMap 条件,删除记录:int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
参数类型说明:
测试删除:
@Test public void testDeleteById(){ userMapper.deleteById(1562632122919907329L); } //批量删除 @Test public void testDeleteBatchId(){ userMapper.deleteBatchIds(Arrays.asList(4,5)); } //条件删除 @Test public void testDeleteMap(){ HashMap<String,Object> map = new HashMap<>(); map.put("name","狂神33"); userMapper.deleteByMap(map); }
逻辑删除
物理删除 :从数据库中直接移出
逻辑删除:方便数据恢复和保护数据本身价值的一种方案,在数据库中没有被移出,而是通过一个变量来让他失效!deleted=0 ==>deleted =1(失效)
【测试一下】
deleted
字段:默认值设为 0@TableLogic
注解User 类
@TableLogic //逻辑删除
private Integer deleted;
//注册逻辑删除
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
global-config:
db-config:
logic-delete-value: 1
logic-not-delete-value: 0
@Test
public void testDeleteById(){
userMapper.deleteById(2L); //必须加L转为long
}
在数据表中依然有该用户,只是 deleted 字段变为了 1
再查询一下该用户,看看能不能查到?查不到,因为它会自动拼接 deleted 字段进行筛选,只查询 deleted = 0 的记录
我们在平时的开发中,会遇到一些慢 sql
mybatis-plus 也提供了性能分析插件,如果超过这个时间就停止运行!
1、导入插件
MyBatisPlusConfig 类
@Bean
@Profile({"dev","test"}) //设置dev 和 test环境开启
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(1); //sql语句超过1ms就不执行了
performanceInterceptor.setFormat(true);//是否设置sql语句格式化
return performanceInterceptor;
}
application.yml中添加设置开发环境
spring:
profiles:
active: dev
2、使用插件
随便执行一个测试类中的 sql 语句,会报以下错误:
The SQL execution time is too large, please optimize !
package com.kuang; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.kuang.mapper.UserMapper; import com.kuang.pojo.User; import org.junit.jupiter.api.Test; import org.springframework.boot.test.context.SpringBootTest; import javax.annotation.Resource; import java.util.List; import java.util.Map; @SpringBootTest public class WrapperTest { @Resource private UserMapper userMapper; @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对比一下 } @Test void test2(){ // 查询名字狂神说 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("name","狂神说"); User user = userMapper.selectOne(wrapper); // 查询一个数据用selectOne,出现多个结果的话使用List 或者 Map System.out.println(user); } @Test void test3(){ // 查询年龄在 20 ~ 30 岁之间的用户 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.between("age",20,30); // 区间 Integer count = userMapper.selectCount(wrapper);// 查询结果数 System.out.println(count); } // 模糊查询 @Test void test4(){ // 查询年龄在 20 ~ 30 岁之间的用户 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper .notLike("name","e") //name 中不含 e .like("email","q") // %q% 邮箱中含 q //likeRight: 左和右说的是%的位置 10% .likeRight("age", "10"); //10%,age以10开头的 List<Map<String, Object>> maps = userMapper.selectMaps(wrapper); maps.forEach(System.out::println); } // 模糊查询 @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); } //测试六:排序 @Test void test6(){ QueryWrapper<User> wrapper = new QueryWrapper<>(); // 通过id进行排序 asc升序 desc降序 wrapper.orderByAsc("id"); List<User> users = userMapper.selectList(wrapper); users.forEach(System.out::println); } }
dao、pojo、service、controller都给我自己去编写完成!
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。只需要改实体类名字和包名还有数据库配置即可。
测试:
test 目录下新建一个类
package com.kuang; 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 KuangCode { public static void main(String[] args) { // 需要构建一个 代码自动生成器 对象 AutoGenerator mpg = new AutoGenerator(); // 配置策略 // 1、全局配置 GlobalConfig gc = new GlobalConfig(); String projectPath = System.getProperty("user.dir");//user.dir获取当前工程的根目录 gc.setOutputDir(projectPath + "/src/main/java");//输出目录 gc.setAuthor("狂神说"); gc.setOpen(false);//是否打开资源管理器 gc.setFileOverride(false);//是否覆盖 // 默认的service接口都是I开头 gc.setServiceName("%sService"); //去掉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("password"); dsc.setDbType(DbType.MYSQL); mpg.setDataSource(dsc); //3、包的配置 PackageConfig pc = new PackageConfig(); //只需要改实体类名字 和包名 还有 数据库配置即可 pc.setModuleName("blog"); pc.setParent("com.kuang");//生成com.kuang.blog //各个包名 pc.setEntity("entity"); pc.setMapper("mapper"); pc.setService("service"); pc.setController("controller"); mpg.setPackageInfo(pc); //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 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); mpg.setStrategy(strategy); mpg.execute(); //执行 } }
执行出错:
NotFoundClass:org.apache.velocity
原因是:MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖并添加 模板引擎 依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
成功生成相应的包 和代码 !但是 User 类中提示缺少 swagger 的类,需要再导入依赖
<dependency>
<groupId>hu.blackbelt.bundles.swagger-parser</groupId>
<artifactId>io.swagger.parser</artifactId>
<version>1.0.47_1</version>
</dependency>
效果:
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。