MyBatis-Plus
注意:引入 MyBatis-Plus
之后请不要再次引入 MyBatis
以及 MyBatis-Spring
,以避免因版本差异导致的问题。
简介
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
愿景
我们的愿景是成为 MyBatis 最好的搭档,就像 魂斗罗 中的 1P、2P,基友搭配,效率翻倍。
特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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
- 达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库
#框架结构
就是在mybatis的基础上再次简化操作 让原来需要程序员写的curd代码都节省了 同时还优化了性能
快速开始
一:创建一个boot工程(SpringBoot Initializr)
勾选SQL中的MySQL Driver
二:引入mybatis-plus相关依赖
引入 Spring Boot Starter 父工程:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>spring-latest-version</version>
<relativePath/>
</parent>
引入 spring-boot-starter
、spring-boot-starter-test
、mybatis-plus-boot-starter
、mysql-connector-java、lombok
依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.22</version>
<scope>provided</scope>
</dependency>
三:配置
- 在application.yml中配置数据库连接的相关信息
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/my_db
username: root
password: devil
- 在 Spring Boot 启动类中添加
@MapperScan
注解,扫描 Mapper 文件夹:
@SpringBootApplication
@MapperScan("com.dyw.mybatisplus01pre.mapper")
public class MybatisPlus01PreApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlus01PreApplication.class, args);
}
}
- 借助lombok插件编写实体类 Student.java
@Data
public class Student {
/**
* @TableId 指定之间的方式:
* value:主键字段的名称,如果时id,可以不用写
* type:指定主键的类型,主键的值如何生成。idType.AUTO,表示自动增长
*/
@TableId(
type = IdType.AUTO
)
private int id;
private String name;
private int age;
}
- 编写Mapper接口
StudentMapper.java
/**
* 自定义Mapper,就是Dao接口
* 1.要继承BaseMapper
* 2.指定实体类
*
* BaseMapper是Mp框架中的对象,定义了十七个方法(CRUD)
*/
public interface StudentMapper extends BaseMapper<Student> {
}
- 测试类 测试
@SpringBootTest
class MybatisPlus01PreApplicationTests {
@Autowired
private StudentMapper studentMapper;
@Test
void contextLoads() {
List<Student> students = studentMapper.selectList(null);
for (Student student : students) {
System.out.println(student);
}
}
}
小结
* 通过以上几个简单的步骤,我们就实现了 Student 表的 CRUD 功能,甚至连 XML 文件都不用编写!
* 从以上步骤中,我们可以看到集成MyBatis-Plus
非常的简单,只需要引入 starter 工程,并配置 mapper 扫描路径即可。
* 对于mapper的扫描可以选择在启动类中写@MapperScan() 也可以在mapper接口上加@mapper 前者适合mapper接口多的情况 后者则书写更方便。
* 在执行插入操作时 执行成功后 会将结果返回到传入的对象中(例如我们可以通过传入的对象获得主键自增长的主键值)
@Test
void contextLoads() {
People people1 = new People(null, "王裴豫川");
int row = peopleMapper.insert(people1);
System.out.println(row>0?"成功":"失败");
System.out.println("主键id:"+people1.getId());
System.out.println();
List<People> people = peopleMapper.selectList(null);
for (People person : people) {
System.out.println(person);
}
}
可以看到我们没有对传入的对象的主键赋值(自动增长)但我们通过执行操作后的对象获得了插入到表中的该行数据的主 键 证实了上述结论