01-Mybatis-Plus介绍
1.1 什么是mybatis-plus
官网: 简介 | MyBatis-Plus
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
1.2 官方愿景
1.3 特性
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
1.4 支持数据库
- mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
1.5 框架结构
02-快速入门
2.1 创建springboot项目(可以参考优众17-idea使用详解)
(1).并引入依赖
<dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.2.0</version></dependency>
- 注意:不需要在引入mybatis的相关依赖,只引入这一个即可,当然数据库相关的驱动还的显式引入
(2).引入数据库的相关依赖,比如mysql数据库依赖(我使用的是mysql数据库所以我引入mysql的依赖)
<!--mysql--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><scope>runtime</scope></dependency><!--阿里数据库连接池--><dependency><groupId>com.alibaba</groupId><artifactId>druid</artifactId><version>1.1.19</version></dependency>
(3).在入口类加入注解
@SpringBootApplication@MapperScan("com.baizhi.dao")public class MybatisApplication {public static void main(String[] args) {SpringApplication.run(MybatisApplication.class, args);}}
(4).编写配置文件
spring.datasource.type=com.alibaba.druid.pool.DruidDataSourcespring.datasource.driver-class-name=com.mysql.jdbc.Driverspring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=UTF-8spring.datasource.username=rootspring.datasource.password=rootlogging.level.root=infologging.level.com.baizhi.dao=debug
2.2 创建数据库以及表结构(实例)
DROP TABLE IF EXISTS `user`;CREATE TABLE `user` (`id` int(11) NOT NULL AUTO_INCREMENT,`name` varchar(255) DEFAULT NULL,`age` int(11) DEFAULT NULL,`bir` timestamp NULL DEFAULT NULL,PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8;SET FOREIGN_KEY_CHECKS = 1;
2.3 开发实体类
@Data //lombok的注解用来生成get set 等相关方法public class User {private String id;private String name;private Integer age;private Date bir;}
2.4 开发mapper通用实现
import com.baomidou.mybatisplus.core.mapper.BaseMapper; //提供了各种CRUD方法public interface UserDAO extends BaseMapper<User> {}
2.5 测试
@Autowiredprivate UserDAO userDAO;@Testvoid contextLoads() {List<User> users = userDAO.selectList(null);System.out.println(users);}
03-常用注解说明
- @TableName
- @TableId
- @TableField
3.1 @TableName注解
- 描述:用来将实体对象与数据库表名完成映射
- 修饰范围: 用在类上
- 常见属性:
- value: String类型,指定映射的表名
- resultMap: String类型,用来指定XML配置中resultMap的id值
-
属性 | 类型 | 必须指定 | 默认值 | 描述 |
value | String | 否 | "" | 表名 |
schema | String | 否 | "" | schema |
keepGlobalPrefix | boolean | 否 | false | 是否保持使用全局的 tablePrefix 的值(当全局 tablePrefix 生效时) |
resultMap | String | 否 | "" | xml 中 resultMap 的 id(用于满足特定类型的实体类对象绑定) |
autoResultMap | boolean | 否 | false | 是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建与注入) |
excludeProperty | String[] | 否 | {} | 需要排除的属性名 @since 3.3.1 |
3.2 @TableId注解
- 描述:主键注解
- 修饰范围: 用在属性上
- 常见属性:
- value: String类型,指定实体类中与表中对应的主键列名
- type: 枚举类型,指定主键生成类型
-
属性 | 类型 | 必须指定 | 默认值 | 描述 |
value | String | 否 | "" | 主键字段名 |
type | Enum | 否 | IdType.NONE | 指定主键类型 |
type属性:
3.3 @TableField
- 描述:字段注解(非主键)
- 修饰范围:用在属性上
- 常用属性:
- value: String类型,用来指定对应的数据库表中的字段名
- el: String类型,映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分 3.0不存在
- exist: boolean是否为数据库表字段 true代表是数据库字段,false代表不是
-
属性 | 类型 | 必须指定 | 默认值 | 描述 |
value | String | 否 | "" | 数据库字段名 |
exist | boolean | 否 | true | 是否为数据库表字段 |
condition | String | 否 | "" | 字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s} |
update | String | 否 | "" | 字段 update set 部分注入,例如:当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 (该属性优先级高于 el 属性) |
insertStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:NOT_NULL insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>) |
updateStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:IGNORED update table_a set column=#{columnProperty} |
whereStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:NOT_EMPTY where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if> |
fill | Enum | 否 | FieldFill.DEFAULT | 字段自动填充策略 |
select | boolean | 否 | true | 是否进行 select 查询 |
keepGlobalFormat | boolean | 否 | false | 是否保持使用全局的 format 进行处理 |
jdbcType | JdbcType | 否 | JdbcType.UNDEFINED | JDBC 类型 (该默认值不代表会按照该值生效) |
typeHandler | Class<? extends TypeHandler> | 否 | UnknownTypeHandler.class | 类型处理器 (该默认值不代表会按照该值生效) |
numericScale | String | 否 | "" | 指定小数点后保留的位数 |
关于`jdbcType`和`typeHandler`以及`numericScale`的说明:
numericScale只生效于 update 的 sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效于 update 的 sql. 对于typeHandler如果你的字段类型和 set 进去的类型为equals关系,则只需要让你的typeHandler让 Mybatis 加载到即可,不需要使用注解
insertStrategy,updateStrategy,whereStrategy 属性:
fill 属性:
04-常用方法
4.1 查询方法
- 查询所有@Testpublic void testFindAll(){List<User> users = userDAO.selectList(null);users.forEach(user-> System.out.println("user = " + user));}
- 查询一个@Testpublic void testFindOne(){User user = userDAO.selectById("1");System.out.println("user = " + user);}
- 条件查询//条件查询@Testpublic void testFind(){QueryWrapper<User> queryWrapper = new QueryWrapper<>();//queryWrapper.eq("age",23);//设置等值查询//queryWrapper.lt("age",23);//设置小于查询//queryWrapper.ge("age",23);//小于等于查询 gt 大于 ge 大于等于List<User> users = userDAO.selectList(queryWrapper);users.forEach(user-> System.out.println(user));}
- 模糊查询@Testpublic void testFindAll(){QueryWrapper<User> queryWrapper = new QueryWrapper<>();queryWrapper.likeRight("username","小");List<User> users = userDAO.selectList(queryWrapper);users.forEach(user-> System.out.println("user = " + user));}
- like 相当于 %?%
- likeLeft 相当于 %?
- likeRight 相当于 ?%
-
4.2 添加方法
- 添加方法@Testpublic void testSave(){User entity = new User();entity.setAge(23).setName("小明明").setBir(new Date());userDAO.insert(entity);}
4.3 修改方法
- 基于id修改@Testpublic void testUpdateById(){User user = userDAO.selectById("1");user.setAge(24);userDAO.updateById(user);}基于条件修改@Testpublic void testUpdate(){User user = userDAO.selectById("1");user.setName("小陈陈");QueryWrapper<User> updateWrapper = new QueryWrapper<>();updateWrapper.eq(true,"age",23);userDAO.update(user, updateWrapper);}
4.4 删除方法
- 基于id删除@Testpublic void testDeleteById(){userDAO.deleteById("3");}
- 基于条件删除@Testpublic void testDelete(){QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.lambda().eq(true,User::getAge,23);userDAO.delete(wrapper);}
05-Mybatis-Plus分页查询
5.1.预先配置
- 注意:使用分页查询必须设置mybatis-plus提供的分页插件,才能实现分页效果@EnableTransactionManagement@Configuration@MapperScan("com.baizhi.dao")public class MybatisPlusConfig {@Beanpublic PaginationInterceptor paginationInterceptor() {PaginationInterceptor paginationInterceptor = new PaginationInterceptor();return paginationInterceptor;}}注意事项:目前分页查询仅仅支持单表查询,不能再表连接时使用分页插件
5.2.分页查询
- 非条件分页查询@Testpublic void testFindAll(){IPage<User> page = new Page<>(1,2);page = userDAO.selectPage(page, null);page.getRecords().forEach(user -> System.out.println("user = " + user));}
- 带条件分页查询@Testpublic void testFindAll(){QueryWrapper<User> queryWrapper = new QueryWrapper<>();queryWrapper.eq("age",23);IPage<User> page = new Page<>(1,2);page = userDAO.selectPage(page, queryWrapper);page.getRecords().forEach(user-> System.out.println("user = " + user));}
06- 逻辑删除
实体类逻辑删除字段上添加注解@TableLogic
//逻辑删除@TableLogicprivate int deleted;
创建类,添加Configuration注解
package com.kuang.config;import com.baomidou.mybatisplus.core.injector.ISqlInjector;import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;import org.springframework.context.annotation.*;@Configurationpublic class MyDeletedConfig {@Beanpublic ISqlInjector sqlInjector(){return new LogicSqlInjector();}}
配置
mybatis-plus:global-config:db-config:logic-delete-value: 1 # 逻辑已删除值(默认为 1)logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
测试
//根据id删除@Testvoid deleteById(){int i = userMapper.deleteById(4L);System.out.println(i);}
实际上,逻辑删除,走的是update,更新操作,并不是删除操作!
根据id查询并不会查到逻辑删除的数据!
07- Mybatis-Plus多数据源配置
引言
为了确保数据库产品的稳定性,很多数据库拥有双机热备功能。也就是,第一台数据库服务器,是对外提供增删改业务的生产服务器;第二台数据库服务器,主要进行读的操作。·
7.1 引入dynamic-datasource-spring-boot-starter
<dependency><groupId>com.baomidou</groupId><artifactId>dynamic-datasource-spring-boot-starter</artifactId><version>3.0.0</version></dependency>
7.2 配置数据源
spring.datasource.primary=master #指定默认数据源spring.datasource.dynamic.datasource.master.driver-class-name=com.mysql.jdbc.Driverspring.datasource.dynamic.datasource.master.url=jdbc:mysql://localhost:3306/mybatis-plus?characterEncoding=UTF-8spring.datasource.dynamic.datasource.master.username=rootspring.datasource.dynamic.datasource.master.password=rootspring.datasource.dynamic.datasource.slave_1.driver-class-name=com.mysql.jdbc.Driverspring.datasource.dynamic.datasource.slave_1.url=jdbc:mysql://localhost:3306/mybatis-plus-1?characterEncoding=UTF-8spring.datasource.dynamic.datasource.slave_1.username=rootspring.datasource.dynamic.datasource.slave_1.password=root
7.3 创建多个数据库模拟不同mysql服务
7.4 @DS注解
- 作用: 用来切换数据源的注解
- 修饰范围: 方法上和类上,同时存在方法注解优先于类上注解。
- Value属性: 切换数据源名称
7.5 开发业务层
- 业务接口public interface UserService{List<User> findAll();void save(User user);}
- 业务实现类@Service@Transactionalpublic class UserServiceImpl implements UserService {@Autowiredprivate UserDAO userDAO;@Overridepublic List<User> findAll() {return userDAO.selectList(null);}@Overridepublic void save(User user) {userDAO.insert(user);}}
7.6 测试结果
package com.baizhi;import com.baizhi.entity.User;import com.baizhi.service.UserService;import org.junit.jupiter.api.Test;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.test.context.SpringBootTest;import java.util.Date;@SpringBootTestpublic class TestUserService {@Autowiredprivate UserService userService;@Testpublic void testFindAll(){userService.findAll().forEach(user-> System.out.println("user = " + user));}@Testpublic void testSave(){User user = new User();user.setName("aaa").setAge(23).setBir(new Date());userService.save(user);}}