mybatis-plus入手总结（更详细可进入官网查询）
mybatis-plus官网：https://mp.baomidou.com/
官网给出的解释（为简化开发而生）：
1. 只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
2. 只需简单配置，即可快速进行 CRUD 操作，从而节省大量时间。
3. 热加载、代码生成、分页、性能分析等功能一应俱全。
MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
安装：
基于maven的安装：
com.baomidou
mybatis-plus-boot-starter
3.2.0
注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring等，以避免因版本差异导致的问题。
配置：
@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.example.mapper")//扫描持久层包
public class Application {
public static void main(String[] args) {
SpringApplication.run(QuickStartApplication.class, args);
}
}
（相关表注解可查看官网文档）
若想打印通过mybatis-plus组装出来的sql语句，可在application.yml中配置：
#mybatis-plus配置控制台打印完整带参数SQL语句
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
CRUD接口：
说明：
- 泛型T为任意实体对象（对应表字段）
- 对象Wrapper为条件构造器
注：直接调用接口不作说明，具体使用可查看mybatis-plus官网文档，主要解释条件构造器的使用。
selectList：根据entity条件，查询记录结构
/**
* 官网接口：
* 根据 entity 条件，查询全部记录
*
*
* @param queryWrapper 实体对象封装操作类（可以为 null）
* @return 实体集合
*/
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
示例：
//根据条件查询得到全部数据 select * from device_info where imei=?;
//参数为条件构造器，返回对象为List泛型集合
List list = deviceInfoMapper.selectList(new QueryWrapper()
.eq("imei", imei)
);
update：根据 whereEntity 条件，更新记录
/**
* 官网接口：
* 根据 whereEntity 条件，更新记录
*
*
* @param entity 实体对象 (set 条件值,可为 null)
* @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
* @return 修改成功记录数
*/
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);
示例：
//根据条件实现表数据的更新 update update device_info set ... where imei=?;
//参数为实体类对象，条件构造器；返回值为更新成功的条数
int num = deviceInfoService.update(deviceInfo, new QueryWrapper().eq("imei", "imei"));
selectPage：根据 entity 条件，查询全部记录（并翻页）
使用分页功能时需要添加分页插件。
//Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
// 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求 默认false
// paginationInterceptor.setOverflow(false);
// 设置最大单页限制数量，默认 500 条，-1 不受限制
// paginationInterceptor.setLimit(500);
return paginationInterceptor;
}
}
/**
* 官网接口：
* 根据 entity 条件，查询全部记录（并翻页）
*
*
* @param page 分页查询条件（可以为 RowBounds.DEFAULT）
* @param queryWrapper 实体对象封装操作类（可以为 null）
* @return 实体分页对象
*/
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);
示例：
//select DISTINCT c.imei,c.usim from (select DISTINCT imei,usim,created_at from record
//where imei!= '8669710315\\nAT+C' and imei!= '004622414715702' order by created_at desc) c
//参数为分页对象（页码大小，页码数），条件构造器；返回值为分页对象，使用IPage或Page去接收查询返回的结果。
IPage page = recordMapper.selectPage(new Page(pageNo,pageSize),
new QueryWrapper()
.select("distinct imei,usim")
.ne("imei", "8669710315\\\\nAT+C")
.ne("imei", "004622414715702")
.orderByDesc("created_at")
);
//返回得到的分页对象通过调用getRecords()方法，得到存储的内容，使用List接收。具体实现可查看官网源码
//使用条件构造器返回指定的表字段时，可以通过调用.select("表字段，多个字段使用都好隔开")方法实现。
List recordList = page.getRecords();
通过Wrapper自定义sql语句：
注解方式：
@Select("select * from mysql_data ${ew.customSqlSegment}")
List getAll(@Param(Constants.WRAPPER) Wrapper wrapper);
说明：自定义sql语句中的条件来源于你调用自己定义的持久层的方法时，传入参数的设置，即业务层条件构造器的使用方式，与以上文章说明的条件构造器的调用使用方法一致。
示例：
持久层：
@Select("select * from user ${ew.customSqlSegment}")
List getAllMapper(@Param(Constants.WRAPPER) Wrapper wrapper);
业务层：
public void getAllService(){
//select * from user where id != 4;//其他条件可直接使用条件构造器添加（单表简单语句）
List list = userMapper.getAll(new QueryWrapper()
.ne("id","4"));
for(User user:list){
System.out.println(user);
}
}
自定义sql的分页查询方式
持久层：
@Select("select * from record ${ew.customSqlSegment}")
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper wrapper);
业务层：
public void getPageService(){
Page page = new Page<>(1,10);
QueryWrapper wrapper = new QueryWrapper<>();
wrapper.eq("imei", "866971030896174");
IPage pages = rm.selectPage(page,wrapper);
List list = pages.getRecords();
for(Record r : list) {
System.out.println(r);
}
}
代码生成器：
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
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.TemplateConfig;
import com.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
public class MpAutoGenerator {
private static String packageName="src/main"; //初始文件路径
private static String customPath="springboot_mybatisplus"; //自定义路径
private static String authorName="mzb"; //作者
private static String table="mapper"; //table名字
private static String prefix=""; //table前缀
private static File file = new File(packageName);
private static String path = file.getAbsolutePath();
public static void main(String[] args) {
System.out.println("绝对路径" + path);
// 自定义需要填充的字段
List tableFillList = new ArrayList<>();
tableFillList.add(new TableFill("ASDD_SS", FieldFill.INSERT_UPDATE));
// 代码生成器
AutoGenerator mpg = new AutoGenerator().setGlobalConfig(
// 全局配置
new GlobalConfig()
.setOutputDir(path+"/java")//输出目录
.setFileOverride(true)// 是否覆盖文件
.setActiveRecord(true)// 开启 activeRecord 模式
.setEnableCache(false)// XML 二级缓存
.setBaseResultMap(true)// XML ResultMap
.setBaseColumnList(true)// XML columList
.setOpen(false)//生成后打开文件夹
.setAuthor(authorName)
// 自定义文件命名，注意 %s 会自动填充表实体属性！
.setMapperName("%sMapper")
.setXmlName("%sMapper")
.setServiceName("%sService")
.setServiceImplName("%sServiceImpl")
.setControllerName("%sController")
).setDataSource(
// 数据源配置
new DataSourceConfig()
.setDbType(DbType.MYSQL)// 数据库类型
.setTypeConvert(new MySqlTypeConvert() {
// 自定义数据库表字段类型转换【可选】
@Override
public DbColumnType processTypeConvert(GlobalConfig globalConfig,String fieldType) {
System.out.println("转换类型：" + fieldType);
// if ( fieldType.toLowerCase().contains( "tinyint" ) ) {
// return DbColumnType.BOOLEAN;
// }
return (DbColumnType)super.processTypeConvert(globalConfig,fieldType);
}
})
.setDriverName("com.mysql.cj.jdbc.Driver")
.setUsername("root")
.setPassword("password")
.setUrl("jdbc:mysql://localhost:3306/demo?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC")
).setStrategy(
// 策略配置
new StrategyConfig()
// .setCapitalMode(true)// 全局大写命名
//.setDbColumnUnderline(true)//全局下划线命名
.setTablePrefix(new String[]{prefix})// 此处可以修改为您的表前缀
.setNaming(NamingStrategy.underline_to_camel)// 表名生成策略
.setInclude(new String[] { table }) // 需要生成的表
.setRestControllerStyle(true)
//.setExclude(new String[]{"test"}) // 排除生成的表
// 自定义实体父类
// .setSuperEntityClass("com.baomidou.demo.TestEntity")
// 自定义实体，公共字段
//.setSuperEntityColumns(new String[]{"test_id"})
.setTableFillList(tableFillList)
// 自定义 mapper 父类
// .setSuperMapperClass("com.baomidou.demo.TestMapper")
// 自定义 service 父类
// .setSuperServiceClass("com.baomidou.demo.TestService")
// 自定义 service 实现类父类
// .setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl")
// 自定义 controller 父类
//.setSuperControllerClass("com.captainxero"+packageName+".controller.AbstractController")
// 【实体】是否生成字段常量（默认 false）
// public static final String ID = "test_id";
// .setEntityColumnConstant(true)
// 【实体】是否为构建者模型（默认 false）
// public User setName(String name) {this.name = name; return this;}
// .setEntityBuilderModel(true)
// 【实体】是否为lombok模型（默认 false）document
// .setEntityLombokModel(true)
// Boolean类型字段是否移除is前缀处理
// .setEntityBooleanColumnRemoveIsPrefix(true)
// .setRestControllerStyle(true)
// .setControllerMappingHyphenStyle(true)
).setPackageInfo(
// 包配置
new PackageConfig()
//.setModuleName("User")
.setParent("com.example.mpdemo." + customPath)// 自定义包路径
.setController("controller")// 这里是控制器包名，默认 web
.setEntity("entity")
.setMapper("mapper")
.setService("service")
.setServiceImpl("service.impl")
//.setXml("mapper")
)
// .setCfg(
// // 注入自定义配置，可以在 VM 中使用 cfg.abc 设置的值
// new InjectionConfig() {
// @Override
// public void initMap() {
// Map map = new HashMap<>();
// map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
// this.setMap(map);
// }
// }.setFileOutConfigList(Collections.singletonList(new FileOutConfig("/templates/mapper.xml.vm") {
// // 自定义输出文件目录
// @Override
// public String outputFile(TableInfo tableInfo) {
// return path+"/resources/mapper/" + tableInfo.getEntityName() + "Mapper.xml";
// }
// }))
// )
.setTemplate(
// 关闭默认 xml 生成，调整生成 至 根目录
new TemplateConfig().setXml(null)
// 自定义模板配置，模板可以参考源码 /mybatis-plus/src/main/resources/template 使用 copy
// 至您项目 src/main/resources/template 目录下，模板名称也可自定义如下配置：
// .setController("...");
// .setEntity("...");
// .setMapper("...");
// .setXml("...");
// .setService("...");
// .setServiceImpl("...");
);
// 执行生成
mpg.execute();
// 打印注入设置，这里演示模板里面怎么获取注入内容【可无】
// System.err.println(mpg.getCfg().getMap().get("abc"));
}
}