mybatis动态sql语句注意点

工作过程中,在进行接口测试的时候遇到了问题并成功解决,在此记录下结果。

  1. 首先,以下是我项目中某个查询功能的动态sql语句
<select id="queryCodes" parameterType="string" resultType="string">
    SELECT
    <if test="faqCode == 'all'">
        DISTINCT faq_label_code
    </if>
    <if test="faqCode != 'all' and faqCode != '' and faqCode != null">
        faq_label_code
    </if>
    <if test="faqCode == null">
        DISTINCT faq_code
    </if>
    FROM
        faq_label_mid
    WHERE 1=1
    <if test="faqCode != 'all' and faqCode != '' and faqCode != null">
       AND faq_code = #{faqCode}
    </if>
  </select>

可以看到,这里传入一个string类型的参数,通过对faqCode这个参数进行判断在数据库表中得到对应的查询结果。

  1. 下面是mapper接口中的方法,通过调用该方法就能去执行上面的动态sql语句
public interface FaqLabelMidMapper extends MzhMapper<FaqLabelMid> {
    List<String> queryCodes(String faqCode);
}
  1. 当传入一个字符串到这个方法并调用时,报错情况如下
Caused by: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'faqCode' in 'class java.lang.String'
  1. 解决方法
    提示的错误原因是 faqCode 字段没有 get 方法,这里错误的原因其实是WHERE 后面的if判断导致的


    image.png

    为调用接口的方法入参提供一个@Param注解,如下

List<String> queryCodes(@Param("faqCode") String faqCode);

就能成功运行。

当我把圈出来的部分代码注释掉时,即使不用加@Param注解也能运行成功。

  1. 结论
    mybatis传单个String类型,可以不用@param注解,前提是xml中不含有条件表达式(when,if..标签中没有引用到该参数)

注意点:对于该文章中上面的sql语句,if 可以在两个地方使用,分别是在SELECT...FROM 之间 和在 WHERE 之后。
对于本文中出现的错误,主要是因为WHERE后有if条件判断,但是方法入参却没有加上@Param注解导致。
经过我的测试,在SELECT...FROM之间有加上if条件判断,但是如果WHERE后没有if条件判断,即使方法入参不加@Param注解貌似也是能运行成功,至于其中的原理可能还得深入研究(如果有大佬愿意讲解,欢迎在评论区留言,或者有错误的地方可以直接在评论区提出,我会及时修改)

扩展:
上面的栗子中针对的是接口入参类型是单个字符串,以下介绍一下入参分别为List、Map类型是时的做法。
-当入参为List集合时

int deleteLabelsByCodes(List<String> codes);

sql语句

<delete id="deleteLabelsByCodes" parameterType="list">
      DELETE FROM
            t_faq_label
      WHERE 1=1
      <if test="list != null">
          AND faq_label_code
          IN
          <foreach collection="list" item="code" open="(" separator="," close=")">
              #{code}
          </foreach>
      </if>
  </delete>

我并没有在接口入参出加上@Param("list") 类似这样的注解,但是同样能执行成功,这是为什么呢?
这里我们不妨来看一下 查阅资料后mybatis中 对foreach这个标签属性解释


image.png

注意圈出来的部分我们可以知道,List<?>对象 作为入参时foreach的对象默认用 "list" 代替作为键,其实类似于我们使用注解@Param("list"),这样即使我们没加注解,遇到where 后的if判断同样能运行成功。
但是如果我们在接口入参加上了@Param注解,这时候默认以"list"作为键的规则就失效了,这时候不管是if 中的test判断还是foreach中的collection,都要以@Param注解中指定的参数为主。如下栗子

//这里加上@Param("codes")
int deleteLabelsByCodes(@Param("codes") List<String> codes);

  <delete id="deleteLabelsByCodes" parameterType="list">
      DELETE FROM
            t_faq_label
      WHERE 1=1
      <!--这边list要改为codes-->
      <if test="codes != null">
          AND faq_label_code
          IN
          <!--这边list要改为codes-->
          <foreach collection="codes" item="code" open="(" separator="," close=")">
              #{code}
          </foreach>
      </if>
  </delete>

-当入参为Map时

  1. test表达式中不用再加#,$之类的取值符了,就直接这样写就可以取到map中key所对应的值,而其他地方需要有#{map中的key}来取得map中该key所对应的值
Map<String,Object> conditions = new HashMap<>();
conditions.put("question",question);
conditions.put("faqTypeName",faqTypeName);
conditions.put("languageCode",languageCode);

 List<String> queryExistedFaqLabel(Map<String,Object> conditions );

  <select id="queryExistedFaqLabel" parameterType="map" resultType="string">
      SELECT
            faq_label_code
      FROM
            t_faq_label
      WHERE
            1=1
      AND
            faq_label_code
      IN
      <if test="faqLabelCodes != null">
        <foreach collection="faqLabelCodes" item="faqLabelCode" index="index" open="(" separator="," close=")">
            #{faqLabelCode}
        </foreach>
      </if>
      <if test="languageCode != '' and languageCode != null">
          AND language_code = #{languageCode}
      </if>
  </select>
  1. 对于在接口上加@Param("params")注解时,方法如下
List<WeixinUserLocationList> findweixinUserLocations(@Param("params") Map<String, Object> map);

注意就是注解@param 这个,是mybatis的,然后在xml中这样写:

<if test="params.accountId!=null">
      and a.accountid=#{params.accountId}
    </if>
    <if test="params.nickname!=null and params.nickname !=''">
      and a.nickname like '%${params.nickname}%'
    </if>
    <if test="params.beginDate!=null and params.beginDate!=''">
      and date_format(a.createtime,'%Y-%m-%d')>=${params.beginDate}
    </if>
    <if test="params.endDate!=null and params.endDate!=''">
    <![CDATA[  and date_format(a.createtime,'%Y-%m-%d')<=${params.endDate} ]]>  
    </if>

${params.nickname}这种写法参数默认是传字符串,#{params.accountId}可以取Long,Integer之类的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容