mp的简介
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-plus依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.2.0</version>
</dependency>
配置文件
#数据源信息
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#characterEncoding防止您添加到数据库的数据出现乱码
spring.datasource.url=jdbc:mysql://localhost:3306/ceshi?serverTimezone=Asia/Shanghai&characterEncoding=UTF8
spring.datasource.username=root
spring.datasource.password=123456
#指定mybatis映射文件的路径 classpath是编译后的路径
mybatis-plus.mapper-locations=classpath:/mapper/*.xml
#控制台打印sql日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
表的实体类
@Data
public class User {
Integer id;
String name;
Integer age;
String email;
}
表的dao接口UserDao
@Mapper
public interface UserDao extends BaseMapper<User> {
}
单元测试
@Autowired
private UserDao userDao;
@Test
void contextLoads() {
User user = userDao.selectById(5);
System.out.println(user);
}
注意
如果实体类和表名不一致，以及属性名和列明不一致，主键属性和类名不一致
@TableName(value = "表名")//加载类上，value值映射数据库表名
@TableId(value = "列名")//标记该属性为表的主键列，属性名和主键列名映射
@TableField(value = "列明") //让属性名和列名映射
@Data
@TableName(value = "user")//如果没有添加该注解，默认实体类的类名映射数据库的表名
public class User {
@TableId(value = "id")//标记该属性为表的主键列，属性名和主键列明映射
Integer uid;
@TableField(value = "name") //让属性名和列名映射
String username;
Integer age;
String email;
}
CRUD操作
@SpringBootTest
class SpringbootMybatisplusApplicationTests {
@Autowired
private UserDao userDao;
//根据id查询
@Test
void contextLoads() {
User user = userDao.selectById(5);
System.out.println(user);
}
//添加操作
@Test
void addUser() {
final User user = new User();
user.setAge(18);
user.setUsername("cjj");
user.setEmail("12456@qq.com");
int insert = userDao.insert(user);
System.out.println("影响的行数:"+insert);
}
//删除
@Test
void delete() {
//根据id删除
final int i = userDao.deleteById(1670753441727852545L);
System.out.println("删除了:"+i+"行");
//批量删除
List<Integer> integers = Arrays.asList(1, 5, 6, 9, 10);
int i1 = userDao.deleteBatchIds(integers);
System.out.println("删除了:"+i1+"行");
final UpdateWrapper<User> wrapper = new UpdateWrapper<>();//修改条件用的构造器
wrapper.like("name","t");//name==%t%
wrapper.or(); //默认多个条件使用and连接，如果使用or，则调用or
wrapper.between("age",18,30); //第一个参数是列名，第二个和第三个参数是区间，这个方法是批量删除出区间中的值
final int delete = userDao.delete(wrapper);//Wrapper对象:它是条件构造器
System.out.println("删除了:"+delete+"行");
}
//修改
@Test
void insert() {
final User user = new User();
user.setUid(1670757716260470785L);
user.setUsername("测试第一次");
user.setAge(50);
user.setEmail("654321@qq.com");
userDao.updateById(user);
}
//查询所有
@Test
void select() {
final List<User> users = userDao.selectList(null);
System.out.println(users);
}
}
根据条件查询
@Test
void select() {
Page<User> userPage = new Page<>(1,2);
QueryWrapper<User> userQueryWrapper = new QueryWrapper<>();
// userQueryWrapper.like("name","旦");//模糊查询
userQueryWrapper.select("id","name");//查询指定列的值
// userQueryWrapper.groupBy("name");//分组查询 分组中的列要包含查询指定列的值
List<User> users = userDao.selectList(userQueryWrapper);//根据条件查询，如果条件为空，则查询所有
Page<User> userPage1 = userDao.selectPage(userPage, userQueryWrapper);//分页条件查询
User user = userDao.selectOne(userQueryWrapper);//根据条件查询一条记录
}
联表,分页条件查询
（1）配置类
@Configuration
public class MybatisPlusConfig {
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//数据库的类型改为自己类型
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
DAO层
mapper文件
测试
@Autowired
private StudentDao studentDao;
//联表分页查询
@Test
void selectConnect() {
final Page<Student> studentPage = new Page<>(1,5);
QueryWrapper<Student> studentQueryWrapper = new QueryWrapper<>();
studentDao.pageFindAll(studentPage,studentQueryWrapper);
}
代码生成器
依赖
<!-- 代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version>
</dependency>
配置代码生成器
package com.cjj.config;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
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("E:\idea\junjie\springboot-mybatisplus/src/main/java");//配置生成后的存放位置
gc.setAuthor("cjj");//作者名
gc.setOpen(false);
gc.setSwagger2(true); //生成Swagger2文档注解
mpg.setGlobalConfig(gc);
// 数据源配置,配置需要生成的数据库信息
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/ssm2?serverTimezone=Asia/Shanghai&characterEncoding=UTF8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("student"));//生成的父包
pc.setParent("com.cjj"); //com.cjj.ssm2
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 的名称会跟着发生变化！！
//projectPath 改为包路径 如果不想在mapper中生成子文件 就删掉pc.getModuleName()
return "E:\idea\junjie\springboot-mybatisplus" + "/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(""); //设置需要去掉的数据库表前缀
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
