使用 MyBatis-Plus 查询表中为空的字段的全面指南

简介

在应用程序开发中，处理数据库中的空值（NULL）是一个常见的需求。MyBatis-Plus 作为 MyBatis 的增强工具，提供了多种简便的方法来查询表中字段为空的记录。本指南将深入探讨如何使用 MyBatis-Plus 高效地实现这一目标，包括基础配置、查询方法、示例代码以及实战中的注意事项。

MyBatis-Plus 基本概念

MyBatis-Plus 是一个基于 MyBatis 的增强工具，旨在简化开发流程，减少重复代码，提供丰富的功能如自动 CRUD 操作、条件构造器、分页查询等。它通过提供更高层次的抽象，使开发者能够更快速地构建可靠的数据库交互层。

在数据库中，NULL 表示字段没有任何值，而空字符串 ("") 则表示字段有值但为空。这两者在数据库查询中需要不同的处理方式。

环境配置

在开始使用 MyBatis-Plus 进行查询前，确保项目中已经正确引入了 MyBatis-Plus 的依赖，并完成了基本的配置。以下是 Maven 的依赖示例：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3</version>
</dependency>
    

在配置文件（application.yml 或 application.properties）中，需要配置数据库连接信息以及 MyBatis-Plus 的相关配置。例如，关闭自动驼峰命名规则映射：

mybatis-plus:
  configuration:
    map-underscore-to-camel-case: false
    

这样可以确保数据库字段与实体类属性的正确映射，避免因命名不一致导致的查询问题。

查询字段为空的方法

1. 使用 QueryWrapper 的 isNull 方法

QueryWrapper 是 MyBatis-Plus 提供的条件构造器，用于动态拼接 SQL 语句。使用 isNull 方法可以方便地查询某个字段为空的记录。

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;

// 查询 'name' 字段为空的记录
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("name");
List<User> userList = userMapper.selectList(queryWrapper);
    

2. 使用 LambdaQueryWrapper 的 isNull 方法

为了提高类型安全性，LambdaQueryWrapper 提供了基于 lambda 表达式的查询方式，避免了硬编码字段名的风险。

import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;

// 使用 LambdaQueryWrapper 查询 'name' 字段为空的记录
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.isNull(User::getName);
List<User> userList = userMapper.selectList(lqw);
    

3. 使用 select 方法指定查询字段

有时候，我们只需要查询某些特定的字段，而不是整个记录。通过 select 方法可以指定需要查询的字段。

// 使用 QueryWrapper 指定查询字段
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.select("id", "name", "age").isNull("email");
List<User> userList = userMapper.selectList(queryWrapper);
    

或者使用 LambdaQueryWrapper：

// 使用 LambdaQueryWrapper 指定查询字段
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.select(User::getId, User::getName, User::getAge)
   .isNull(User::getEmail);
List<User> userList = userMapper.selectList(lqw);
    

4. 查询 NULL 和空字符串

在某些情况下，需要同时查询字段为 NULL 或空字符串 ("") 的记录。可以通过组合条件来实现。

// 使用 QueryWrapper 查询 'name' 为空或空字符串的记录
QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("name")
            .or()
            .eq("name", "");
List<User> userList = userMapper.selectList(queryWrapper);
    

// 使用 LambdaQueryWrapper 查询 'name' 为空或空字符串的记录
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<>();
lqw.isNull(User::getName)
   .or()
   .eq(User::getName, "");
List<User> userList = userMapper.selectList(lqw);
    

这种方式会生成类似的 SQL：

SELECT * FROM user WHERE name IS NULL OR name = '';
    

5. 使用 XML 配置自定义 SQL

对于复杂的查询逻辑，特别是需要动态拼接 SQL 时，可以使用 XML 配置自定义的查询语句。

<!-- YourMapper.xml -->
<mapper namespace="com.example.demo.mapper.YourMapper">
    <select id="selectEmptyFields" resultType="com.example.demo.entity.User">
        SELECT * 
        FROM user
        WHERE name IS NULL OR name = ''
    </select>
</mapper>
    

对应的 Mapper 接口：

import com.example.demo.entity.User;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import java.util.List;

@Mapper
public interface UserMapper {
    @Select("SELECT * FROM user WHERE name IS NULL OR name = ''")
    List<User> selectEmptyFields();
}
    

6. 使用 Kotlin DSL 风格

如果项目使用 Kotlin，可以利用 Kotlin 的 DSL 风格来构建查询条件，使代码更加简洁和直观。

val result = yourMapper.selectList(
    LambdaQueryWrapper<User>()
        .apply {
            isNull(User::yourField)
            or { eq(User::yourField, "") }
        }
)
    

示例代码

1. 实体类

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName("user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    private String email;
    // Getters and Setters
}
    

2. Mapper 接口

import com.baomidou.mybatisplus.core.mapper.BaseMapper;

public interface UserMapper extends BaseMapper<User> {
    // 自定义查询方法
    List<User> selectEmptyFields();
}
    

3. 服务实现

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import java.util.List;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {

    public List<User> getUsersWithNullName() {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.isNull("name");
        return this.list(queryWrapper);
    }

    public List<User> getUsersWithNullOrEmptyName() {
        QueryWrapper<User> queryWrapper = new QueryWrapper<>();
        queryWrapper.isNull("name").or().eq("name", "");
        return this.list(queryWrapper);
    }
}
    

4. 控制器示例

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/users/null-name")
    public List<User> getUsersWithNullName() {
        return userService.getUsersWithNullName();
    }

    @GetMapping("/users/null-or-empty-name")
    public List<User> getUsersWithNullOrEmptyName() {
        return userService.getUsersWithNullOrEmptyName();
    }
}
    

实践中的注意事项

1. 区分 NULL 和空字符串

NULL 表示字段没有值，而空字符串 ("") 表示字段有值但为空。在查询时，根据业务需求正确区分这两者极为重要。如需同时考虑两者，应在查询条件中同时包含 IS NULL 和 = ''。

2. 性能优化

如果查询的字段允许有大量的空值，这类查询可能导致性能下降，尤其是在大表中。建议为这些字段建立索引，以加快查询速度。此外，避免在高频次的业务逻辑中频繁查询空值字段，可以通过优化数据存储策略来减少此类查询的需求。

3. 字段映射

确保实体类中的字段与数据库表中的列名正确映射。如果字段名不匹配，查询结果中的值可能会返回 NULL。可以使用 @TableField 注解来指定实体类字段对应的数据库列名。

import com.baomidou.mybatisplus.annotation.TableField;

public class User {
    @TableId
    private Long id;

    @TableField("user_name")
    private String name;
    
    // 其他字段、getter 和 setter
}
    

或者在配置文件中关闭自动驼峰命名规则：

mybatis-plus:
  configuration:
    map-underscore-to-camel-case: false
    

4. 默认行为

如果数据库列未设置默认值，插入记录时应显式处理 NULL 或空字符串的逻辑，以避免引发异常或产生不一致的数据。

常见问题及解决方案

1. 字段映射不正确导致查询结果中字段值为 NULL

问题描述：数据库字段与实体类属性不一致，导致查询结果中的某些字段值为 NULL。

解决方案：

• 使用 @TableField 注解指定数据库字段与实体类属性的对应关系。
• 在配置文件中关闭自动驼峰命名规则映射。

import com.baomidou.mybatisplus.annotation.TableField;

public class User {
    @TableId
    private Long id;

    @TableField("user_name")
    private String name;
    
    // 其他字段、getter 和 setter
}
    

2. 动态查询条件导致 SQL 语句不符合预期

问题描述：在构造动态查询时，如果条件为空字符串或 NULL，可能导致生成的 SQL 语句不符合预期。

解决方案：在构造查询条件时，先判断参数是否为 NULL 或空字符串，再决定是否添加相应的查询条件。例如，使用 StringUtils.isNotBlank 方法：

import org.apache.commons.lang3.StringUtils;

public List<User> getUsersByName(String name) {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    if (StringUtils.isNotBlank(name)) {
        queryWrapper.eq("name", name);
    } else {
        queryWrapper.isNull("name").or().eq("name", "");
    }
    return userMapper.selectList(queryWrapper);
}
    

3. 查询空字符串和 NULL 的区分

问题描述：需要同时处理字段为 NULL 和空字符串的情况，但查询结果未包含预期的记录。

解决方案：确保查询条件中同时包含 IS NULL 和 = '' 的逻辑连接。

QueryWrapper<User> queryWrapper = new QueryWrapper<>();
queryWrapper.isNull("name").or().eq("name", "");
List<User> userList = userMapper.selectList(queryWrapper);
    

结论

使用 MyBatis-Plus 查询表中为空的字段是一项常见且必要的操作。通过灵活运用 QueryWrapper 和 LambdaQueryWrapper，开发者可以高效地构建各种查询条件，满足不同的业务需求。在实际应用中，需注意字段映射的正确性、查询条件的构造以及性能优化等方面，以确保查询的准确性和系统的高效运行。借助本指南提供的方法和示例代码，您可以更自信地处理数据库中的空值查询任务。

参考文档与资源