任何能使用
MyBatis
进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下,如果不在下列表查看分页部分教程 PR 您的支持。
官网地址:https://baomidou.com/pages/24112f/
pom.xml
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-boot-starterartifactId>
<version>3.5.3.1version>
dependency>
123456
application.yml
#mybatis-plus
mybatis-plus:
#配置类型别名所对应的包
type-aliases-package: com.example.domain
#设置mybatis-Plus的统全局配置
global-config:
db-config:
#设置实体类对应的统一前缀
table-prefix: tb_
# 生成统一的主键生成策略
id-type: auto
configuration:
# 打印Mybatis-plus的执行日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
1234567891011121314
type-aliases-package: com.example.domain
spring:
datasource:
dynamic:
#设置默认的数据源或者数据源组,默认值即为master
primary: master
#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
strict: false
datasource:
master:
url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver # 3.2.0开始支持SPI可省略此配置
mysql2:
url: jdbc:mysql://xx.xx.xx.xx:3307/dynamic
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
mysql2:
url: ENC(xxxxx) # 内置加密,使用请查看详细文档
username: ENC(xxxxx)
password: ENC(xxxxx)
driver-class-name: com.mysql.cj.jdbc.Driver
#......省略
123456789101112131415161718192021222324
@Service、@Mapper、@TableName、@TableId、@TableFild、@TableLogic、@EnumValue、@DS
@Service
public interface IBookService extends IService<Book> {}
1
@Service
public class BookServiceImpl extends ServiceImpl<BookDao, Book> implements IBookService {}
12
实现接口,继承Service
如果多源:
@DS("master") @Service public class BookServiceImpl extends ServiceImpl<BookDao, Book> implements IBookService { } 1234
需要使用@DS注解使用源
@Mapper
@Mapper
public interface BookDao extends BaseMapper<Book> {
}
123
继承实体类
@TableName
//设置实体类对应的表名
@TableName("t_user")
public class Book {
}
1234
若在yml文件中进行了配置,此步骤可省略
@TableId
public class Book {
//将属性对应的字段作为主键
//@TableId注解的value属性用于指定主键的字段
//@TableId注解的type属性设置主键生成策略
@TableId(value = "uid", type = IdType.AUTO)
//private Integer id;
private Integer uid;
}
12345678
设置数据库对应主键ID
@TableFild
@Data
public class Book {
private String type;
//指定属性所对应的字段名
@TableField("book_name")
private String name;
}
1234567
设置对应数据库的字段名
@TableLogic
@Data
public class Book {
//设置属性是否逻辑删除
@TableLogic
private int isDelete;
}
123456
是否逻辑删除
需要添加数据库字段
@EnumValue
@Getter
public enum SexEnum {
MALE(1, "男"),
FEMALE(2, "女");;
//将注解所标识的属性的值存储到数据库中
@EnumValue
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
123456789101112131415
使用枚举存入值
若需要使用mp的分页工则需要添加配置类
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mInterceptor() {
//1.定义Mp拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2.添加具体的拦截器(添加分页拦截器,实现分页查询的动态SQL)
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return mpInterceptor;
}
}
1234567891011
@Test
public void testPage(){
Page<User> page = new Page<>( current: 2,size: 3);
userMapper.selectPage(page,queryWrapper: null);
system.out.println(page);
}
123456
@Test
public void test06(){
//查询用户的用户名、年龄、邮箱信息
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.select( "user_name", "age","email" );
List<Map<String,object>> maps = userMapper.selectMaps(querywrapper);
maps.forEach(system.out: :println);
}
12345678
public void test10(){
string username = "a";
Integer ageBegin = null;
Integer ageEnd = 30;
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.like(stringutils.isNotBLank(username),column: "user_name", username)
.ge( condition: ageBegin != null,column: "age", ageBegin)
.le( condition: ageEnd l= null,column: "age", ageEnd);
List<user> list = userMapper.selectList(querywrapper);
list.forEach(system.out : :println);
}
1234567891011
加个条件判断
spring:
# 设置数据源
datasource:
# 设置驱动类
driver-class-name: com.mysql.cj.jdbc.Driver
#配置连接数据库的各个信息
url: jdbc:mysql://localhost:3306/ssm_db?serverTimezone=UTC
username: root
password: qweasdzxc
123456789
流程:
- 设置数据源
- 设置驱动类
- 配置连接数据库的各个信息
注意
MySQL5.7版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&usesSL=falseMySQL8.0版本的url:
jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false
否则运行测试用例报告如下错误:
java.sql.SQLException: The server time zone value ‘OD1uzé×E士14a’ is unrecognized or representsmore
@Mapper
public interface BookDao extends BaseMapper<Book> {
}
123
使用@Mapper注解。在IOC容器中只能存在类所存在的Bean,不能存在接口所存在的Bean。因此将动态生成的代理类交给了IOC容器管理
@Mapeper将当前接口标为持久层,并为Springboot所管理
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
123
加入日志功能,可打印出相关的sql语句。注意:sql语句的生成是mybatis-plus将实体类对应的泛型反射为SQL语句。
例如,BaseMapper此处的Book,就为实体类
DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.mapper.BookDao">
mapper>
12345678
public interface IBookService extends IService<Book> {}
1
IService T为泛型,填写对象
@Service
public class BookServiceImpl extends ServiceImpl<BookDao, Book> implements IBookService {}
12
ServiceImpl
M为Mapper,T为泛型
//设置实体类对应的表名
@TableName("t_user")
@Data
public class Book {
private Integer id;
private String type;
private String name;
private String description;
}
123456789
同时,我们也可以在yml文件中对表的前缀进行统一处理
#mybatis-plus
mybatis-plus:
#设置mybatis-Plus的统全局配置
global-config:
db-config:
#设置实体类对应的统一前缀
table-prefix: tb_
1234567
@Data
public class Book {
//将属性对应的字段作为主键
@TableId
// private Integer id;
private Integer uid;
private String type;
private String name;
private String description;
}
12345678910
mybatis-plus会将表中的属性作为数据库中的字段名
当数据库的表中的主键id没有设置为默认自增长时,而实体类的唯一标识为“ uid”(而不是“id”),那么MyBatis-Plus就不能通过反射实体类的属性来找到表中字段的唯一标识,就需要通过注解来指明
@Data
public class Book {
//将属性对应的字段作为主键
//@TableId注解的value属性用于指定主键的字段
@TableId("uid")
private Integer id;
private String type;
private String name;
private String description;
}
12345678910
当数据库中的字段名与实体类的类名对应不上时进行使用。vaule默认可以省略
@Data
public class Book {
//将属性对应的字段作为主键
//@TableId注解的value属性用于指定主键的字段
//@TableId注解的type属性设置主键生成策略
@TableId(value = "uid", type = IdType.AUTO)
private Integer id;
private String type;
private String name;
private String description;
}
1234567891011
常用的主键策略
ldType.ASSIGN_ID(默认):基于雪花算法的策略生成数据id,与数据库id是否设置自增无关
ldType.AUTO:使用数据库的自增策略,注意,该类型请确保数据库设置了id自增,否则无效
#mybatis-plus
mybatis-plus:
#设置mybatis-Plus的统全局配置
global-config:
db-config:
#设置实体类对应的统一前缀
table-prefix: tb_
# 生成统一的主键生成策略
id-type: auto
configuration:
# 打印Mybatis-plus的执行日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
123456789101112
Type属性也可以根据yml文件的 id-type: auto来进行统一生成
背景
雪花算法中在分布式中应用非常的广泛,因为雪花算法的有点性
@Data
public class Book {
//将属性对应的字段作为主键
//@TableId注解的value属性用于指定主键的字段
//@TableId注解的type属性设置主键生成策略
@TableId(value = "uid", type = IdType.AUTO)
private Integer id;
private String type;
//指定属性所对应的字段名
@TableField("book_name")
private String name;
private String description;
}
12345678910111213
@TableField不是特别的常用,若数据库中的字段名是这样的形式“book_name”那么mybatis-plus会自动的将下划线转换为bookName如此大驼峰的命名方式,反之亦然
@Data
public class Book {
//将属性对应的字段作为主键
//@TableId注解的value属性用于指定主键的字段
//@TableId注解的type属性设置主键生成策略
@TableId(value = "uid", type = IdType.AUTO)
private Integer id;
private String type;
//指定属性所对应的字段名
@TableField("book_name")
private String name;
private String description;
//设置属性是否逻辑删除
@TableLogic
private int isDelete;
}
12345678910111213141516
当数据库中的字段有isDelete字段时,给对应的实体类加上此注解。在后续的mybatis-plus的删除功能中,实际会执行sql中的update的修改操作,将isDelete变为1。与此同时,mybatis-plus的查询的操作,实际在执行sal中,自动加上and is_delete = 0的操作,查询出未删除的数据
@Test
public void testo1(){
//查询用户名包含a,年龄在20到3o之间,邮箱信息不为nuLl的用户信息
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.like( "user_name", "a")
.between( "age", 20, 30).isNotNull( "email");
List<user> list = userMapper.selectList(querywrapper);
list.forEach(system.out: : println) ;
}
123456789
注: querywrapper.like中的参数 column是数据库中的字段名,并不是实体类中的属性名
@Test
public void test02(){
//查询用户信息,按照年龄的降序排序,若年龄相同,则按照id升序排序
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.orderByDesc("age")
.orderByAsc("uid");
List<user> list = userMapper.selectListlquerywrapper);
list.forEach(system.out::println);
}
123456789
注: querywrapper.orderByDesc中的参数 column是数据库中的字段名,并不是实体类中的属性名
@Test
public void test03(){
//删除邮箱地址为null的用户信息
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.isNull( "email" );
int result = userMapper.delete(querywrapper);system.out.print1n("result: "+result);
}
1234567
注: querywrapper.isNull中的参数 column是数据库中的字段名,并不是实体类中的属性名
@Test
public void test04(){
//将(年龄大于20并且用户名中包含有a)或邮箱为nuLl的用户信息修改
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.gt( "age", 20)
.like( "user_name", "a")
.or()
.isNul1( "email");
user user = new User();
user.setName("小明");
user.setEmail( "[email protected]" );
int result = userMapper.update(user,querywrapper);
system.out.println("result: "+result);}
12345678910111213
注: querywrapper.gt中的参数 column是数据库中的字段名,并不是实体类中的属性名
gt大于,or或许,like 模糊匹配
Test
public void test05(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
// Lambda中的条件优先执行
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.like( column: "user_name",val: "a")
.and(i->i.gt( column: "age" , val: 20).or( ).isNull( column: "email"));
User user = new User();user.setName("小红");
user.setEmail("[email protected]" ) ;
int result = userMapper.update(user,querywrapper);
system.out.println( "result: "+result);
}
123456789101112
注意Lambada表达式优先执行
参考资料:深入浅出 Java 8 Lambda 表达式 - 姚春辉 - 博客园 (cnblogs.com)
@Test
public void test06(){
//查询用户的用户名、年龄、邮箱信息
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.select( "user_name", "age","email" );
List<Map<String,object>> maps = userMapper.selectMaps(querywrapper);
maps.forEach(system.out: :println);
}
12345678
如果想要查询数据库中的某些值,可用select进行组装
public void test07(){
//查询id小于等于100的用户信息
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.inSql( column: "uid",inValue: "select uid from t_user where uid <= 100")
List<User> list = userMapper.selectList(querywrapper);
list.forEach(system.out : :print1n);
123456
嵌套子查询,如需要用到字查询类的值,可使用嵌套子查询进行
public void test10(){
string username = "a";
Integer ageBegin = null;
Integer ageEnd = 30;
Querywrapper<User> querywrapper = new Querywrapper<>();
querywrapper.like(stringutils.isNotBLank(username),column: "user_name", username)
.ge( condition: ageBegin != null,column: "age", ageBegin)
.le( condition: ageEnd l= null,column: "age", ageEnd);
List<user> list = userMapper.selectList(querywrapper);
list.forEach(system.out : :println);
}
1234567891011
当需要使用动态Sql来进行条件拼接时,可使用mp的condition功能
public void testo8(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
Updatewrapper<User> updatewrapper = new updatewrapper<>();
updatewrapper.like( column: "user_name",val: "a")
.and(i -> i.gt( column: "age",val: 20).or( ).isNull( column: "email"));
updatewrapper.set("user_name","小黑")
.set("email" , "[email protected]" );
int result = userMapper.update( entity: null,updatewrapper);
system.out.println("result: "+resulth);
}
12345678910
修改功能的使用
@Test
public void test11(){
string username = "a";
Integer ageBegin = null;I
nteger ageEnd = 30;
LambdaQuerywrapper<User>querywrapper = new LambdaQuerywrapper<>();
querywrapper.like(stringutils.isNotBLank(username),user::getName,username);
.ge( ageBegin != null,user::getAge,ageBegin);
.le( ageEnd != null,user::getAge,ageEnd);
List<User> list = userMapper.selectList(querywrapper);
list.forEach(system.out::print1n);
}
123456789101112
当使用LambadaQuerapper时,配置参数的第二个参数是与QuerryWrepper不相同的,它是函数式的接口,其中第二个参数可设置为user::getAge,为了防止程序员将查询的名字写错
@Test
public void test12(){
//将用户名中包含有a并且(年龄大于20或邮箱为null)的用户信息修改
LambdaUpdatewrapper<User> updatewrapper = new LambdaUpdatewrapper<>();
updatewrapper.like(User: :getName,val: "a")
.and(i -> i.gt(User : :getAge,val: 20).or().isNull(User::getEmail));
updatewrapper.set(User::getName,"小黑").set(User::getEmail,"[email protected]");
int result = userMapper.update( entity: null,updatewrapper);
System.out.println("result: "+result);
}
12345678910
当使用LambdaUpdateWrapper时,配置参数的第二个参数是与updatewrapper不相同的,它是函数式的接口,其中第二个参数可设置为user::getAge,为了防止程序员将查询的名字写错
跟LambdaQueWrapper类似
若需要使用mp的分页工则需要添加配置类
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mInterceptor() {
//1.定义Mp拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2.添加具体的拦截器(添加分页拦截器,实现分页查询的动态SQL)
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return mpInterceptor;
}
}
1234567891011
@Test
public void testPage(){
Page<User> page = new Page<>( current: 2,size: 3);
userMapper.selectPage(page,queryWrapper: null);
system.out.println(page);
}
123456
MP分页功能的其余方法
iPage.getPages(); iPage.getSize(); iPage.getCurrent(); iPage.getRecords(); iPage.getTotal(); 12345
在自定义的sql查询后实现分页功能
UserMapper.java
/**
*通过年龄查询用户信息并分页
*@param page MyBatis-PLus所提供的分页对象,必须位于第一个参数的位訇@param age
*@return
*/
Page<User> selectPagevo(@Param( "page") Page<User> page,@Param("age") Integer age);
123456
application.yml
mybatis-plus:
#配置类型别名所对应的包
type-aliases-package: com.example.domain
#设置mybatis-Plus的统全局配置
global-config:
db-config:
#设置实体类对应的统一前缀
table-prefix: tb_
# 生成统一的主键生成策略
id-type: auto
configuration:
# 打印Mybatis-plus的执行日志
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
12345678910111213
type-aliases-package: com.example.domain
对应映射文件UserMapper.xml
<select id="selectPagevo" resultType="User">
select uid,user_name,age,email from t_user where age > #{age}
select>
123
返回值类型 设置返回的为User,因为最终是返回为User对象
注意,此处需要在yml文件中进行配置别名
测试
@Test
public void testPagevo(){
Page<User> page = new Page<>( 1, 3);
userMapper.selectPagevo(page, 20);
system.out.println(page.getRecords());
system.out.println(page.getPages());
system.out.println(page.getTotal());
system.out.println(page.hasNext());
system.out.println(page.hasPrevious());
}
12345678910
乐观锁实现流程
数据库中添加version字段取出记录时,获取当前version
SELECT id, 'name`,price, 'version` FROM product WHERE id=1 1
更新时,version +1,如果where语句中的version版本不对,则更新失败
UPDATE product SET price=price+50,‘version '='version`+ 1 WHERE id=1 AND‘version'=1 1
1.数据库中添加version字段
2.实体类添加@Version注解
@Data
public class Book {
private Integer id;
private String type;
private String name;
private String description;
@Version //标识乐观锁版本号字段
private Integer version;
}
123456789
3.配置类中添加乐观锁拦截器
@Configuration
public class MpConfig {
@Bean
public MybatisPlusInterceptor mInterceptor() {
//1.定义Mp拦截器
MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();
//2.添加具体的拦截器(添加分页拦截器,实现分页查询的动态SQL)
mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
//3.添加具体的拦截器(添加乐观锁拦截器,实现乐观锁的查询)
mpInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mpInterceptor;
}
}
12345678910111213
一个人在操作时,另一个人不能同时进行操作
1.假设数据库中存储age字段类型为int(类型不相匹配的字段)
2.枚举类添加@EnumValue注解
@Getter
public enum SexEnum {
MALE(1, "男"),
FEMALE(2, "女");;
//将注解所标识的属性的值存储到数据库中
@EnumValue
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
123456789101112131415
注意:需要添加@EnumValue来实现数据库的存值,某则会将汉字存入数据库中
@Data
public class Book {
private Integer id;
private String type;
private String name;
private String description;
private SexEnum sex;
}
123456789
补充:在实体类中使用枚举类时,需要将类型设定为枚举类型
3.配置application.yml
#mybatis-plus
mybatis-plus:
#扫描通用枚举包
type-enums-package: com.example.enums
1234
4.使用枚举类型
user.setsex(SexEnum.MALE);
1
在使用时,需要从枚举类中读取即可
1.导入依赖 pom.xml
<dependency>
<groupId>com.baomidougroupId>
<artifactId>mybatis-plus-generatorartifactId>
<version>3.5.1version>
dependency>
<dependency>
<groupId>org.freemarkergroupId>
<artifactId>freemarkerartifactId>
<version>2.3.31version>
dependency>
12345678910
2.快速生成
FastAutoGenerator.create("url", "username", "password")
.globalConfig(builder -> {
builder.author("baomidou") // 设置作者
//.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("D://"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.baomidou.mybatisplus.samples.generator") // 设置父包名
.moduleName("system") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("t_simple") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
1.添加yml配置
application.yml
spring:
datasource:
dynamic:
#设置默认的数据源或者数据源组,默认值即为master
primary: master
#严格匹配数据源,默认false. true未匹配到指定数据源时抛异常,false使用默认数据源
strict: false
datasource:
master:
url: jdbc:mysql://xx.xx.xx.xx:3306/dynamic
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver # 3.2.0开始支持SPI可省略此配置
mysql2:
url: jdbc:mysql://xx.xx.xx.xx:3307/dynamic
username: root
password: 123456
driver-class-name: com.mysql.cj.jdbc.Driver
mysql2:
url: ENC(xxxxx) # 内置加密,使用请查看详细文档
username: ENC(xxxxx)
password: ENC(xxxxx)
driver-class-name: com.mysql.cj.jdbc.Driver
#......省略
2.更改数据源
@DS("master")
@Service
public class BookServiceImpl extends ServiceImpl<BookDao, Book> implements IBookService {
}
1234
使用方法
1.idea中 DataBase右击构造,快速生成
2.选择module,package,实体类,忽略前缀和表前缀
3.一般如下选择配置
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
dependency>
12345
@Data
public class Book {
private Integer id;
private String type;
private String name;
private String description;
}
LomBok不会生成有参构造的方法