MyBatis-Plus allEq()的用法详解

MyBatis-Plus allEq()的用法

首先创建一个数据库表，如下图所示：

然后创建一个Spring Boot项目，pom.xml和配置如下：

 4.0.0

 org.kaven
 mybatis-plus
 1.0-SNAPSHOT

 
  org.springframework.boot
  spring-boot-starter-parent
  2.3.4.RELEASE
  
 

 
  1.8
 

 
  
   org.springframework.boot
   spring-boot-starter
  
  
   org.springframework.boot
   spring-boot-starter-test
  
  
   org.springframework.boot
   spring-boot-starter-webflux
  
  
   com.baomidou
   mybatis-plus-boot-starter
   3.4.0
  
  
   mysql
   mysql-connector-java
   5.1.49
  
  
   org.projectlombok
   lombok
  
 

 
  
   
    org.springframework.boot
    spring-boot-maven-plugin
   
  
 

spring:
 application:
 name: mybatis-plus
 datasource:
 driver-class-name: com.mysql.jdbc.Driver
 username: root
 password: ITkaven@123
 url: jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf-8&useSSL=false

server:
 port: 8085

logging:
 level:
 root: warn
 com.kaven.mybatisplus.dao: trace
 pattern:
 console: '%p%m%n'

mybatis-plus:
 mapper-locations: classpath:mappers/*.xml

实体类User：

package com.kaven.mybatisplus.entity;

import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;

@TableName("user")
@Data
public class User {

 @TableId
 private String id;

 @TableField("username")
 private String username;

 @TableField("password")
 private String password;

 @TableField("age")
 private Integer age;

 /**
  * 使用 @TableField(exist = false) ，表示该字段在数据库中不存在 ，所以不会插入数据库中
  * 使用 transient 、 static 修饰属性也不会插入数据库中
  */
 @TableField(exist = false)
 private String phone;
}

Mapper接口UserMapper：

package com.kaven.mybatisplus.dao;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.kaven.mybatisplus.entity.User;
import org.springframework.stereotype.Component;


@Component
public interface UserMapper extends BaseMapper {}

启动类：

package com.kaven.mybatisplus;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan(basePackages = "com.kaven.mybatisplus.dao")
public class AppRun {
 public static void main(String[] args) {
  SpringApplication.run(AppRun.class , args);
 }
}

@MapperScan(basePackages = "com.kaven.mybatisplus.dao")这个一定要加上。

我们先在数据库中添加几行数据，方便演示。

我们首先来看一看allEq的源码：

 /**
  * ignore
  */
 default  Children allEq(Map params) {
  return allEq(params, true);
 }

 /**
  * ignore
  */
 default  Children allEq(Map params, boolean null2IsNull) {
  return allEq(true, params, null2IsNull);
 }

 /**
  * map 所有非空属性等于 =
  *
  * @param condition 执行条件
  * @param params  map 类型的参数, key 是字段名, value 是字段值
  * @param null2IsNull 是否参数为 null 自动执行 isNull 方法, false 则忽略这个字段\
  * @return children
  */
  Children allEq(boolean condition, Map params, boolean null2IsNull);

 /**
  * ignore
  */
 default  Children allEq(BiPredicate filter, Map params) {
  return allEq(filter, params, true);
 }

 /**
  * ignore
  */
 default  Children allEq(BiPredicate filter, Map params, boolean null2IsNull) {
  return allEq(true, filter, params, null2IsNull);
 }

 /**
  * 字段过滤接口，传入多参数时允许对参数进行过滤
  *
  * @param condition 执行条件
  * @param filter  返回 true 来允许字段传入比对条件中
  * @param params  map 类型的参数, key 是字段名, value 是字段值
  * @param null2IsNull 是否参数为 null 自动执行 isNull 方法, false 则忽略这个字段
  * @return children
  */
  Children allEq(boolean condition, BiPredicate filter, Map params, boolean null2IsNull);

可以看到最多有boolean condition, BiPredicate filter, Map params, boolean null2IsNull这四个参数。

• condition：是否将该sql语句（像in()、like()，以及这里的 allEq()）加在总sql语句上，也就是执行条件。
• filter : 过滤函数，是否允许字段传入比对条件中。
• params : key为数据库字段名，value为字段值。
• null2IsNull : 为true时，则在map的value为null时调用 isNull 方法；为false时，则忽略map的value为null的键值对。

先来演示一下 Map params参数的作用。

查询username为kaven，age为22。

package com.kaven.mybatisplus.dao;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.kaven.mybatisplus.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperAllEqTest {

 @Autowired
 private UserMapper userMapper;


 @Test
 public void selectList(){
  QueryWrapper userQueryWrapper = Wrappers.query();

  Map map = new HashMap<>();
  map.put("username" , "kaven");
  map.put("age" , 22);

  userQueryWrapper.allEq(map);
  List userList = userMapper.selectList(userQueryWrapper);
 }
}

结果如下：

查询结果是正确的。

再来演示一下 boolean null2IsNull参数的作用，它默认会是true。

package com.kaven.mybatisplus.dao;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.kaven.mybatisplus.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperAllEqTest {

 @Autowired
 private UserMapper userMapper;


 @Test
 public void selectList(){
  QueryWrapper userQueryWrapper = Wrappers.query();

  Map map = new HashMap<>();
  map.put("username" , "kaven");
  map.put("age" , null);

  userQueryWrapper.allEq(map , true);
  List userList = userMapper.selectList(userQueryWrapper);
 }
}

结果如下：

结果也是正确的，因为没有这样的数据，大家看一看上图的sql语句就知道了，null2IsNull为true时，则在map的value为null时调用 isNull 方法。

再来演示一下null2IsNull为false的情况。

package com.kaven.mybatisplus.dao;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.kaven.mybatisplus.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperAllEqTest {

 @Autowired
 private UserMapper userMapper;


 @Test
 public void selectList(){
  QueryWrapper userQueryWrapper = Wrappers.query();

  Map map = new HashMap<>();
  map.put("username" , null);
  map.put("age" , null);

  userQueryWrapper.allEq(map , false);
  List userList = userMapper.selectList(userQueryWrapper);
 }
}

当null2IsNull为false时，其实上面代码就是查询所有user数据，因为键值对都被忽略掉了。如果此时null2IsNull为true，则会没有一个匹配的数据。

结果是正确的，当null2IsNull为false时，则忽略map中value为null的情况。

再来演示一下BiPredicate filter参数的作用。

package com.kaven.mybatisplus.dao;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.kaven.mybatisplus.entity.User;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperAllEqTest {

 @Autowired
 private UserMapper userMapper;


 @Test
 public void selectList(){
  QueryWrapper userQueryWrapper = Wrappers.query();

  Map map = new HashMap<>();
  map.put("username" , null);
  map.put("age" , 22);
  map.put("password" , "1");

  userQueryWrapper.allEq((k , v) -> !k.equals("password") , map , false);
  List userList = userMapper.selectList(userQueryWrapper);
 }
}

看上面代码很容易知道，filter参数我传了一个lambda表达式，意思是key为password的键值对在查询时会被忽略掉。

结果如下：

结果很显然也是正确的。

boolean condition参数的作用我在另一篇博客有介绍过，这里就不再赘述了。
MyBatis-Plus 条件构造器之condition参数

到此这篇关于MyBatis-Plus allEq()的用法详解的文章就介绍到这了,更多相关MyBatis-Plus allEq()内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！