SpringBoot使用Mybatis-Plus详解
MyBatisPuls概述
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生
国产的开源框架，基于MyBatis
核心功能是简化MyBatis的开发，提高效率
特别强调Mybatis-plus不能和Mybatis 同时使用，会导致冲突
底层采用CGlib动态代理方式
其特性有：
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
支持的数据库有:
mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
达梦数据库 、 虚谷数据库 、 人大金仓数据库
快速入门
大概分四步
导入对应的依赖
研究依赖如何配置
代码如何编写
提高拓展技术能力
创建表
CREATE TABLE user (
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
//真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create（创建时间）、gmt_modified（更新时间）
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
导入依赖
mysql
mysql-connector-java
//需要指定版本
com.baomidou
mybatis-plus-boot-starter
3.1.0
org.projectlombok
lombok
true
说明：我们使用mybatis-puls 可以节省我们大量的代码，但是尽量不要同时使用mybatis和mybatis-plus依赖，容易出错。
配置文件
mysql 5 驱动不同com.,mysql.jdbc.Driver
mysql 8 com.mysql.cj.jdbc.Driver 并且需要增加时区的配置serverTimezone=UTC
spring:
datasource:
url: jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: 123456
pojo(实体类)
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
private long id;
private String name;
private Integer age;
private String email;
}
mapper
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.springframework.stereotype.Repository;
//其中继承基本类BaseMapper
@Repository //代表这是持久层
public interface UserMapper extends BaseMapper {
//到这一步已经把简单的CRUD的编写完成了，不在是像之前mybatis一样编写接口和XXXMapper.xml，简化开发！
}
注意点：需要在主启动类中，添加 @MapperScan(“com.*.mapper”) =》扫描mapper包下的所有接口
测试
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
@SpringBootTest
class ApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
//其中参数是wrapper，条件构造器，这里不用的话可以写null，表示查询所有的用户
List users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
配置日志
因为现在由于MyBatis-plus的原因，sql语句对我们来讲是不可见的，我们可以使用他的方法，但是我们没有看到sql语句是怎么执行的，所以这个时候日志应运而生，我们可以通过查看日志，来查看它是怎么执行的，如何配置日志，需要我们在yml文件中加入：
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
也可以在application.properties配置文件添加
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
此时打印的日志条件参数为占位符
如何打印出完整的sql呢？
springboot整合mybatis-plus打印完整SQL语句
插入操作（Insert插入）
@Test
public void testInsert(){
User user = new User();
user.setName("陈志辉");
user.setAge(21);
user.setEmail("[email protected]");
int insert = userMapper.insert(user);
System.out.println(insert);
System.out.println(user);
}
更新操作
@Test
public void testUpdate(){
User user = new User();
//通过条件动态拼接sql
user.setId(1L);
user.setName("chen");
//这里的参数是一个对象，而不是id
int i = userMapper.updateById(user);
System.out.println(i);
}
查询操作：【单一查询、批量查询、条件查询map】
//测试单一查询
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
//批量查询
@Test
public void testSelectByBatchId(){
List users = userMapper.selectBatchIds(Arrays.asList(1L,2L,3L));
users.forEach(System.out::println);
}
//条件查询：map
@Test
public void testSelectBatchIds(){
HashMap map = new HashMap<>();
map.put("name","陈志辉");
map.put("age",21);
List users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分页查询
分页查询在网站上使用的频率极多，因为由于大量的数据需要展示，为了给用户更好的体验，会选择分批展示出来
分页的方式：
（1）原始的limit分页
（2）pageHelper第三方插件
（3）MP其实也内置了分页插件
MP使用分页查询步骤
（1）只需要配置拦截器即可
// 分页插件
@Bean
public MybatisPlusInterceptor MybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
//乐观锁
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
//分页配置
mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mybatisPlusInterceptor;
}
（2）直接使用Page对象即可
//分页查询
@Test
public void testPage(){
Page page = new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
（3）pageHelper第三方插件
1、添加Maven依赖
com.github.pagehelper
pagehelper-spring-boot-starter
1.3.0
如果需要使用最新版本，请前往官方地址获取。
2、添加application.yml配置
pagehelper:
helper-dialect: mysql
reasonable: true
support-methods-arguments: true
3、查询数据库
@Repository
@Mapper
public interface TopicDao {
/**
* 查询所有
* @return
*/
@Select("SELECT * FROM xt_topic")
List findAllTopic();
}
这与单独使用Mybatis不进行分页的查询一致，无需修改。
4、使用PageHelper分页
/**
*
* @param pageNum 当前页
* @param pageSize 页的大小
* @return
*/
public Result findAllTopicByPage(int pageNum, int pageSize) {
Result result = new Result();
PageHelper.startPage(pageNum, pageSize);
try {
List topicList = topicDao.findAllTopic();
PageInfo pageInfo = new PageInfo(topicList);
result.setCode(StatusCode.OK);
result.setMessage("查询成功！");
// result.setData(topicList);
result.setData(pageInfo);
return result;
}catch (Exception e){
e.printStackTrace();
result.setFlag(false);
result.setMessage("出错了！");
return result;
}
}
删除操作
1、根据id删除记录【同查询分为：单一、批量、条件删除map】
//通过id删除
@Test
public void testDeleteById(){
userMapper.deleteById(1L);
}
//批量删除
@Test
public void testDeleteByBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1L,2L,3L));
}
//按照条件删除
@Test
public void testDeleteByMap(){
HashMap map = new HashMap<>();
map.put("name","chen");
userMapper.deleteByMap(map);
}
代码自动生成器
听到这个代码自动生成器，我们会不禁问道，到底有多自动，那我就告诉你有多自动，自动到你可以不用写pojo、不用写mapper、不用写service、不用写controller，全部都让mybatis-plus帮我们自动生成！！！用AutoGenerator来生成各个模块的代码，极大的提升了开发效率
1、导入依赖
org.apache.velocity
velocity-engine-core
com.baomidou
mybatis-plus-generator
3.1.1
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
public class Code {
public static void main(String[] args) {
//需要构建一个代码自动生成器对象
AutoGenerator mpg = new AutoGenerator();
//全局配置
GlobalConfig globalConfig = new GlobalConfig();
String projectPath = System.getProperty("user.dir"); //获取当前项目路径
globalConfig.setOutputDir(projectPath + "/src/main/java");
globalConfig.setAuthor("XXX");
globalConfig.setOpen(false);
globalConfig.setFileOverride(false); //选择是否覆盖
globalConfig.setServiceImplName("%sService");//取消前缀
globalConfig.setIdType(IdType.ID_WORKER);
mpg.setGlobalConfig(globalConfig);
//设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf8&setTimezone=UTC");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
//包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog"); //设置要生成的模块的名字
pc.setParent("com.liu"); //父包
pc.setEntity("pojo");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//策略配置
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setInclude("user");
strategyConfig.setNaming(NamingStrategy.underline_to_camel);
strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
strategyConfig.setEntityLombokModel(true);
strategyConfig.setLogicDeleteFieldName("deleted");
//自动填充设置
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
ArrayList tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategyConfig.setTableFillList(tableFills);
//乐观锁
strategyConfig.setVersionFieldName("version");
strategyConfig.setRestControllerStyle(true);
strategyConfig.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategyConfig);
mpg.execute();
}
}
如果不成功 可参考http://t.csdn.cn/evYOq
————————————————
原文链接：https://blog.csdn.net/liuerchong/article/details/123722544
转载自http://t.csdn.cn/JdXdN 如有问题通知删除