1.特性
无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求. 继承一个类就好了!
支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配 置,完美解决主键问题
支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大 的 CRUD 操作
支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
内置代码生成器(pojo、dao、xml、service、…):采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来 使用
内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同 于普通 List 查询
分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、 Postgre、SQLServer 等多种数据库
内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢 查询
内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误 操作
支持数据库
mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
达梦数据库 、 虚谷数据库 、 人大金仓数据库
2.入门步骤
1、建立数据库,导入数据
2、导入对应的依赖
3、编写项目
配置数据库连接 编写实体类 编写接口继承BaseMapper 即可!至此所有的CRUD 都已经完成了!
4、测试使用即可!
配置日志可以查看sql
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
.
3.1插入
主键策略
public class User {
// 主键可以通过 IdType 进行策略的修改!
// 默认 ID_WORKER
// @TableId(type = IdType.ID_WORKER_STR)
private Long id;
private String name;
private Integer age;
private String email;
@TableLogic // 逻辑删除字段!
private Integer deleted;
// 乐观锁注解 @Version
@Version
private Integer version;
// 时间的操作(自动更新)
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
}
关于id生成的一些策略:https://www.cnblogs.com/haoxinyue/p/5208136.html
3.2 更新
数据库级别(不建议)
代码级别(建议)
1.数据库不选更新创建时间
2写实体类注解
// 时间的操作(自动更新)
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
3.写拦截器
// MetaObjectHandler 元对象处理
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入的策略
@Override
public void insertFill(MetaObject metaObject) {
// this.setFieldValByName()设置当前字段的值!
// String fieldName, Object fieldVal, MetaObject metaObject
// 以后只要是插入操作就会自动控制
// createTime updateTime 使用 new Date() 进行填充
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
// 更新策略
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
乐观锁
乐观锁 : 非常乐观,无论什么操作都不加锁!(分布式环境怎么处理冲突问题呢?)
悲观锁 : 非常悲观,无论什么操作都加锁!
乐观锁实现方式:
取出记录时,获取当前version 【查询】old version = 1
更新时,带上这个version 【更新】
执行更新时, set version = newVersion where version = oldVersion
如果version不对,就更新失败
// 乐观锁注解 @Version
@Version
private Integer version;
3.3删除
逻辑删除
// 逻辑删除插件!
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
@TableLogic // 逻辑删除字段!
private Integer deleted;
3.4查询
分页插件
@Configuration
public class MPconfig {
// 注入人家写好的插件处理器
// 本质是一个拦截器 Interceptor
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
// 逻辑删除插件!
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
// SQL执行效率插件
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
// 允许执行的sql的最长时间 , 默认的单位是ms
performanceInterceptor.setMaxTime(1000);
performanceInterceptor.setFormat(true); // 格式化SQL代码
return performanceInterceptor;
}
}
//配置文件
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?useSSL=false
spring.datasource.username=root
spring.datasource.password=root
mybatis-plus.configuration.logimpl=org.apache.ibatis.logging.stdout.StdOutImpl
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
spring.profiles.active=dev
3.5条件构造器
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
// 条件查询器
@Test
void testLogicDelete(){
QueryWrapper<User> wrapper = new QueryWrapper();
// 链式编程,我们可以构造多个条件,它会自动帮我拼接SQL!
// 我们可以使用纯面向对象的方式使用SQL
wrapper
.isNotNull("name")
.ge("age",21); // 大于等于
// .eq("age",0);
userMapper.delete(wrapper);
}
// 边界查询
@Test
void testSelectCount(){
QueryWrapper<User> wrapper = new QueryWrapper();
wrapper.between("age",20,25);
Integer integer = userMapper.selectCount(wrapper);
}
// 精准匹配
@Test
void testSelectList(){
QueryWrapper<User> wrapper = new QueryWrapper();
HashMap<String, Object> map = new HashMap<>();
map.put("id",2);
map.put("name","Jack");
wrapper.allEq(map);
List<User> users = userMapper.selectList(wrapper);
}
// 模糊查询
@Test
void testSelectMaps(){
QueryWrapper<User> wrapper = new QueryWrapper();
// like %p%
// like %p
// like p%
wrapper
.notLike("name","e")
.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
// 子查询 in()
@Test
void testSelectObjs(){
QueryWrapper<User> wrapper = new QueryWrapper();
// wrapper.in("id",1,2,3,4);
// 子查询!
wrapper.inSql("id","select id from user where id < 3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
// and or
@Test
void testUpdate(){
// 修改值
User user = new User();
user.setAge(99);
user.setName("KS");
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
// 在一些新的框架中,链式编程,lambda表达式,函数式接口十分常用!
updateWrapper
.like("name","k")
.or(i->i.eq("name","Coding2").eq("age",0));
int update = userMapper.update(user, updateWrapper);
}
// 排序
@Test
void selectList(){
QueryWrapper<User> wrapper = new QueryWrapper();
// wrapper.orderByAsc("id");
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
// 多表查询解决方案 last (不建议使用!)
// 冗余字段设计!
// 平时如果要多表查询,没有简便方法,就自己扩展即可!
@Test
void tSelectList(){
QueryWrapper<User> wrapper = new QueryWrapper();
wrapper.last("limit 1");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
}
4.代码生成器
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!-- 这里的edu就是我们对应 coding_edu 这个数据库的,一个微服务对应一个数据库-->
<parent>
<artifactId>coding-edu-parent</artifactId>
<groupId>com.coding</groupId>
<version>0.0.1-SNAPSHOT</version>
<relativePath>../coding-edu-parent/pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>coding-edu-edu</artifactId>
<dependencies>
<!-- 依赖公共模块 -->
<dependency>
<groupId>com.coding</groupId>
<artifactId>coding-edu-common</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
</dependency>
<!--mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- 自动生成代码需要的依赖! -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
</dependency>
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
<!-- lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- poi 操作xls的 -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi</artifactId>
</dependency>
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-ooxml</artifactId>
</dependency>
<!--springboot 开发工具-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
</dependencies>
</project>
public class CodeGenerator {
//代码生成
public static void main(String[] args) {
// 模块名
String moduleName = "edu";
// 1、代码生成器
AutoGenerator mpg = new AutoGenerator();
// 规则的配置
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");// 获取当前项目的路径
gc.setOutputDir(projectPath + "/coding-edu-edu/src/main/java");
gc.setAuthor("sy");
gc.setOpen(false);
gc.setFileOverride(false); // 不覆盖之前生成的文件!
gc.setServiceName("%sService");
gc.setIdType(IdType.ID_WORKER_STR); // 主键策略
gc.setDateType(DateType.ONLY_DATE); // 日期类型
gc.setSwagger2(true); // 自动开启Swagger配置!
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
// dsc.setUrl("jdbc:mysql://localhost:3306/coding_edu?useSSL=false");
// dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUrl("jdbc:mysql://localhost:3306/coding_"+moduleName+"?characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(moduleName);
pc.setParent("com.coding");
pc.setController("controller");
pc.setService("service");
pc.setEntity("entity");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// 要生成哪一个表对应的类
strategy.setInclude(moduleName+"_\\w*"); // !!!所有edu 开头的表都自动生成!
strategy.setNaming(NamingStrategy.underline_to_camel); // 数据库表生成到实体类的策略
strategy.setTablePrefix(pc.getModuleName()+"_"); // edu_ 这个前缀不生成在类中
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true); // 自动生成lombok注解
strategy.setLogicDeleteFieldName("is_deleted"); // 逻辑删除!
strategy.setEntityBooleanColumnRemoveIsPrefix(true); // 去掉布尔值的 is_前缀!
// 自动填充
TableFill gmt_create = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmt_modified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmt_create);
tableFills.add(gmt_modified);
strategy.setTableFillList(tableFills);
// 乐观锁
strategy.setVersionFieldName("version");
strategy.setRestControllerStyle(true); // restful api
strategy.setControllerMappingHyphenStyle(true); // /user/hello_name 使用_连接驼峰!
mpg.setStrategy(strategy);
// 2、执行代码生成器
mpg.execute();
}
}