MyBatis Plus(简称MP)是一个在MyBatis基础上进行增强的工具,它保留了MyBatis的所有特性,并通过提供额外的功能和简化操作来提高开发效率。以下是对MyBatis Plus的详细介绍:
一、基本概述
- 定义:MyBatis Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,旨在简化开发、提高效率。
- 官网:https://mybatis.plus/ 或 Redirect
二、主要特性
- 简化CRUD操作:
- MyBatis Plus提供了通用的Mapper接口和Service接口,简化了常见的CRUD(增删改查)操作。
- 无需编写XML文件和手动编写SQL语句,只需继承通用Mapper接口或Service接口,即可使用常见的CRUD方法。
- 代码自动生成:
- MyBatis Plus内置了代码生成器,可以根据数据库表自动生成实体类、Mapper接口和XML文件,大大减少了手动编写代码的工作量。
- 分页查询:
- 提供了分页插件,可以在查询数据时直接指定分页参数,方便进行分页查询。
- 条件构造器:
- 提供了条件构造器,可以通过链式调用的方式生成查询条件,使得查询条件更加清晰易读。
- 乐观锁支持:
- 提供了乐观锁的支持,可以在更新数据时进行版本校验,避免数据冲突问题。
- 自动填充:
- 提供了自动填充功能,可以在插入或更新数据时自动填充某些字段,如创建时间和更新时间等。
- 多租户支持:
- 提供了多租户的支持,可以在查询数据时自动根据租户ID添加过滤条件,实现多租户数据隔离。
- 其他特性:
- 支持Lambda形式调用,通过Lambda表达式方便地编写各类查询条件。
- 支持主键自动生成,提供了多达4种主键策略(内含分布式唯一ID生成器)。
- 支持ActiveRecord模式,实体类只需继承Model类即可进行强大的CRUD操作。
- 提供了性能分析插件,可输出SQL语句及其执行时间,帮助开发者优化查询。
三、架构与原理
- 核心组件:MyBatis Plus的核心组件包括mybatis-plus-boot-starter(Spring Boot场景启动器)、注解(用于更高效地完成持久层开发)、extension(提供分页、逻辑删除、自动填充等扩展功能)、generator(代码生成器)以及core(核心功能)。
- 运行原理:MyBatis Plus通过自动扫描实体,将数据库表中的列名和表名通过反射机制自动生成对应的代码,包括持久层的CRUD操作。
四、与MyBatis的区别
- 语法简化:MyBatis Plus通过使用注解和API简化了MyBatis的配置和操作,减少了开发者的编码量。
- 自动代码生成:MyBatis Plus提供了代码生成器,而MyBatis需要手动编写所有代码。
- 分页插件:MyBatis Plus内置了分页插件,而MyBatis需要手动实现分页逻辑。
-
条件查询:MyBatis Plus提供了强大的条件查询功能,而MyBatis则需要编写复杂的SQL语句来实现。
五、核心注解
1. @TableName
用途:用于指定实体类对应的数据库表名。
作用:告诉MyBatis Plus在进行SQL操作时应该使用哪个表。
详细说明:当实体类名与数据库表名不一致时,可以使用@TableName注解来指定实体类对应的数据库表名。这样,MyBatis Plus在执行SQL操作时就会使用指定的表名。
例如:
package com.cjq.orders.domain;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import java.math.BigDecimal;
@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
@TableName("t_orders")
public class Orders {
/**
* 主键ID
*/
@TableId(type = IdType.AUTO)
private Integer ordersId;
/**
* 订单名字
*/
private String ordersName;
/**
* 订单数量
*/
private Integer ordersNum;
/**
* 订单价格
*/
private BigDecimal ordersPrice;
/**
* 订单状态 1已支付 2未支付
*/
private Integer ordersStatus;
}
在这个示例中,Orders
类将映射到数据库中的t_orders
表。
2. @TableId
用途:用于标识主键字段,并指定主键生成策略。
详细说明:@TableId注解不仅可以指定实体类中的哪个字段是主键,还可以指定主键的生成策略。MyBatis Plus提供了多种主键生成策略,如自增(IdType.AUTO)、手动输入(IdType.INPUT)、分布式全局唯一ID(IdType.ASSIGN_ID)等。
常用属性:
value
:指定主键字段名(默认值就是属性名)。type
:指定主键生成策略,如IdType.AUTO
(自动增长)、IdType.INPUT
(手动输入)、IdType.ASSIGN_ID
(分配ID,默认使用雪花算法)等。
在这个示例中,id字段被标识为主键,并且采用自动增长的方式生成主键值。
3. @TableField
用途:用于标识实体类中的字段与数据库表中的字段的映射关系。
详细说明:@TableField注解可以指定字段名、是否为数据库字段、自定义字段填充策略等。当实体类中的字段名与数据库表中的字段名不一致时,可以使用@TableField注解的value属性来指定数据库表中的字段名。此外,@TableField还可以用于指定字段的填充策略,如插入时填充、更新时填充等。
常用属性:
value
:指定数据库表中的字段名(默认值就是属性名)。exist
:用于指明该字段是否是数据库表中的字段,默认为true
。fill
:用于指定字段填充策略,如FieldFill.INSERT
(插入时填充)、FieldFill.UPDATE
(更新时填充)等。@TableField(value = "user_name", exist = true, fill = FieldFill.INSERT) private String userName;
在这个示例中,
userName
字段映射到数据库表中的user_name
字段,且在插入数据时由自定义的填充策略进行填充。
六、控制层(Controller)
package com.cjq.orders.controller;
import com.cjq.orders.domain.Orders;
import com.cjq.orders.service.OrdersService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class OrdersController {
@Autowired
private OrdersService ordersService;
@GetMapping("/ordersList")
public List<Orders> ordersList(){
List<Orders> ordersList = ordersService.list();
return ordersList;
}
}
七、业务层(Service)
1. IService<T>和ServiceIMpl<M extends BaseMapper<T>,T> 是对BaseMapper的进一步封装,一般很少用,但是很方便。
package com.cjq.orders.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.cjq.orders.domain.Orders;
public interface OrdersService extends IService<Orders> {
}
package com.cjq.orders.service.impl;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.cjq.orders.domain.Orders;
import com.cjq.orders.mapper.OrdersMapper;
import com.cjq.orders.service.OrdersService;
import org.springframework.stereotype.Service;
@Service
public class OrdersServiceImpl extends ServiceImpl<OrdersMapper, Orders> implements OrdersService {
}
八、持久层(Mapper)
1. BaseMapper<T>是mybatis-plus设计的一个接口,里面包含了单表的CRUD,用起来非常方便。
<T>表示实体类
package com.cjq.orders.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.cjq.orders.domain.Orders;
import org.springframework.stereotype.Repository;
@Repository
public interface OrdersMapper extends BaseMapper<Orders> {
}
九、启动类
package com.cjq.orders;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan(basePackages = "com.cjq.orders.mapper")
public class OrdersApplication {
public static void main(String[] args) {
SpringApplication.run(OrdersApplication.class,args);
}
}
十、application.yml配置文件
注意:直接顶头粘贴
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #日志
map-underscore-to-camel-case: true #开启驼峰命名
十一、结果详情
十二、单表CRUD
package com.cjq.orders.controller;
import com.cjq.orders.domain.Orders;
import com.cjq.orders.service.OrdersService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
public class OrdersController {
@Autowired
private OrdersService ordersService;
/**
* 根据ID查询
* @param ordersId
* @return
*/
@GetMapping("/findById")
public Orders findById(Integer ordersId){
Orders orders = ordersService.getById(ordersId);
return orders;
}
/**
* 列表
* @return
*/
@GetMapping("/ordersList")
public List<Orders> ordersList(){
List<Orders> ordersList = ordersService.list();
return ordersList;
}
/**
* 添加
* @param orders
*/
@PostMapping("/insert")
public void insert(@RequestBody Orders orders){
ordersService.save(orders);
}
/**
* 修改
* @param orders
*/
@PutMapping("/update")
public void update(@RequestBody Orders orders){
ordersService.updateById(orders);
}
/**
* 删除
* @param ordersId
*/
@DeleteMapping("/delete/{ordersId}")
public void delete(@PathVariable Integer ordersId){
ordersService.removeById(ordersId);
}
}