Mybatis动态SQL之where标签用法说明

来源：jb51　　时间：2022/6/27 10:53:45　　对本文有异议

关于where标签用法

xml映射文件部分内容:

<select id="selectIfCondition" resultType="com.heiketu.testpackage.pojo.Product">
? ? SELECT
? ? ? ? prod_id prodId,
? ? ? ? vend_id vendId,
? ? ? ? prod_name prodName,
? ? ? ? prod_desc prodDesc
? ? FROM Products
? ? <where>
? ? ? ? <if test="prodId != null and prodId != ''">
? ? ? ? ? ? AND prod_id = #{prodId}
? ? ? ? </if>
? ? ? ? <if test="prodName != null and prodName != ''">
? ? ? ? ? ? AND prod_name = #{prodName}
? ? ? ? </if>
? ? </where>
</select>

映射文件中的where标签可以过滤掉条件语句中的第一个and或or关键字。以上SQL当prodId!=null时会被mybatis的where标签去除掉多余的and关键字，生成的sql如下:

SELECT
? ? prod_id prodId,
? ? vend_id vendId,
? ? prod_name prodName,
? ? prod_desc prodDesc
FROM Products
WHERE
? ? prod_id = ?
AND
? ? prod_name = ?

注: where标签只能去除第一个条件中出现的前置 and 关键字。像以下情况，where就无能为力了:

<select id="selectIfCondition" resultType="com.heiketu.testpackage.pojo.Product">
? ? SELECT
? ? ? ? prod_id prodId,
? ? ? ? vend_id vendId,
? ? ? ? prod_name prodName,
? ? ? ? prod_desc prodDesc
? ? FROM Products
? ? <where>
? ? ? ? <if test="prodId != null and prodId != ''">
? ? ? ? ? ? prod_id = #{prodId} AND
? ? ? ? </if>
? ? ? ? <if test="prodName != null and prodName != ''">
? ? ? ? ? ? prod_name = #{prodName} AND
? ? ? ? </if>
? ? </where>
</select>

Mybatis会把次SQL语句拼接成:

SELECT
? ? prod_id prodId,
? ? vend_id vendId,
? ? prod_name prodName,
? ? prod_desc prodDesc
FROM Products
WHERE
? ? prod_id = ? AND
? ? prod_name = ? AND

where无法去除掉后面的and关键字，此时sql语句出现语法错误。

要想解决以上where标签无法处理的问题，可以考虑使用trim标签。

使用where标签及一些注意点

where标签简单使用

自己习惯性配上映射对象这个大家根据自己习惯去写，可以直接使用map去接返回参数

// 返回对象映射
<resultMap id="ResultMap" type="com.xxx.root.ConnRoot">
? ? ? ? <result column="CONN_ID" property="connId" jdbcType="NUMERIC"/>
? ? ? ? <result column="CONN_NO" property="connNo" jdbcType="VARCHAR"/>
? ? ? ? <result column="STA_ID" property="staId" jdbcType="NUMERIC"/>
? ? ? ? <result column="RUN_MODE" property="runMode" jdbcType="VARCHAR"/>
? ? ? ? <result column="SRV_ID" property="srvId" jdbcType="NUMERIC"/>
? ? ? ? <result column="LINE_ID" property="lineId" jdbcType="NUMERIC"/>
</resultMap>

// 此处为使用 where相关SQL
<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
? ? ? ? SELECT
? ? ? ? A.CONN_ID,
? ? ? ? A.CONN_NO,
? ? ? ? A.STA_ID,
? ? ? ? A.RUN_MODE,
? ? ? ? A.SRV_ID,
? ? ? ? A.LINE_ID
? ? ? ? FROM CONN A?
? ? ? ? where 1=1?
?? ??? ?<if test="srvId!= null" >
?? ??? ?AND SRV_ID= #{srvId,jdbcType=DECIMAL}
?? ??? ?</if>
</select>

jdbcType 加上可以避免在映射时出现某些错误

jdbc出现的需求及解决什么问题：当mybatis执行mapping文件时，如果某个映射的参数为空，无法确定他的类型时需要用到jdbcType来确定类型。

// 此处为使用 where 标签SQL
<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
? ? ? ? SELECT
? ? ? ? A.CONN_ID,
? ? ? ? A.CONN_NO,
? ? ? ? A.STA_ID,
? ? ? ? A.RUN_MODE,
? ? ? ? A.SRV_ID,
? ? ? ? A.LINE_ID
? ? ? ? FROM CONN A
?? ??? ?<where>?
?? ??? ??? ?<if test="srvId!= null">
?? ??? ??? ? A.SRV_ID= #{srvId,jdbcType=DECIMAL}
?? ??? ??? ?</if>?
?? ??? ??? ?<if test="runMode!= null">
?? ??? ??? ?AND ?A.RUN_MODE= #{runMode,jdbcType=VARCHAR}
?? ??? ??? ?</if>
?? ??? ?</where>
</select>

到这里大家可以看到where标签使用和不适用的一些区别

首先是 where后面加 1=1，在使用where关键字时，因为条件不确定存在不存在，要加上 1=1这个垃圾条件来解决条件为空时where失去存在的意义；但是< where >标签中不需要加 1=1这个垃圾条件，因为where标签会自动处理只有在一个以上的< if >标签有值时才去插入“WHERE”子句到SQL中。

然后是另一个问题条件AND 条件，where标签会自动去除首个条件中的AND，这样大家就可以不用去管第一个条件是否为空可以直接给所有if标签中的条件都加上AND，但是自己还是习惯的将第一个条件去掉AND ，但是如果遇到前边已经有一个存在的条件的情况下，那接下来所有的if中的条件开头AND是必须要加的，如：

<select id="listConnection" parameterType="java.util.Map" resultMap="ResultMap">
? ? ? ? SELECT
? ? ? ? A.CONN_ID,
? ? ? ? A.CONN_NO,
? ? ? ? A.STA_ID,
? ? ? ? A.RUN_MODE,
? ? ? ? A.SRV_ID,
? ? ? ? A.LINE_ID
? ? ? ? FROM CONN A
?? ??? ?<where>?
?? ??? ??? ?A.CONN_ID=1
?? ??? ??? ?<if test="srvId!= null">
?? ??? ??? ?AND ? A.SRV_ID= #{srvId,jdbcType=DECIMAL}
?? ??? ??? ?</if>?
?? ??? ??? ?<if test="runMode!= null">
?? ??? ??? ?AND ?A.RUN_MODE= #{runMode,jdbcType=VARCHAR}
?? ??? ??? ?</if>
?? ??? ?</where>
</select>