MybatisPlus框架整合

一、MybatisPlus简介

二、快速入门

三、介绍Lombok

四、MybatisPlus分页查询功能

二、DQL编程控制

一、条件查询(含Lambda格式)

二、条件查询之组合查询条件

三、条件查询之null值处理

 四、查询投影

 五、查询条件

六、字段映射与表明映射

总结@TableName

三、DML编程控制

一、id生成策略控制

二、多记录操作

三、逻辑删除

四、乐观锁

四、代码生成器


一、MybatisPlus简介

  • MybatisPlus(简称MP)是基于Mybatis框架基础上开发的增强型工具,旨在简化开发、提高效率

  • 开发方式

    • 基于Mybatis使用MybatisPlus

    • 基于Spring使用MybatisPlus

    • 基于SpringBoot使用MybatisPlus

  • 特性

    • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑

    • 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作

    • 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求

    • 支持主键自动生成

    • 内置代码生成器

    • ...

二、快速入门

①创建新模块,选择Spring初始化,并配置模块相关基础信息(此处只点击MySQL)

MybatisPlus框架整合_第1张图片

 ②手工添加起步依赖


       com.baomidou
       mybatis-plus-boot-starter
       3.4.1

③设置JDBC参数(application.yml)

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://localhost:3306/ssm?user
    username: root
    password: root

④制作实体类与表结构相同(类名与表明对应,属性名与字段名对应)这里就不展示了

⑤定义数据接口,继承BaseMapper

@Mapper
public interface UserDao extends BaseMapper {
}

⑥测试类中注入dao接口,测试功能

@SpringBootTest
class Mybatis01QuickstartApplicationTests {

    @Autowired
    private UserDao userDao;

    @Test
    void testGetAll() {
        List userList = userDao.selectList(null);
        System.out.println(userList);
    }
}

三、介绍Lombok

  • Lombok,一个Java类库,提供了一组注解,简化实体类开发


    org.projectlombok
    lombok
    1.18.12
    provided
  • 常用注解:@Data

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private String password;
    private Integer age;
    private String tel;
}
  • 该注解设置对应的set/get方法(@Setter、@Getter)、toString方法(@ToString)、hashCode和equals方法(@EqualsAndHashCode)

  • 有参构造(@AllArgsConstructor)和无参构造(@NoArgsConstructor)还是需要再手动加上

四、MybatisPlus分页查询功能

①设置分页拦截器作为Spring管理的bean

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        //1、定义MybatisPlus拦截器
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        //2、添加具体的拦截器
        mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

②执行分页查询语句

@Test
void getByPage(){
    IPage iPage = new Page(1,2);//查询1页,每页两个数据查询
    userDao.selectPage(iPage,null);
    System.out.println("当前页码值: "+iPage.getCurrent());
    System.out.println("每页显示数: "+iPage.getSize());
    System.out.println("总页数: "+iPage.getPages());
    System.out.println("总数据量: "+iPage.getTotal());
    System.out.println("数据: "+iPage.getRecords());
}

③开启日志 用来调试程序看Sql语句用的

#开启MybatisPlus的日志 输出到控制台
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

二、DQL编程控制

一、条件查询(含Lambda格式)

  • MyBatisPlus将书写复杂的SQL查询条件进行了封装,使用编程的形式完成查询条件的组合。

  • Query:查询;Wrapper:封装

  • 格式一:常规格式

 QueryWrapper wrapper = new QueryWrapper();
 wrapper.lt("age",40);
 wrapper.gt("age",10);
 List list = userDao.selectList(wrapper);
 System.out.println(list);
  • 格式二:链式编程格式

 QueryWrapper wrapper = new QueryWrapper();
 wrapper.lt("age",40).gt("age",10);
 List list = userDao.selectList(wrapper);
 System.out.println(list);
  • 格式三:Lambda格式(推荐)

 QueryWrapper wrapper = new QueryWrapper<>();
 wrapper.lambda.lt(User::getAge,40).gt(User::getAge,10);
 List list = userDao.selectList(wrapper);
 System.out.println(list);
  • 格式四:Lambda格式(推荐)

 LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
 lqw.lt(User::getAge,40).gt(User::getAge,10);
 List list = userDao.selectList(lqw);
 System.out.println(list);

二、条件查询之组合查询条件

package com.chf.domain;
@Data
public class User {
    private Long id;
    private String name;
    private String password;
    private Integer age;
    private String tel;
}

package com.chf.domain.query;

@Data
public class UserQuery extends User {
    private Integer age2;
}
  • 并且(and)即上面的格式四:大于10岁并且小于40岁

 LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
 lqw.lt(User::getAge,40).gt(User::getAge,10);
 List list = userDao.selectList(lqw);
 System.out.println(list);
  • 或者(or):小于10岁或者大于40岁的

 LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
 lqw.lt(User::getAge,10).or().gt(User::getAge,40);
 List list = userDao.selectList(lqw);
 System.out.println(list);

三、条件查询之null值处理

@Test
void testGetAge(){
    //模拟页面传递过来的查询数据
    UserQuery uq = new UserQuery();
    uq.setAge(10);
    uq.setAge2(30);

    LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
    lqw.lt(User::getAge,uq.getAge2());
    lqw.gt(User::getAge,uq.getAge());
    List list = userDao.selectList(lqw);
    System.out.println(list);
}

这样是肯定可以查出数据的,如下图所示:

MybatisPlus框架整合_第2张图片

 但是如果我们将其中一个条件注释掉,就无法完成查询,进行此操作的可能性是有的,比如:在网上购物的时候,我们可能只会给出一个上限值或者下限值去寻找范围内的物品,这就是我们需要解决的问题。

MybatisPlus框架整合_第3张图片

 我们虽然说可以通过if条件语句去一个个进行判断是否为空,但是这种代码质量不太行。在MybatisPlus中就有个新传值的方法,这样就可以完美的解决问题,如下图所示:

@Test
void testGetAge(){
    //模拟页面传递过来的查询数据
    UserQuery uq = new UserQuery();
    //uq.setAge(10);将其中一个判断注释掉去做实验
    uq.setAge2(30);

    LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
    lqw.lt(null != uq.getAge2(),User::getAge,uq.getAge2());
    lqw.gt(null != uq.getAge(),User::getAge,uq.getAge());
    List list = userDao.selectList(lqw);
    System.out.println(list);
}

MybatisPlus框架整合_第4张图片

 四、查询投影

  • 查询结构包含模型类中部分属性

LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
lqw.select(User::getId,User::getName,User::getAge);
List userList = userDao.selectList(lqw);
System.out.println(userList);

MybatisPlus框架整合_第5张图片

  • 查询结果包含模型类中未定义的属性

QueryWrapper qw = new QueryWrapper<>();
qw.select("count(*) as count,tel");
qw.groupBy("tel");
List> list = userDao.selectMaps(qw);
System.out.println(list);

MybatisPlus框架整合_第6张图片

 五、查询条件

  • 范围查询(>、=、between)

  • 模糊匹配(like)

  • 空判断(null)

  • 包含性匹配(in)

  • 分组(group by)

  • 排序(order by)

  • ...

用户登录(eq匹配)

LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
lqw.eq(User::getName,"Jerry").eq(User::getPassword,"jerry");
User loginUser = userDao.selectOne(lqw);
System.out.println(loginUser);

购物设定价格区间、户籍设定年龄区间(lt gt匹配或者between匹配)

UserQuery uq = new UserQuery();
uq.setAge(10);
uq.setAge2(30);

LambdaQueryWrapper lqw = new LambdaQueryWrapper<>();
//方案一:设定上限下限
lqw.lt(User::getAge,userQuery.getAge()).gt(User::getAge,userQuery.getAge2());
//方案二:设定范围
lqw.between(User::getAge,userQuery.getAge(),userQuery.getAge2());
List userList = userDao.selectList(lqw);
System.out.println(loginUser);

六、字段映射与表明映射

问题一:当表字段与实体类的属性名不一致的时候?

解决方案:在属性名上面加上注解@TableField

作用:设置当前属性对应的数据库表中的字段关系。

实例:

package com.chf.domain;
@Data
public class User{
    private Long id;
    private String name;
    @TableField(value = "pwd")
    private String password;
    private Integer age;
    private String tel;
}

问题二:编码中添加了数据库中未定义的属性

package com.chf.domain;
@Data
public class User{
    private Long id;
    private String name;
    @TableField(value = "pwd")
    private String password;
    private Integer age;
    private String tel;
	@TableField(exist = false)
	private Sring hehe;
}

问题三:采用默认查询开放了更多的字段查看权限(比如密码)

package com.chf.domain;
@Data
public class User{
    private Long id;
    private String name;
    @TableField(value = "pwd",select = false)
    private String password;
    private Integer age;
    private String tel;
	@TableField(exist = false)
	private Sring hehe;
}

问题四:表名与编码开发设计不同步

package com.chf.domain;
@Data
@TableName("tbl_user") 与表名进行关联
public class User{
    private Long id;
    private String name;
    @TableField(value = "pwd",select = false)
    private String password;
    private Integer age;
    private String tel;
	@TableField(exist = false)
	private Sring hehe;
}

总结@TableName

  • 属性上添加@TableField(value = "数据库列名"),实现属性与列名相对应

  • 属性上添加@TableField(exist = false),实现不在表内字段的属性不参与Sql语句

  • 属性上添加@TableField(select = false),实现该属性不被Sql语句所查询出来

  • 类上添加@TableName("数据库表名"),实现实体类名与表名相对应

三、DML编程控制

一、id生成策略控制

  • 不同的表应用不同的id生成策略

    • 日志:自增(1,2,3,4,...)

    • 购物订单:特殊规则(FQ4234KS5435)

    • 外卖单:关联地区日期等信息(10 05 20220314 34 23)

    • 关系表:可省略id

    • ...

  • AUTO(0):使用数据库id自增策略控制id生成

  • NONE(1):不设置id生成策略

  • INPUT(2):用户手工输入id

  • ASSIGN_ID(3):雪花算法生成id(可兼容数值型与字符串型)

    • 雪花算法:64个二进制数组合成的

    • 第一位表示占位符 默认为0

    • 第二位表示时间戳 默认有41位

    • 第三位和第四位(5+5) 表示机器码

    • 第五位表示序列号 有12位

    • 0 | 41位... | 5位 | 5位 | 12位

  • ASSIGN_UUID(4):以UUID生成算法作为id生成策略

  • 在属性上添加注解@IdType()

MybatisPlus框架整合_第7张图片

二、多记录操作

  • 按照主键删除多条记录

List ids = Arrays.asList(new Long[]{2,3});
userDao.deleteBatchIds(ids);
  • 根据主键查询多条记录

List ids = Arrays.asList(new Long[]{2,3});
List userList = userDao.selectBatchIds(ids);

三、逻辑删除

  • 删除操作业务问题:业务数据从数据库中丢弃

  • 逻辑删除:为数据设置是否可用状态字段,删除时设置状态字段为不可用状态,数据保留在数据库中

①:数据库表中添加逻辑删除标记字段

MybatisPlus框架整合_第8张图片

 ②:实体类中添加对应字段,并设定当前字段为逻辑删除标记字段

MybatisPlus框架整合_第9张图片

③:或者通过yml配置文件中设置逻辑删除字面值

mybatis-plus:
	global-config:
		db-config:
			logic-delete-field: deleted
			logic-not-delete-value: 0
			logic-delete-value: 1

 在Test类中测试delete方法相当于执行Sql语句:Update 表名 set deleted=1 where id=? and deleted=0

测试selectList方法相当于执行Sql语句:SELECT ... deleted FROM 表名 WHERE deleted=0

四、乐观锁

①数据库表中添加锁标记字段

MybatisPlus框架整合_第10张图片

②实体类中添加对应字段,并设置当前字段为逻辑删除标记字段

package com.chf.domain;

public class User{
	...
	
	@Version
	private Integer version;
}

③配置乐观锁拦截器实现锁机制对应的动态SQL语句拼装

package com.chf.config;

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

④使用乐观锁机制在修改前必须先获取到对应数据的version方可正常进行

@Test
void testUpdate(){
	//先查询数据获取到version数据
	User user = userDao.selectById(1L);
	//执行数据修改操作
	user.setName("TUT");
	userDao.updateById(user);
}

执行修改前先执行查询语句:select ...,version from 表名 where id=?

执行修改时使用version字段作为乐观锁检查依据:update 表名 set ...,version=? where id=? and version=?

四、代码生成器

  • 模块:MybatisPlus提供

  • 数据库相关配置:读取数据库获取信息

  • 开发者自定义配置:手工配置

①在pom.xml导入坐标



    com.baomidou
    mybatis-plus-generator
    3.4.1




    org.apache.velocity
    velocity-engine-core
    2.3

②在com.chf包下

public class Generator {
    public static void main(String[] args) {
        AutoGenerator autoGenerator = new AutoGenerator();

        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/ssm");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("root");
        autoGenerator.setDataSource(dataSourceConfig);

        //设置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir")+"/mybatisplus_04_generator/src/main/java"); //设置代码生成路径
        globalConfig.setOpen(true);  //设置生成之后之后打开代码所在目录
        globalConfig.setAuthor("鸿");  //设置作者
        globalConfig.setFileOverride(true); //设置是否覆盖原始生成的文件
        globalConfig.setMapperName("%sDao"); //设置数据层接口名,%s为占位符,指代模块名称
        globalConfig.setIdType(IdType.ASSIGN_ID); //设置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);

        //设置包名相关配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent("com.example"); //设置生成的包名,与代码所在位置不冲突,二者叠加组成完整路径
        packageConfig.setEntity("domain"); //设置实体类包名
        packageConfig.setMapper("dao"); //设置数据层包名
        autoGenerator.setPackageInfo(packageConfig);

        //策略设置(重中之重)
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("user");  //设置当前参与生成的表名,参数为可变参数
        strategyConfig.setRestControllerStyle(true); //设置Controller是否使用REST风格
        strategyConfig.setVersionFieldName("version");  //设置乐观锁字段名
        strategyConfig.setLogicDeleteFieldName("deleted"); //设置逻辑删除字段名
        strategyConfig.setEntityLombokModel(true);  //设置实体类中是否启用Lombok
        autoGenerator.setStrategy(strategyConfig);

        autoGenerator.execute();
    }
}

你可能感兴趣的:(SSM,mybatis,spring,boot,java)