笔记：MyBatis 动态SQL

有时候，静态的SQL语句并不能满足应用程序的需求。我们可以根据一些条件，来动态地构建SQL语句。例如，在Web应用程序中，有可能有一些搜索界面，需要输入一个或多个选项，然后根据这些已选择的条件去执行检索操作。在实现这种类型的搜索功能，我们可能需要根据这些条件来构建动态的SQL语句。如果用户提供了任何输入条件，我们需要将那个条件 添加到SQL语句的WHERE子句中。

MyBatis通过使用<if>,<choose>,<where>,<foreach>,<trim>元素提供了对构造动态SQL语句的高级别支持。

  1. if
    语句

    <if>元素被用来有条件地嵌入SQL片段，如果测试条件被赋值为true，则相应地SQL片段将会被添加到SQL语句中。

    假定我们有一个课程搜索界面，设置了 讲师（Tutor）下拉列表框，课程名称（CourseName）文本输入框，开始时间（StartDate）输入框，结束时间（EndDate）输入框，作为搜索条件。假定课讲师下拉列表是必须选的，其他的都是可选的。

    当用户点击 搜索按钮时，我们需要显示符合以下条件的成列表：

  • ? 特定讲师的课程
  • ? 课程名包含输入的课程名称关键字的课程；如果课程名称输入为空，则取所有课程
  • ? 在开始时间和结束时间段内的课程

我们可以对应的映射语句，如下所示：

<resultMap
type="Course"
id="CourseResult">

????<id
column="course_id"
property="courseId"
/>

????<result
column="name"
property="name"
/>

????<result
column="description"
property="description"
/>

????<result
column="start_date"
property="startDate"
/>

????<result
column="end_date"
property="endDate"
/>

</resultMap>

<!-- 查询输入参数定义为 hashmap 类型 -->

<select
id="searchCourses"
parameterType="hashmap"
resultMap="CourseResult">

????????SELECT * FROM COURSES

????????????????WHERE TUTOR_ID= #{tutorId}

????????<if
test="courseName != null">

????????AND NAME LIKE #{courseName}

????????</if>

????????<if
test="startDate != null">

????????AND START_DATE >= #{startDate}

????????</if>

????????<if
test="endDate != null">

????????AND END_DATE <= #{endDate}

????????</if>

</select>

Java代码如下：

????public interface CourseMapper

????{

???? List<Course> searchCourses(Map<String, Object> map);

????}

????public
void
searchCourses()

????{

???? Map<String, Object> map = new HashMap<String, Object>();

???? map.put("tutorId", 1);

???? map.put("courseName", "%java%");

???? map.put("startDate", new
Date());

???? CourseMapper mapper = sqlSession.getMapper(CourseMapper.class);

???? List<Course> courses = mapper.searchCourses(map);

???? for (Course course : courses)

???? {

System.out.println(course);

???? }

????}

  1. choose,when 和otherwise 条件

    有时候，查询功能是以查询类别为基础的。首先，用户需要选择是否希望通过选择讲师，课程名称，开始时间，或结束时间作为查询条件类别来进行查询，然后根据选择的查询类别，输入相应的参数。在这样的情景中，我们需要只使用其中一种查询类别。

    MyBatis 提供了<choose>元素支持此类型的SQL预处理。

    现在让我们书写一个适用此情景的SQL映射语句。如果没有选择查询类别，则查询开始时间在今天之后的课程，代码如下：

    <select
    id="searchCourses"
    parameterType="hashmap"
    resultMap="CourseResult">

    ????????SELECT * FROM COURSES

    ????????<choose>

    ????????????????<when
    test="searchBy == ‘Tutor‘">

    ????????????????????????WHERE TUTOR_ID= #{tutorId}

    ????????????????</when>

    ????????????????<when
    test="searchBy == ‘CourseName‘">

    ????????????????????????WHERE name like #{courseName}

    ????????????????</when>

    ????????????????<otherwise>

    ????????????????????????WHERE TUTOR start_date >= now()

    ????????????????</otherwise>

    ????????</choose>

    </select>

    MyBatis计算<choose>测试条件的值，且使用第一个值为TRUE的子句。如果没有条件为true，则使用<otherwise>内的子句。

  2. where
    条件

    有时候，所有的查询条件（criteria）应该是可选的。在需要使用至少一种查询条件的情况下，我们应该使用WHERE子句。并且， 如果有多个条件，我们需要在条件中添加AND或OR。MyBatis提供了<where>元素支持这种类型的动态SQL语句。

    在我们查询课程界面，我们假设所有的查询条件是可选的。进而，当需要提供一个或多个查询条件时，应该改使用WHERE子句。

    <select
    id="searchCourses"
    parameterType="hashmap"
    resultMap="CourseResult">

    ????????SELECT * FROM COURSES

    ????????<where>

    ????????????????<if
    test=" tutorId != null ">

    ????????????????????????TUTOR_ID= #{tutorId}

    ????????????????</if>

    ????????????????<if
    test="courseName != null">

    ????????????????????????AND name like #{courseName}

    ????????????????</if>

    ????????????????<if
    test="startDate != null">

    ????????????????????????AND start_date >= #{startDate}

    ????????????????</if>

    ????????????????<if
    test="endDate != null">

    ????????????????????????AND end_date <= #{endDate}

    ????????????????</if>

    ????????</where>

    </select>

    <where>元素只有在其内部标签有返回内容时才会在动态语句上插入WHERE条件语句。并且，如果WHERE子句以AND或者OR打头，则打头的AND或OR将会被移除。如果tutor_id参数值为null，并且courseName参数值不为null，则<where>标签会将AND name like#{courseName} 中的AND移除掉，生成的SQL WHERE子句为：where name like#{courseName}。

  3. trim条件

    <trim>元素和<where>元素类似，但是<trim>提供了在添加前缀/后缀 或者移除前缀/后缀方面提供更大的灵活性

    <select
    id="searchCourses"
    parameterType="hashmap"
    resultMap="CourseResult">

    SELECT * FROM COURSES

    <trim
    prefix="WHERE"
    prefixOverrides="AND | OR">

    <if
    test=" tutorId != null ">

    TUTOR_ID= #{tutorId}

    </if>

    <if
    test="courseName != null">

    AND name like #{courseName}

    </if>

    </trim>

    </select>

    这里如果任意一个<if>条件为true，<trim>元素会插入WHERE,并且移除紧跟WHERE后面的AND或OR

  4. foreach循环

    另外一个强大的动态SQL语句构造标签即是<foreach>。它可以迭代遍历一个数组或者列表，构造AND/OR条件或一个IN子句。

    假设我们想找到tutor_id为1，3，6的讲师所教授的课程，我们可以传递一个tutor_id组成的列表给映射语句，然后通过<foreach>遍历此列表构造动态SQL。

    注意：如果参数类型为
    List
    则其 <foreach…/> 的
    collection
    设置为
    list，如果为
    map
    则设置为集合的
    key
    名称。

    <select
    id="searchCoursesByTutors"
    parameterType="map"
    resultMap="CourseResult">

    SELECT * FROM COURSES

    <if
    test="tutorIds != null">

    <where>

    <foreach
    item="tutorId"
    collection="tutorIds">

    OR tutor_id=#{tutorId}

    </foreach>

    </where>

    </if>

    </select>

    ?
    ?

    Java代码：

    public interface CourseMapper

    {

    ????????List<Course> searchCoursesByTutors(Map<String, Object> map);

    }

    public
    void
    searchCoursesByTutors()

    {

    ????????Map<String, Object> map = new HashMap<String, Object>();

    ????????List<Integer> tutorIds = new ArrayList<Integer>();

    ????????tutorIds.add(1);

    ????????tutorIds.add(3);

    ????????tutorIds.add(6);

    ????????map.put("tutorIds", tutorIds);

    ????????CourseMapper mapper =

    ????????????????sqlSession.getMapper(CourseMapper.class);

    ????????List<Course> courses = mapper.searchCoursesByTutors(map);

    ????????for (Course course : courses)

    ????????{

    ????????????????System.out.println(course);

    ????????}

    }

    现在让我们来看一下怎样使用<foreach>生成 IN子句：

    <select
    id="searchCoursesByTutors"
    parameterType="map"
    resultMap="CourseResult">

    ????????SELECT * FROM COURSES

    ????????<if
    test="tutorIds != null">

    ????????????????<where>

    tutor_id IN

    ????????????????????????<foreach
    item="tutorId"
    collection="tutorIds" ?open="("
    separator=","
    close=")">

    ?#{tutorId}

    ????????????????????????</foreach>

    ????????????????</where>

    ????????</if>

    </select>

  5. set条件

    <set>元素和<where>元素类似，如果其内部条件判断有任何内容返回时，他会插入SET SQL片段。

    <update
    id="updateStudent"
    parameterType="Student">

    ????????update students

    ????????<set>

    ????????<if
    test="name != null">name=#{name},</if>

    ????????<if
    test="email != null">email=#{email},</if>

    ????????<if
    test="phone != null">phone=#{phone},</if>

    ????????</set>

    ????????where stud_id=#{id}

    </update>

    这里，如果<if>条件返回了任何文本内容，<set>将会插入set关键字和其文本内容，并且会剔除将末尾的 "，"。

    在上述的例子中，如果 phone!=null,<set>将会让会移除 phone=#{phone}后的逗号","，生成 set phone=#{phone} 。

    ?
    ?

时间： 2024-10-11 05:52:18

笔记：MyBatis 动态SQL的相关文章

mybatis实战教程(mybatis in action)之八：mybatis 动态sql语句

mybatis 的动态sql语句是基于OGNL表达式的.可以方便的在 sql 语句中实现某些逻辑. 总体说来mybatis 动态SQL 语句主要有以下几类:1. if 语句 (简单的条件判断)2. choose (when,otherwize) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似.3. trim (对包含的内容加上 prefix,或者 suffix 等,前缀,后缀)4. where (主要是用来简化sql语句中where条件判断的,能智能的处理 a

MyBatis动态SQL小结

p.MsoNormal,li.MsoNormal,div.MsoNormal { margin: 0cm; margin-bottom: .0001pt; text-align: justify; font-size: 10.5pt; font-family: 等线 } .MsoChpDefault { font-family: 等线 } div.WordSection1 { } ol { margin-bottom: 0cm } ul { margin-bottom: 0cm } Mybati

MyBatis动态SQL————MyBatis动态SQL标签的用法

1.MyBatis动态SQL MyBatis 的强大特性之一便是它的动态 SQL,即拼接SQL字符串.如果你有使用 JDBC 或其他类似框架的经验,你就能体会到根据不同条件拼接 SQL 语句有多么痛苦.拼接的时候要确保不能忘了必要的空格,还要注意省掉列名列表最后的逗号.利用动态 SQL 这一特性可以彻底摆脱这种痛苦. 通常使用动态 SQL 不可能是独立的一部分,MyBatis 当然使用一种强大的动态 SQL 语言来改进这种情形,这种语言可以被用在任意的 SQL 映射语句中. 动态 SQL 元素和

用Groovy模板写MyBatis动态SQL

MyBatis动态SQL简介 MyBatis有个强大的功能,动态SQL.有了这个功能,定义在Mapper里的SQL语句,就不必是静止不变的了,而是可以根据传入的参数,动态调整.下面是MyBatis官方文档里的一个if语句的例子: <select id="findActiveBlogWithTitleLike" resultType="Blog"> SELECT * FROM BLOG WHERE state = 'ACTIVE' <if test=

Mybatis 动态sql（转载）

原文地址:http://www.cnblogs.com/dongying/p/4092662.html 传统的使用JDBC的方法,相信大家在组合复杂的的SQL语句的时候,需要去拼接,稍不注意哪怕少了个空格,都会导致错误.Mybatis的动态SQL功能正是为了解决这种问题, 其通过 if, choose, when, otherwise, trim, where, set, foreach标签,可组合成非常灵活的SQL语句,从而提高开发人员的效率.下面就去感受Mybatis动态SQL的魅力吧: 1

mybatis 动态sql语句

mybatis 的动态sql语句是基于OGNL表达式的.可以方便的在 sql 语句中实现某些逻辑. 总体说来mybatis 动态SQL 语句主要有以下几类: 1. if 语句 (简单的条件判断) 2. choose (when,otherwize) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似. 3. trim (对包含的内容加上 prefix,或者 suffix 等,前缀,后缀) 4. where (主要是用来简化sql语句中where条件判断的,能智能的

mybatis 动态sql和参数

mybatis 动态sql 名词解析 OGNL表达式 OGNL,全称为Object-Graph Navigation Language,它是一个功能强大的表达式语言,用来获取和设置Java对象的属性,它旨在提供一个更高的更抽象的层次来对Java对象图进行导航. OGNL表达式的基本单位是"导航链",一般导航链由如下几个部分组成: 属性名称(property) 方法调用(method invoke) 数组元素 所有的OGNL表达式都基于当前对象的上下文来完成求值运算,链的前面部分的结果将

4.mybatis动态SQL拼接/取值/OGNL

4.mybatis动态SQL拼接/取值 一.mybatis框架的SQL拼接是采用OGNL表达式进行的,以下我会列出常用的取值方法. 图片来源:慕课网 1.1常用的取值方法: 1.2特殊的取值方法: mod为取余数

MyBatis动态SQL之一使用 if 标签和 choose标签

bootstrap react https://segmentfault.com/a/1190000010383464 xml 中 < 转义 to thi tha <if test="pricehigh!=null"> and price < #{pricehigh,jdbcType=INTEGER} </if> MyBatis动态SQL之一使用 if 标签和 choose标签 <select id="getItems" p

mybatis动态sql中的两个内置参数（_parameter和_databaseId）

<!-- mybatis动态sql的两个内置参数           不只是方法传递过来的参数可以被用来判断,取值       mybatis默认还有两个内置参数           _parameter:代表整个参数                                      单个参数:_parameter就是这个参数                                      多个参数:参数会被封装为一个map:_parameter就是代表这个map