一、Mybatis-Plus简介
(一)什么是Mybatis-Plus
Mybatis-Plus是一个Mybatis(opens new window)的增强工具,在Mybatis的基础上只做增强不做改变,为简化开发。
(二)Mybatis-Plus的优势
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响。
- 损耗小:启动即会自动注入基本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-Plus的框架结构
二、SpringBoot整合Mybatis-Plus入门
(一)创建maven工程,添加依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.2</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
(二)创建数据库表employee
CREATE TABLE employee(
emp_id BIGINT(20) NOT NULL,
name VARCHAR(30),
emp_gender VARCHAR(6),
age INT,
email VARCHAR(50),
PRIMARY KEY(emp_id)
);
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(1,'','李荣',20,'lirong@qq.com');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(2,'王平','男',28,'wangping@qq.com');
INSERT INTO employee(emp_id,name,emp_gender,age,email)
VALUES(3,'刘帅','男',23,'liushuai@126.com');
(三)构建数据模型Employee
public class Employee {
private Long empId;
private String name;
private String empGender;
private Integer age;
private String email;
}
(四)配置application.yml
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql:///mybatis_plus
username: root
password: root
(五)编写SpringBoot启动类
@SpringBootApplication
@MapperScan("com.test.mapper")
public class MybatisPlus01Application {
public static void main(String[] args) {
SpringApplication.run(MybatisPlus01Application.class, args);
}
}
(六)编写mapper接口
public interface EmployeeMapper extends BaseMapper<Employee> {}
(七)启动服务测试结果
@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlus01ApplicationTests {
@Autowired
private EmployeeMapper employeeMapper;
@Test
public void testSelect(){
List<Employee> employeeList = employeeMapper.selectList(null);
employeeList.forEach( System.out::println);
}
}
三、注解
@TableName
- 描述:表名注解,标识实体类对应的表
- 使用位置:实体类
@TableId注解
描述:主键注解
使用位置:实体类主键字段
IdType
四、CRUD
(一)BaseMapper接口方法介绍
BaseMapper中提供了CRUD方法,具体方法如下:
// 插入一条记录
int insert(T entity);
// 根据 entity 条件,删除记录
int delete(@Param(Constants.WRAPPER) Wrapper<T> 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);
// 根据 whereEntity 条件,更新记录
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper<T> updateWrapper);
// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 查询(根据 columnMap 条件)
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
// 根据 Wrapper 条件,查询全部记录
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件,查询全部记录。注意: 只返回第一个字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 entity 条件,查询全部记录(并翻页)
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件,查询全部记录(并翻页)
IPage<Map<String, Object>> selectMapsPage(IPage<T> page,
@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
// 根据 Wrapper 条件,查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
(二)Insert方法
//插入一条记录
int insert (T entity);
测试:
@Test
public void testInsert() {
Employee employee=new Employee();
//employee.setEmpId(100000);
employee.setId(5);
employee.setName("刘龙");
employee.setEmpGender("男");
employee.setAge(25);
employee.setEmail("liulong@163.com");
employeeMapper.insert(employee);
}
(三)插入数据获取主键值
修改Employee的empId注解
@TableId(type=IdType.AUTO)
private Long empId;
mysql-plus会自动获取自增主键,把数据库的emp_id设置为自增。测试获取自增主键
public void testInsert() {
Employee employee=new Employee();
employee.setName("裴十六");
employee.setEmpGender("男");
employee.setAge(25);
employee.setEmail("liulong@163.com");
employee.setRemark("该员工是一个好员工");
employeeMapper.insert(employee);
System.out.println(employee.getEmpId());
}
(四)更新数据的通用方法
1、updateById方法
根据id进行记录更新,如果对象属性未传值,则不会更新该字段,保持数据库表原来字段值
public void testUpdateById() {
Employee employee=new Employee();
employee.setEmpId(16)
employee.setName("裴十六");
employee.setEmpGender("男");
employee.setAge(23);
employee.setEmail("peishiliu@163.com");
employeeMapper.updateById(employee);
}
2、update(entity,wrapper)方法
public void testdateById(){
//根据员工的名字,更新
Employee employee2=new Employee();
employee2.setEmpGender("男");
employee2.setAge(18);
employee2.setEmail("liulong@126.com");
employeeMapper.update(employee2,new UpdateWrapper<Employee>().eq("name","裴十六"));
}
(五)查询数据的通用方法
1、selectById方法
根据id查询指定记录
@Test
public void testSelectById() {
Employee employee=employeeMapper.selectById(1);
System.out.println(employee);
}
2、selectBatchIds方法
批量查询指多个id的记录集合
@Test
public void testSelectBatchIds() {
List list= Arrays.asList(1,2,3);
List<Employee> employeeList = employeeMapper.selectBatchIds(list);
employeeList.forEach(System.out::println);
}
3、selectByMap方法
根据Map集合中传入的条件进行查询,每个条件都是and关系
@Test
public void testSelectByMap() {
Map<String,Object> map=new HashMap<>();
map.put("emp_gender","男");
map.put("age",29);
List<Employee> employeeList = employeeMapper.selectByMap(map);
employeeList.forEach(System.out::println);
}
(六)删除数据方法
1、deleteById方法
根据id删除记录
@Test
public void testDeleteById(){
int rows=employeeMapper.deleteById(1);
System.out.println("受影响的行数:"+rows);
}
2、deleteByMap方法
根据Map中的条件进行删除,map中的条件在sql语句中是and关系
@Test
public void testDeleteByMap(){
Map<String,Object> map=new HashMap<>();
map.put("emp_gender","男");
map.put("emp_name","刘辉");
int rows=employeeMapper.deleteByMap(map);
System.out.println("受影响的行数:"+rows);
}
3、deletebatchIds方法
根据传入List集合中的id进行批量删除
@Test
public void testDeleteBatchIds(){
List list= Arrays.asList(4,7,1);
int rows=employeeMapper.deleteBatchIds(list);
System.out.println("受影响的行数:"+rows);
}
五、Mybatis-Plus条件构造器
(一)条件构造器介绍
在mybatis-plus中提了构造条件的类Wrapper,它可以根据自己的意图定义我们需要的条件。Wrapper是一个抽象类,一般情况下我们用它的子类QueryWrapper来实现自定义条件查询。
(二)SelectOne方法
//查询姓名为刘辉军并且性别为男的员工
@Test
public void testSelectOne(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.eq("name","刘辉军");
queryWrapper.eq("emp_gender","男");
Employee employee = employeeMapper.selectOne(queryWrapper);
System.out.println(employee);
}
(三)SelectList方法
//查询姓名中带有"磊"的并且年龄小于30的员工
@Test
public void testSelectList(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.like("name","磊").lt("age",30);
List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
employeeList.forEach(System.out::println);
}
//查询姓刘的或者性别为男,按年龄的除序排序
@Test
public void testSelectList2(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.like("name","王")
.or().eq("emp_gender","男")
.orderByDesc("age");
List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
employeeList.forEach(System.out::println);
}
//查询姓刘的并且(年龄小于35或者邮箱不为空)
@Test
public void testSelectList3(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.likeRight("name","刘")
.and(wq->wq.lt("age",35).or().isNotNull("email"));
List<Employee> employeeList = employeeMapper.selectList(queryWrapper);
employeeList.forEach(System.out::println);
}
(四)SelectPage方法
SelectPage用于分页,在Mybatis-Plus中分页有两种:一种是逻辑分页或叫内存分页,另一个是物理分页。内存分页就是把数据全部查询出来放到内容中,返回你想要的一部分数据,当数据量非常庞大时,这种方法就行不通了,因为太耗内容,所以一般采用物理分页,需要SpringMVC中加入物理分页配置:
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
@Test
public void testSelectPage(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.lt("age",50);
Page<Employee> page=new Page<>(1,2);
Page<Employee> employeePage = employeeMapper.selectPage(page, queryWrapper);
System.out.println("当前页:"+ employeePage.getCurrent());
System.out.println("每页记录数:"+employeePage.getSize());
System.out.println("总记录数:"+employeePage.getTotal());
System.out.println("总页数:"+employeePage.getPages());
List<Employee> employeeList = employeePage.getRecords();
employeeList.forEach(System.out::println);
}
(五)Update方法
//根据姓名和年龄修改记录
@Test
public void testUpdate(){
QueryWrapper<Employee> updateWrapper=new QueryWrapper<>();
updateWrapper.eq("name","刘龙")
.eq("age",25);
Employee employee=new Employee();
employee.setEmpId(1367720249630318593L);
employee.setName("刘龙");
employee.setEmail("lilong111@.qq.com");
employee.setAge(26);
employee.setEmpGender("女");
int rows=employeeMapper.update(employee,updateWrapper);
System.out.println("受影响的行数:"+rows);
}
(六)Delete方法
//根据姓名和年龄删除记录
@Test
public void testDelete(){
QueryWrapper<Employee> queryWrapper=new QueryWrapper<>();
queryWrapper.eq("name","刘龙")
.eq("age",26);
int rows=employeeMapper.delete(queryWrapper);
System.out.println("受影响的行数:"+rows);
}
六、Mybatis-Plus代码生成器
代码生成器介绍
代码生成器顾名思义就是为我们生成一些代码,省去了我们一些时间。AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率,MyBatis-Plus从3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖,才能实现代码生成器功能。
详细参考:https://baomidou.com/pages/779a6e/#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8