1、Mybatis Plus简介
- Mybatis-plus是Mybatis的增强工具，为简化开发而生。
2、特性
- 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
- 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
3、Mybatis Plus集成Spring Boot
3.1、导入mybatis-puls依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<-- 版本按自己需要选择也可以 -->
<version>3.5.1</version>
</dependency>3.2、创建测试数据库 ~ mybatis-plus-test
1、创建user测试表
DROP TABLE IF EXISTS user;
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)
);
-- 插入数据
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');3.3、配置yml文件
spring:
application:
name: springboot-day01-mybatis-puls
# 连接MySQL数据库
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis-plus-test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=GMT%2B8
username: root
password:
# mybatis plus基本配置
mybatis-plus:
# 配置实体别名
type-aliases-package: com.ruanjia.entity
# 配置mapper映射位置
mapper-locations: classpath*:mappers/**/*Mapper.xml
# 日志配置
logging:
level:
com.ruanjia: debug3.4、配置mapper包扫描
注意：简单配置直接在启动类添加注解@MapperScan(value = "mapper包位置")，也可以创建一个Mybatis Plus配置类配置（自行百度）。
/** 开启mapper扫描 */
@MapperScan(value = "com.ruanjia.mapper")
@SpringBootApplication
public class SpringbootDay01MybatisPlusApplication
{
public static void main(String[] args)
{
SpringApplication.run(SpringbootDay01MybatisPlusApplication.class, args);
}
}3.5、编写User测试类
作用：用于测试Mybatis plus CRUD
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 9:56
*/
@TableName( value = "user") //指定数据库表名称
@Data
public class User
{
//value指定对应表字段名，type选择ID生成策略（这里实例选择ID自增策略）
@TableId(value = "id", type = IdType.AUTO)
private Long id;
//指定对应表字段名
@TableField("name")
private String name;
//指定对应表字段名
@TableField("age")
private Integer age;
//指定对应表字段名
@TableField("email")
private String email;
//exist=false 表示这不是数据库字段
@TableField(exist = false)
private String password;
public User() {
}
public User(Long id, String name, Integer age, String email) {
this.id = id;
this.name = name;
this.age = age;
this.email = email;
}
}
3.6、在mapper包下创建IUserMapper测试接口
使用方法：继承BaseMapper接口指定一个被操作的实体对象。
/**
* BaseMapper<你要使用的实体对象>
*
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 9:59
*/
@Repository //注入spring容器mybatis才能扫描到（启动类配置了mapper包扫描注解@MapperScan）
public interface IUserMapper extends BaseMapper<User>
{
}
3.7、测试
测试：直接在spring boot测试环境编写一个对应的测试类
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 10:01
*/
@SpringBootTest
public class IUserMapperTest01
{
@Autowired
private IUserMapper userMapper;
@Test
public void selectUserTest01()
{
System.out.println("----- 查询测试 -----");
/**
* 查询条件为null表示，查询所有数据（select * from user）
*/
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}查询结果：
----- 查询测试 -----
2022-05-21 10:29:10.451 INFO 5824 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Starting...
2022-05-21 10:29:10.642 INFO 5824 --- [ main] com.zaxxer.hikari.HikariDataSource : HikariPool-1 - Start completed.
2022-05-21 10:29:10.647 DEBUG 5824 --- [ main] c.ruanjia.mapper.IUserMapper.selectList : ==> Preparing: SELECT id,name,age,email FROM user
2022-05-21 10:29:10.666 DEBUG 5824 --- [ main] c.ruanjia.mapper.IUserMapper.selectList : ==> Parameters:
2022-05-21 10:29:10.680 DEBUG 5824 --- [ main] c.ruanjia.mapper.IUserMapper.selectList : <== Total: 5
User(id=1, name=Jone, age=18, email=test1@baomidou.com, password=null)
User(id=2, name=Jack, age=20, email=test2@baomidou.com, password=null)
User(id=3, name=Tom, age=28, email=test3@baomidou.com, password=null)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com, password=null)
User(id=5, name=Billie, age=24, email=test5@baomidou.com, password=null)3.8、总结
- 导入Mybatis Plus依赖
- 创建测试数据库和user表
- 配置yml
- 配置mapper包扫描
- 创建User测试对象
- 在创建mapper包创建User对应的测试接口
- 测试
4、代码生成器
4.1、导入生成器依赖
<!-- 代码生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.0</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>4.2、生成测试案例
使用方法：根据注释修改即可
/**
* Mybatis Plus代码生成器
*
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 12:16
*/
public class CodeGeneratorTest01
{
public static void main(String[] args)
{
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局策略配置
GlobalConfig gc = new GlobalConfig();
// 生成位置设置
String projectPath = System.getProperty("user.dir") + "\\springboot-day01-mybatis-puls";
System.out.println(":::"+projectPath);
gc.setOutputDir(projectPath+"/src/main/java");
gc.setAuthor("ruanjia");
gc.setOpen(false);
gc.setFileOverride(true);
gc.setServiceName("I%sService");
gc.setMapperName("I%sMapper");
gc.setIdType(IdType.AUTO);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(false);
mpg.setGlobalConfig(gc);
// 数据源配置，通过该配置，指定需要生成代码的具体数据库
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/mybatis-plus-test?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=GMT%2B8");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 配置生成代码存放位置
PackageConfig pc = new PackageConfig();
pc.setModuleName(null);
// 父路径
pc.setParent("com.ruanjia");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
// 数据库表配置，可指定需要生成哪些表或者排除哪些表
StrategyConfig strategy = new StrategyConfig();
// 要生成代码的表，格式：("user","sys_log",......)
strategy.setInclude("user");
// 实体对象属性驼峰（变字段 _ 线分割）
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setEntityTableFieldAnnotationEnable(true);
strategy.setControllerMappingHyphenStyle(false);
mpg.setStrategy(strategy);
// 将Mapper.xml文件生成到resources目录下
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {}
};
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出 --> 指定模板
focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
return projectPath + "/src/main/resources/mappers/"
+ "/" + tableInfo.getEntityName()
+ "Mapper"
+ StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 模板配置，可自定义代码生成的模板，实现个性化操作
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
mpg.execute();//执行
}
}4.3、结果
5、Mapper－CRUD接口
５.１、插入操作
方法 -》
1、插入一条数据
int insert(T entity);
测试 -》
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 13:18
*/
@SpringBootTest
public class IUserMapperInsertTest
{
@Autowired
private IUserMapper userMapper;
/**
* 插入一条记录
* int insert(T entity);
*/
@Test
public void insert01()
{
// 由于User对象Id注解使用都是自动递增策略，所以数据库注解id必须设置自动递增否则报错！
User user = new User();
user.setName("测试插入01");
user.setAge(18);
user.setEmail("test01@qq.com");
if (userMapper.insert(user) > 0) {
System.out.println("插入数据成功！");
} else {
System.out.println("插入数据失败！");
}
}
}５.２、删除操作
方法 -》
1、根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper<T> wrapper);2、删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);3、根据 ID 删除
int deleteById(Serializable id);4、根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
测试 -》
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 13:18
*/
@SpringBootTest
public class IUserMapperDeleteTest02
{
@Autowired
private IUserMapper userMapper;
// 1、根据 entity 条件，删除记录
@Test
public void delete01()
{
User user = new User();
user.setName("测试插入01");//根据名字删除
userMapper.delete(new QueryWrapper<>(user));
}
// 2、删除（根据ID 批量删除）
@Test
public void delete02()
{
userMapper.deleteBatchIds(Arrays.asList(1,2,3));
}
// 3、根据 ID 删除
@Test
public void delete03()
{
userMapper.deleteById(4);
}
// 4、根据 columnMap 条件，删除记录
@Test
public void delete04()
{
Map<String, Object> map = new HashMap<>();
map.put("id", 5);
map.put("name", "Billie");
userMapper.deleteByMap(map);
}
}５.３、修改操作
方法-》
1、根据 whereWrapper 条件，更新记录
int update(@Param(Constants.ENTITY) T updateEntity, @Param(Constants.WRAPPER) Wrapper<T> whereWrapper);
2、根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);
测试 -》
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 13:18
*/
@SpringBootTest
public class IUserMapperUpdateTest03
{
@Autowired
private IUserMapper userMapper;
// 1、根据 whereWrapper 条件，更新记录（根据条件批量修改）
@Test
public void update01()
{
/** 修改条件（map=key对应字段名，value对应字段值） */
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
Map<String, Object> map = new HashMap<>();
map.put("id", 8);
map.put("name", "test2");
queryWrapper.allEq(map);
User user = new User();
user.setName("update test");
user.setAge(100);
user.setEmail("update_test@qq.com");
userMapper.update(user, queryWrapper);
}
@Test
public void update02()
{
User user = new User();
user.setName("update test");
user.setAge(100);
user.setEmail("update_test@qq.com");
userMapper.update(user, new QueryWrapper<User>().like("name", "test"));
}
// 2、根据 ID 修改
@Test
public void update03()
{
User user = new User();
user.setId(8L);
user.setName("测试修改按ID");
userMapper.updateById(user);
}
}
５.４、查询操作
方法 -》
1、根据 ID 查询
T selectById(Serializable id);
2、根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);3、查询（根据ID 批量查询）
List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends Serializable> idList);
4、根据 entity 条件，查询全部记录
List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
5、查询（根据 columnMap 条件）
List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
6、根据 Wrapper 条件，查询全部记录
List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
7、根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);8、根据 entity 条件，查询全部记录（并翻页）
IPage<T> selectPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
9、根据 Wrapper 条件，查询全部记录（并翻页）
IPage<Map<String, Object>> selectMapsPage(IPage<T> page, @Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
10、根据 Wrapper 条件，查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
测试 -》
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 13:18
*/
@Slf4j
@SpringBootTest
public class IUserMapperSelectTest01
{
@Autowired
private IUserMapper userMapper;
// 1、根据 ID 查询
@Test
public void selectByIdTest()
{
User user = userMapper.selectById(9L);
log.info("{}", user);
}
// 2、根据 entity 条件，查询一条记录
@Test
public void selectOneTest()
{
QueryWrapper<User> query = new QueryWrapper<>();
query.select("id", "name", "age", "email");
// query.eq("id", 9);
query.last(" where id=9");
User user = userMapper.selectOne(query);
log.info("{}", user);
}
// 3、查询（根据ID 批量查询）
@Test
public void selectBatchIdsTest()
{
List<User> userList = userMapper.selectBatchIds(Arrays.asList(9, 10, 11, 12));
userList.forEach(System.out::println);
}
// 4、根据 entity 条件，查询全部记录
@Test
public void selectListTest01()
{
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}
@Test
public void selectListTest02()
{
List<User> userList = userMapper.selectList(new QueryWrapper<User>().eq("name", "update test"));
userList.forEach(System.out::println);
}
// 5、查询（根据 columnMap 条件）
@Test
public void selectByMapTest02()
{
Map<String, Object> map = new HashMap<>();
map.put("id", 9);
map.put("name", "update test");
List<User> userList = userMapper.selectByMap(map);
userList.forEach(System.out::println);
}
// 6、根据 Wrapper 条件，查询全部记录
@Test
public void selectMapsTest02()
{
List<Map<String, Object>> maps = userMapper.selectMaps(new QueryWrapper<User>().eq("id", 9));
maps.forEach(System.out::println);
}
// 7、根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
@Test
public void selectObjsTest03()
{
List<Object> list = userMapper.selectObjs(new QueryWrapper<User>().eq("name", "update test"));
list.forEach(System.out::println);
}
// 8、根据 entity 条件，查询全部记录（并翻页）
@Test
public void selectPageTest03()
{
IPage<User> page = new Page<>(2,10);
QueryWrapper<User> queryUser = new QueryWrapper<>();
// queryUser.eq("id", 9);
IPage<User> userPages = userMapper.selectPage(page, queryUser);
log.info("总页数：{}", userPages.getPages());
log.info("总记录数：{}", userPages.getTotal());
log.info("当前页：{}", userPages.getCurrent());
log.info("当前页大小：{}", userPages.getSize());
userPages.getRecords().forEach(System.out::println);
}
// 9、根据 Wrapper 条件，查询全部记录（并翻页）
@Test
public void selectMapsPageTest03()
{
IPage<Map<String, Object>> page = new Page<>(1,10);
IPage<Map<String, Object>> mapIPage = userMapper.selectMapsPage(page, new QueryWrapper<User>()
.eq("name", "update test"));
log.info("总页数：{}", mapIPage.getPages());
log.info("总记录数：{}", mapIPage.getTotal());
log.info("当前页：{}", mapIPage.getCurrent());
log.info("当前页大小：{}", mapIPage.getSize());
mapIPage.getRecords().forEach(System.out::println);
}
// 10、根据 Wrapper 条件，查询总记录数
@Test
public void selectCountTest03()
{
Integer count = userMapper.selectCount(null);
log.info("总数：{}", count);
}
}6、service - CRUD
后续更新（和mapper-CRUD用法大致一样方法名有一点变化）......
7、分页插件的基本使用
注意：使用过分页插件可能遇到 mybatis-plus 依赖和 代码生成器依赖冲突，自行百度...
7.1、在 MybatisPlusConfig 配置类配置分页插件
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 16:58
*/
@Configuration
@MapperScan("com.**.mapper") //开启mapper包扫描
public class MyBatisPlusConfig
{
/**
* 新的分页插件,一缓和二缓遵循mybatis的规则,需要设置 MybatisConfiguration#useDeprecatedExecutor = false 避免缓存出现问题(该属性会在旧插件移除后一同移除)
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
@Bean
public ConfigurationCustomizer configurationCustomizer() {
return configuration -> configuration.setUseDeprecatedExecutor(false);
}
}7.2、测试分页效果
/**
* @author cms
* @version 1.0.0.0
* @Date: 2022/5/21 13:18
*/
@Slf4j
@SpringBootTest
public class IUserMapperSelectTest01
{
@Autowired
private IUserMapper userMapper;
// 8、根据 entity 条件，查询全部记录（并翻页）
@Test
public void selectPageTest03()
{
IPage<User> page = new Page<>(2,10);
QueryWrapper<User> queryUser = new QueryWrapper<>();
// queryUser.eq("id", 9);
IPage<User> userPages = userMapper.selectPage(page, queryUser);
log.info("总页数：{}", userPages.getPages());
log.info("总记录数：{}", userPages.getTotal());
log.info("当前页：{}", userPages.getCurrent());
log.info("当前页大小：{}", userPages.getSize());
userPages.getRecords().forEach(System.out::println);
}
// 9、根据 Wrapper 条件，查询全部记录（并翻页）
@Test
public void selectMapsPageTest03()
{
IPage<Map<String, Object>> page = new Page<>(1,10);
IPage<Map<String, Object>> mapIPage = userMapper.selectMapsPage(page, new QueryWrapper<User>()
.eq("name", "update test"));
log.info("总页数：{}", mapIPage.getPages());
log.info("总记录数：{}", mapIPage.getTotal());
log.info("当前页：{}", mapIPage.getCurrent());
log.info("当前页大小：{}", mapIPage.getSize());
mapIPage.getRecords().forEach(System.out::println);
}
}
运行结果：
扫一扫
1万+
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
