MybatisPlus
JPA、tk-mapper、mybatisPlus：可以节省大量工作时间，所有的CRUD代码都可以自动化完成。
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 操作智能分析阻断，也可自定义拦截规则，预防误操作
支持数据库
任何能使用
MyBatis进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下，如果不在下列表查看分页部分教程 PR 您的支持。
- MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
- 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据库，瀚高数据库
框架结构
入门程序
添加依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- mybatis和mybatisplus尽量不要同时使用，版本引起问题 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</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>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</dependency>
application.yml
spring:
application:
name: mybatisplus001
datasource:
username: root
password: 123456
url: jdbc:mysql://localhost:3306/karottes?useSSL=false&useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Karotter {
//@TableId(type = IdType.AUTO)
private Integer id;
private String name;
private String password;
}
mapper类
package com.kaka.dao;
@Repository
public interface KarotterMapper extends BaseMapper<Karotter> {
}
启动类
@MapperScan("com.kaka.dao")
@SpringBootApplication
public class MybatisPlus01Application {
public static void main(String[] args) {
SpringApplication.run(MybatisPlus01Application.class, args);
}
}
测试类
@SpringBootTest
class MybatisPlus01ApplicationTests {
@Autowired
private KarotterMapper karotterMapper;
@Test
void contextLoads() {
List<Karotter> karotters = karotterMapper.selectList(null);//没有条件的查询直接传null
karotters.forEach(System.out::println);
}
}
//===================================
==> Preparing: SELECT id,name,password FROM karotter
==> Parameters:
<== Columns: id, name, password
<== Row: 1, 卡卡罗特, 45678
<== Row: 2, 贝吉塔, kaka098
<== Row: 3, 布罗利, 456das789
<== Row: 4, 布尔玛, 456das789
<== Row: 5, 库林, 456das789
<== Row: 6, 比克, 456das789
<== Row: 7, 雅木茶, 456das789
<== Row: 8, 桃白白, 456das789
<== Row: 9, 龟仙人, 456das789
<== Row: 10, 天京饭, 456das789
<== Row: 11, 饺子, 456das789
<== Row: 12, 弗利沙, 456das789
<== Total: 12
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@354e7004]
Karotter(id=1, name=卡卡罗特, password=45678)
Karotter(id=2, name=贝吉塔, password=kaka098)
Karotter(id=3, name=布罗利, password=456das789)
Karotter(id=4, name=布尔玛, password=456das789)
Karotter(id=5, name=库林, password=456das789)
Karotter(id=6, name=比克, password=456das789)
Karotter(id=7, name=雅木茶, password=456das789)
Karotter(id=8, name=桃白白, password=456das789)
Karotter(id=9, name=龟仙人, password=456das789)
Karotter(id=10, name=天京饭, password=456das789)
Karotter(id=11, name=饺子, password=456das789)
Karotter(id=12, name=弗利沙, password=456das789)
2022-06-21 14:59:36.594 INFO 3076 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Shutdown initiated...
2022-06-21 14:59:36.611 INFO 3076 --- [extShutdownHook] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Shutdown completed.
2022-06-21 14:59:36.612 INFO 3076 --- [extShutdownHook] o.s.s.concurrent.ThreadPoolTaskExecutor : Shutting down ExecutorService 'applicationTaskExecutor'
Process finished with exit code 0
注意
This primary key of "id" is primitive !不建议如此请使用包装类 in Class: "com.kaka.pojo.Karotter"
==推荐使用包装类，代替基本数据类型==
CRUD扩展
insert
@Test
void add() {
Karotter karotter = new Karotter();
karotter.setName("比鲁斯");
karotter.setPassword("wudi");
karotterMapper.insert(karotter);
}
//============================================
JDBC Connection [HikariProxyConnection@1041219253 wrapping com.mysql.cj.jdbc.ConnectionImpl@3976ebfa] will not be managed by Spring
==> Preparing: INSERT INTO karotter ( id, name, password ) VALUES ( ?, ?, ? )
==> Parameters: -587149311(Integer), 比鲁斯(String), wudi(String) //如果没有配置主键生成策略，默认是雪花算法
<== Updates: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@4c7e978c]
数据库插入的id默认为：全局唯一的id
主键生成策略
public enum IdType {
/**
* 数据库ID自增
* <p>该类型请确保数据库设置了 ID自增 否则无效</p>
*/
AUTO(0),
/**
* 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
*/
NONE(1),
/**
* 用户输入ID
* <p>该类型可以通过自己注册自动填充插件进行填充</p>
*/
INPUT(2),
/* 以下2种类型、只有当插入对象ID 为空，才自动填充。 */
/**
* 分配ID (主键类型为number或string）,
* 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
*
* @since 3.3.0
*/
ASSIGN_ID(3),
/**
* 分配UUID (主键类型为 string)
* 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
*/
ASSIGN_UUID(4);
}
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。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右（2^22*1000）。
update
@Test
void update() {
Karotter karotter = new Karotter();
karotter.setId(14);
karotter.setName("叶修");
karotter.setPassword("君莫笑");
karotterMapper.updateById(karotter);//动态的，不封装的成员属性不会构建到sql中
}
//==========================================
JDBC Connection [HikariProxyConnection@1514778448 wrapping com.mysql.cj.jdbc.ConnectionImpl@3b1dc579] will not be managed by Spring
==> Preparing: UPDATE karotter SET name=?, password=? WHERE id=?
==> Parameters: 叶修(String), 君莫笑(String), 14(Integer)
<== Updates: 1
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@2e1ddc90]
query
//查询全部
List<Karotter> karotters = karotterMapper.selectList(null);
//根据id查询对象
Karotter karotter = karotterMapper.selectById(15);
//批量查询
List<Karotter> karotters = karotterMapper.selectBatchIds(Arrays.asList(1, 2, 3, 4));
//简单的条件查询
Map<String, Object> condition = new HashMap<>();
condition.put("age","22");
System.out.println(karotterMapper.selectByMap(condition));
//分页查询===配置部分与乐观锁配置一起
Page<Karotter> page = new Page<>(2,4);
karotterMapper.selectPage(page, null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
System.out.println(page.getPages());
System.out.println(page.getSize());
System.out.println(page.getCurrent());
//=================================================
Karotter(id=4, name=布尔玛, password=456das789, gmtCreate=null, gmtModify=null, version=1)
Karotter(id=5, name=库林, password=456das789, gmtCreate=null, gmtModify=null, version=1)
Karotter(id=6, name=比克, password=456das789, gmtCreate=null, gmtModify=null, version=1)
Karotter(id=7, name=雅木茶, password=456das789, gmtCreate=null, gmtModify=null, version=1)
16
4
4
2
delete
karotterMapper.deleteById(-587149311);//根据id删除
karotterMapper.delete(null);//全部删除
karotterMapper.deleteBatchIds(Arrays.asList(1,2,3));//批量删除
Map<String,Object> map = new HashMap<>();
map.put("age",25);
karotterMapper.deleteByMap(map);//简单的条件删除
Karotter k1 = new Karotter();
k1.setId(3);
karotterMapper.deleteById(k1)//简单的条件删除
逻辑删除（logic-delete）
数据库-添加字段
实体类-添加属性
@TableLogic
private int isDel;
配置类-添加注入（低版本需要，现在不需要）
//跟分页、乐观锁是一个地方
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
全局配置-可以不配置，有默认值
mybatis-plus:
global-config:
db-config:
logic-delete-value: 1
logic-not-delete-value: 0
logic-delete-field: isDel # 以实体类的注解为主 ，就近原则
自动填充
数据库级别
代码级别
实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Karotter {
@TableId(type = IdType.AUTO)
private Integer id;
private String name;
private String password;
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModify;
}
public enum FieldFill {
/**
* 默认不处理
*/
DEFAULT,
/**
* 插入时填充字段
*/
INSERT,
/**
* 更新时填充字段
*/
UPDATE,
/**
* 插入和更新时填充字段
*/
INSERT_UPDATE
}
处理器
package com.kaka.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
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start fill");
this.setFieldValByName("gmtCreate",new Date(),metaObject);
this.setFieldValByName("gmtModify",new Date(),metaObject);
this.setFieldValByName("version",1,metaObject);
this.setFieldValByName("isDel",0,metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("gmtModify",new Date(),metaObject);
}
}
==> Preparing: INSERT INTO karotter ( name, password, gmt_create, gmt_modify ) VALUES ( ?, ?, ?, ? )
==> Parameters: 维斯(String), wudi(String), 2022-06-21 15:44:06.133(Timestamp), 2022-06-21 15:44:06.133(Timestamp)
<== Updates: 1
==> Preparing: UPDATE karotter SET name=?, gmt_modify=? WHERE id=?
==> Parameters: 叶不修(String), 2022-06-21 15:46:50.37(Timestamp), 14(Integer)
<== Updates: 1
乐观锁
乐观锁实现方式
- 取出记录时，获取当前的version
- 更新时带上这个version
- 执行更新时，set version = newVersion where version = oldVersion
- 如果version不对，更新失败
数据库添加version字段
实体类
public class Karotter {
@TableId(type = IdType.AUTO)
private Integer id;
private String name;
private String password;
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModify;
@Version
private Integer version;
}
配置类
@Configuration
@EnableTransactionManagement
@MapperScan("com.kaka.dao")
public class MybatisPlusConfig {
// 注册乐观锁和分页插件(新版：3.4.0)
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); // 乐观锁插件
// DbType：数据库类型(根据类型获取应使用的分页方言)
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); // 分页插件
return interceptor;
}
//老版本 乐观锁插件
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
//注册分页插件(旧版：3.0.5)
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
}
条件构造器
QueryWrapper<Karotter> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.eq("password","jsjsj")
.ge("age",12)
.likeRight("email","ka");//ka开头 ka%
karotterMapper.selectList(wrapper).forEach(System.out::println);
代码生成器（新版-3.5.1及以上）
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.2</version>
</dependency>
FastAutoGenerator.create("url", "username", "password")
.globalConfig(builder -> {
builder.author("baomidou") // 设置作者
.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D://"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.baomidou.mybatisplus.samples.generator") // 设置父包名
.moduleName("system") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("t_simple") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
.execute();
FastAutoGenerator.create(DATA_SOURCE_CONFIG)
// 全局配置
.globalConfig((scanner, builder) -> builder.author(scanner.apply("请输入作者名称？")).fileOverride())
// 包配置
.packageConfig((scanner, builder) -> builder.parent(scanner.apply("请输入包名？")))
// 策略配置
.strategyConfig((scanner, builder) -> builder.addInclude(getTables(scanner.apply("请输入表名，多个英文逗号分隔？所有输入 all")))
.controllerBuilder().enableRestStyle().enableHyphenStyle()
.entityBuilder().enableLombok().addTableFills(
new Column("create_time", FieldFill.INSERT)
).build())
/*
模板引擎配置，默认 Velocity 可选模板引擎 Beetl 或 Freemarker
.templateEngine(new BeetlTemplateEngine())
.templateEngine(new FreemarkerTemplateEngine())
*/
.execute();
旧版(3.5.1以下)
参考官网：https://baomidou.com/pages/d357af/#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B
public class CodeGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("请输入" + tip + "：");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "！");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("jobob");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("密码");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
pc.setParent("com.baomidou.ant");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录，自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在，不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
京公网安备 11010502036488号