MyBatis条件if test中使用枚举值的方法与陷阱

基础环境准备

要实现基于枚举值的动态条件判断，首先需要在Java项目中定义一个标准的枚举类。该类通常包含用于业务逻辑的唯一标识字段（如代码码或名称）以及对应的描述信息。

第1步：定义顶层枚举类

目的：创建一个独立的枚举文件，确保其能被OGNL表达式通过全限定类名直接访问。

• 入口/位置：创建Java类文件，如 City.java。
• 动作：定义枚举常量及其属性（例如 code 和 name），并提供对应的Getter方法。
• 重要参数：枚举必须包含无参构造器或带参构造器，且Getter方法不能为私有，否则OGNL无法读取属性值。

package com.weather.weatherexpert.common.utils;

public enum City {
    XINZHOU(100002, "忻州"),
    DATONG(100003, "大同"),
    TAIYUAN(100001, "太原");

    private final Integer code;
    private final String name;

    City(Integer value, String desc) {
        this.code = value;
        this.name = desc;
    }

    public Integer getCode() {
        return code;
    }

    public String getName() {
        return name;
    }
}

此时，该枚举即可以在XML映射文件中通过静态导入的方式进行引用。

MyBatis XML中的正确用法

在Mapper XML文件的SQL片段中，使用OGNL表达式的静态导入功能 @ 来引入枚举类。以下是两种常见的正确应用场景：

第2步：匹配枚举的字符串属性

目的：根据前端传递的城市名称（String类型）过滤数据表。

• 操作语法：@全限定类名@枚举常量.Getter方法
• 注意事项：必须调用具体的 Getter 方法（如 .getName()），直接写枚举常量名会被解析为对象地址而非期望的字符串值。

<if test="cityName == @com.weather.weatherexpert.common.utils.City@XINZHOU.getName">
    area_table
</if>

where 1=1
<if test="cityName == @com.weather.weatherexpert.common.utils.City@XINZHOU.getName">
    and city_name=#{cityName}
</if>

第3步：直接匹配枚举常量本身

目的：当传参为枚举类型或仅需判断是否等于某个特定状态时使用。

• 操作示例：假设有一个 TestTypeEnum，若需判断当前类型为小时，可直接使用以下写法：

<if test="dtEnum == @com.xxx.xxx.TestTypeEnum@HOUR">
    DATE_FORMAT(TM,'%Y-%m-%d %H') as keyStr,
</if>

常见错误与嵌套类处理

在实际开发中，将枚举定义在其他类的内部时，极易触发编译或运行时报错。这是由OGNL解析内部类结构差异导致的。

错误场景一：语法解析错误

如果试图通过点号直接访问内部类的枚举成员，或者错误地使用了两个 @ 符号，OGNL解析器会抛出 ParseException 或 ClassNotFoundException。

<!-- 错误写法1：多了一个@ -->
<!-- <if test="... @包.类@成员@getName" > ... -->

<!-- 错误写法2：未调用方法，解析不到对应class -->
<!-- <if test="... @包.类@成员.getName" > 这里的解析逻辑可能混淆 -->

错误场景二：静态字段找不到（Internal Enum Error）

如果在普通类内部定义了枚举（Nested Enum），直接使用 @OuterClass.InnerEnum.Member 这种类似外部类的语法会报 java.lang.NoSuchFieldException: InnerEnum。因为内部类并非简单的静态属性，而是以 $ 符号区分的特殊类结构。

/* 
 * Caused by: org.apache.ibatis.builder.BuilderException: Error evaluating expression...
 * Cause: org.apache.ibatis.ognl.OgnlException: Could not get static field CityEnum from class... */

第4步：修正嵌套枚举的引用路径

目的：解决内部类枚举在MyBatis中不可见的问题。

• 关键规则：将中间的分隔符由 . 替换为 $。
• 正确路径格式：@外层类全限定名$内部枚举名@枚举实例.Getter方法

<!-- 正确写法：使用 $ 分割内部类 -->
<if test="cityName == @com.a.b.c.CityClass$CityEnum@XINZHOU.getName">
    name = #{username}
</if>

总结而言，使用独立定义的枚举时保持正常的静态导入格式即可；一旦遇到枚举被包裹在其他类内部的情况，务必记得将中间的圆点改为美元符号 $，即可顺利避开反射取值的陷阱。

以上就是MyBatis条件if test使用枚举值的详细内容，更多关于MyBatis动态SQL枚举判断的资料请关注本站其它相关文章！