当前位置 : 首页 » 文章分类 :  开发  »  MyBatis

MyBatis

[TOC]


概述

MyBatis是一个支持普通SQL查询,存储过程和高级映射的优秀持久层框架,即ORM(Object Relational Mapping 对象关系映射)框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单的XML或注解用于配置和原始映射,将接口和Java的POJO(Plain Old Java Objects,普通的Java对象)映射成数据库中的记录。


SQL语句

select

<!-- 查询学生,根据id -->
<select id="getStudent" parameterType="String" resultMap="studentResultMap">
    SELECT ST.STUDENT_ID,
           ST.STUDENT_NAME,
           ST.STUDENT_SEX,
           ST.STUDENT_BIRTHDAY,
           ST.CLASS_ID
    FROM STUDENT_TBL ST
    WHERE ST.STUDENT_ID = #{studentID}
</select>

这条语句就叫做getStudent,有一个String参数,并返回一个StudentEntity类型的对象。

select语句的参数

属性 是否必须 描述
id 必须 在这个模式下唯一的标识符,可被其它语句引用。这个id也应该对应dao里面的某个方法(相当于方法的实现),因此id应该与方法名一致。
parameterType 可选 传给此语句的参数的完整类名或别名。如果不配置,mybatis会通过ParameterHandler根据参数类型默认选择合适的typeHandler进行处理。parameterType指定参数类型,可以是int,string等简单类型,也可以是复杂类型(如对象)
resultType 与resultMap二选一 语句返回值类型的整类名或别名。指定的类型可以是基本类型,可以是java容器,也可以是javabean(resultType与resultMap不能并用)
resultMap 与resultType二选一 resultMap用于引用我们通过resultMap标签定义的映射类型,这也是mybatis组件高级复杂映射的关键(resultType与resultMap不能并用)
flushCache 可选 将其设置为true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,select语句默认设为false
useCache 可选 将其设置为true,将会导致本条语句的结果被二级缓存,默认值:对select元素为true
timeout 可选 正整数值,这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数,默认为不设值,由驱动器自己决定
fetchSize 可选 正整数值,设置一个值后,驱动器会在结果集数目达到此数值后,激发返回,默认为不设值,由驱动器自己决定
statementType 可选 取值为STATEMENT,PREPARED或CALLABLE中的一个。这会让MyBatis分别使用 Statement,PreparedStatement或CallableStatement,默认值为PREPARED
resultSetType 可选 取值为FORWARD_ONLY,SCROLL_SENSITIVE或SCROLL_INSENSITIVE中的一个,默认值为unset(依赖驱动)

sql

sql元素用来定义一个可以复用的SQL 语句段,供其它语句调用。比如:

<!-- 复用sql语句  查询student表所有字段 -->
<sql id="selectStudentAll">
        SELECT ST.STUDENT_ID,
               ST.STUDENT_NAME,
               ST.STUDENT_SEX,
               ST.STUDENT_BIRTHDAY,
               ST.CLASS_ID
        FROM STUDENT_TBL ST
</sql>

这样,在select的语句中就可以直接引用使用了,将上面select语句改成:

<!-- 查询学生,根据id -->
<select id="getStudent" parameterType="String" resultMap="studentResultMap">
    <include refid="selectStudentAll"/>
    WHERE ST.STUDENT_ID = #{studentID}
</select>

MyBatis参数

MyBatis可以使用的参数包括基本数据类型和Java的复杂数据类型。
基本数据类型,如String,int,Date等,但是使用基本数据类型,只能提供一个参数
使用Java实体类,或Map类型做参数类型,通过#{}可以直接得到其属性。

基本类型参数

根据入学时间,检索学生列表:
SQL:

<!-- 查询学生list,根据入学时间  -->
<select id="getStudentListByDate"  parameterType="Date" resultMap="studentResultMap">
    SELECT *
    FROM STUDENT_TBL ST LEFT JOIN CLASS_TBL CT ON ST.CLASS_ID = CT.CLASS_ID
    WHERE CT.CLASS_YEAR = #{classYear};   
</select>

java调用

List<StudentEntity> studentList = studentMapper.getStudentListByClassYear(StringUtil.parse("2007-9-1"));
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Java实体类型参数

根据姓名和性别,检索学生列表,使用实体类做参数,通过#{}可以直接得到实体中的字段
SQL:

<!-- 查询学生list,like姓名、=性别,参数entity类型 -->
<select id="getStudentListWhereEntity" parameterType="StudentEntity" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')
          AND ST.STUDENT_SEX = #{studentSex}
</select>

java调用:

StudentEntity entity = new StudentEntity();
entity.setStudentName("李");
entity.setStudentSex("男");
List<StudentEntity> studentList = studentMapper.getStudentListWhereEntity(entity);
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Map参数

根据姓名和性别,检索学生列表,使用Map做参数:
SQL:

<!-- 查询学生list,=性别,参数map类型 -->
<select id="getStudentListWhereMap" parameterType="Map" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    WHERE ST.STUDENT_SEX = #{sex}
          AND ST.STUDENT_NAME = #{name}
</select>

java调用:

Map<String, String> map = new HashMap<String, String>();
map.put("sex", "女");
map.put("name", "李");
List<StudentEntity> studentList = studentMapper.getStudentListWhereMap(map);
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

多参数

如果想传入多个参数,则需要在接口的参数上添加@Param注解,给出一个实例:
接口写法:

public List<StudentEntity> getStudentListWhereParam(@Param(value = "name") String name, @Param(value = "sex") String sex, @Param(value = "birthday") Date birthday, @Param(value = "classEntity") ClassEntity classEntity);

SQL写法:

<!-- 查询学生list,like姓名、=性别、=生日、=班级,多参数方式 -->
<select id="getStudentListWhereParam" resultMap="studentResultMap">
    SELECT * from STUDENT_TBL ST
    <where>
        <if test="name!=null and name!='' ">
            ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{name}),'%')
        </if>
        <if test="sex!= null and sex!= '' ">
            AND ST.STUDENT_SEX = #{sex}
        </if>
        <if test="birthday!=null">
            AND ST.STUDENT_BIRTHDAY = #{birthday}
        </if>
        <if test="classEntity!=null and classEntity.classID !=null and classEntity.classID!='' ">
            AND ST.CLASS_ID = #{classEntity.classID}
        </if>
    </where>
</select>

进行查询:

List<StudentEntity> studentList = studentMapper.getStudentListWhereParam("", "",StringUtil.parse("1985-05-28"), classMapper.getClassByID("20000002"));
for (StudentEntity entityTemp : studentList) {
    System.out.println(entityTemp.toString());
}

Mybatis中#与$的区别

    • #{}: 解析为一个 JDBC 预编译语句(prepared statement)的参数标记符,一个 #{ } 被解析为一个参数占位符 。
    • ${}: 仅仅为一个纯碎的 string 替换,在动态 SQL 解析阶段将会进行变量替换。
    • #{}会在变量的值外面加引号
    • ${}不对变量值进行任何更改直接拼接
    • #{}是将传入的值当做字符串的形式,例如select id,name,age from student where id =#{id},当前端把id值1,传入到后台的时候,就相当于select id,name,age from student where id ='1'
    • ${}是将传入的数据直接显示生成sql语句,例如select id,name,age from student where id =${id},当前端把id值1,传入到后台的时候,就相当于select id,name,age from student where id = 1
    • #{}方式可以很大程度上防止sql注入(语句的拼接)。
    • ${}方式无法防止sql注入
    • 使用#{}就等于使用了PrepareStatement这种占位符的形式。可以防止sql注入等等问题,所以在大多数情况下还是经常使用#{}
    • 类似group by 字段 ,order by 字段,表名,字段名等没法使用占位符的就需要使用${}

使用PrepareStatement的好处

数据库有个功能叫绑定变量,就是针对一条sql预编译生成多个执行计划,如果只是参数改变的重复sql,绑定变量则会提高很大的性能。PrepareStatement就会使用数据库的绑定变量的功能。

${}引起sql注入示例

加入有sql语句:

SELECT * FROM ${tableName}

如果用户给tableName参数传入值user WHERE username ='xx',则组成sql为:

SELECT * FROM user WHERE username ='xx'

即实现了sql注入


动态SQL

if

if就是简单的条件判断,利用if语句我们可以实现某些简单的条件选择。先来看如下一个例子:

    <select id="dynamicIfTest" parameterType="Blog" resultType="Blog">
        select * from t_blog where 1 = 1
        <if test="title != null">
            and title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        <if test="owner != null">
            and owner = #{owner}
        </if>
    </select>

这条语句的意思非常简单,如果你提供了title参数,那么就要满足title=#{title},同样如果你提供了Content和Owner的时候,它们也需要满足相应的条件,之后就是返回满足这些条件的所有Blog,这是非常有用的一个功能,以往我们使用其他类型框架或者直接使用JDBC的时候, 如果我们要达到同样的选择效果的时候,我们就需要拼SQL语句,这是极其麻烦的,比起来,上述的动态SQL就要简单多了。


choose

choose元素的作用就相当于JAVA中的switch语句,基本上跟JSTL中的choose的作用和用法是一样的,通常都是与when和otherwise搭配的。看如下一个例子:

    <select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">
        select * from t_blog where 1 = 1
        <choose>
            <when test="title != null">
                and title = #{title}
            </when>
            <when test="content != null">
                and content = #{content}
            </when>
            <otherwise>
                and owner = "owner1"
            </otherwise>
        </choose>
    </select>

when元素表示当when中的条件满足的时候就输出其中的内容,跟JAVA中的switch效果差不多的是按照条件的顺序,当when中有条件满足的时候,就会跳出choose,即所有的when和otherwise条件中,只有一个会输出,当所有的when条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单, 当title!=null的时候就输出and titlte = #{title},不再往下判断条件,当title为空且content!=null的时候就输出and content = #{content},当所有条件都不满足的时候就输出otherwise中的内容。


where

where语句的作用主要是简化SQL语句中where中的条件判断的,先看一个例子,再解释一下where的好处。

    <select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">
        select * from t_blog
        <where>
            <if test="title != null">
                title = #{title}
            </if>
            <if test="content != null">
                and content = #{content}
            </if>
            <if test="owner != null">
                and owner = #{owner}
            </if>
        </where>
    </select>

where元素的作用是会在写入where元素的地方输出一个where,另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的,MyBatis会智能的帮你处理,如果所有的条件都不满足那么MyBatis就会查出所有的记录,如果输出后是and 开头的,MyBatis会把第一个and忽略,当然如果是or开头的,MyBatis也会把它忽略;此外,在where元素中你不需要考虑空格的问题,MyBatis会智能的帮你加上。像上述例子中,如果title=null, 而content != null,那么输出的整个语句会是select * from t_blog where content = #{content},而不是select * from t_blog where and content = #{content},因为MyBatis会智能的把首个and 或 or 给忽略


trim

trim元素的主要功能是可以在自己包含的内容前加上某些前缀或后缀,与之对应的属性是prefix(加前缀)和suffix(加后缀);也可以把包含内容的首部或尾部某些内容覆盖,即忽略,对应的属性是prefixOverrides(覆盖首部内容)和suffixOverrides(覆盖尾部内容);正因为trim有这样的功能,所以我们也可以非常简单的利用trim来代替where元素的功能,示例代码如下:

    <select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">
        select * from t_blog
        <trim prefix="where" prefixOverrides="and |or">
            <if test="title != null">
                title = #{title}
            </if>
            <if test="content != null">
                and content = #{content}
            </if>
            <if test="owner != null">
                or owner = #{owner}
            </if>
        </trim>
    </select>

意思是在包含内容前加上”where”,并将首部的and或or忽略。


set

set元素主要是用在更新操作的时候,它的主要功能和where元素其实是差不多的,主要是在包含的语句前输出一个set,然后如果包含的语句是以逗号结束的话将会把该逗号忽略,如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。下面是一段示例代码:

    <update id="dynamicSetTest" parameterType="Blog">
        update t_blog
        <set>
            <if test="title != null">
                title = #{title},
            </if>
            <if test="content != null">
                content = #{content},
            </if>
            <if test="owner != null">
                owner = #{owner}
            </if>
        </set>
        where id = #{id}
    </update>

上述示例代码中,如果set中一个条件都不满足,即set中包含的内容为空的时候就会报错。


foreach

foreach的主要用在构建in条件中,它可以在SQL语句中进行迭代一个集合。
foreach元素的属性主要有item,index,collection,open,separator,close。

  • item表示集合中每一个元素进行迭代时的别名,
  • index指定一个名字,用于表示在迭代过程中,每次迭代到的位置,
  • open表示该语句以什么开始,
  • separator表示在每次进行迭代之间以什么符号作为分隔符,
  • close表示以什么结束,
  • collection是迭代的集合

在使用foreach的时候最关键的也是最容易出错的就是collection属性,该属性是必须指定的,但是在不同情况下,该属性的值是不一样的,主要有一下3种情况:

  • 如果传入的是单参数且参数类型是一个List的时候,collection属性值为list
  • 如果传入的是单参数且参数类型是一个array数组的时候,collection的属性值为array
  • 如果传入的参数是多个的时候,我们就需要把它们封装成一个Map了,当然单参数也可以封装成map,实际上如果你在传入参数的时候,在MyBatis里面也是会把它封装成一个Map的,map的key就是参数名,所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key

单List类型参数

<select id="dynamicForeachTest" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

上述collection的值为list,对应的Mapper是这样的
public List<Blog> dynamicForeachTest(List<Integer> ids);
测试代码:

public void dynamicForeachTest() {  
    SqlSession session = Util.getSqlSessionFactory().openSession();  
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
    List<Integer> ids = new ArrayList<Integer>();  
    ids.add(1);  
    ids.add(3);  
    ids.add(6);  
    List<Blog> blogs = blogMapper.dynamicForeachTest(ids);  
    for (Blog blog : blogs)  
        System.out.println(blog);  
    session.close();  
}

单array类型参数

<select id="dynamicForeach2Test" resultType="Blog">
    select * from t_blog where id in
    <foreach collection="array" index="index" item="item" open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

上述collection为array,对应的Mapper代码:
public List<Blog> dynamicForeach2Test(int[] ids);
对应的测试代码:

public void dynamicForeach2Test() {  
    SqlSession session = Util.getSqlSessionFactory().openSession();  
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
    int[] ids = new int[] {1,3,6,9};  
    List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);  
    for (Blog blog : blogs)  
        System.out.println(blog);  
    session.close();  
}

Map类型参数

<select id="dynamicForeach3Test" resultType="Blog">  
    select * from t_blog where title like "%"#{title}"%" and id in  
    <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">  
        #{item}  
    </foreach>  
</select>

上述collection的值为ids,是传入的参数Map的key,对应的Mapper代码:
public List<Blog> dynamicForeach3Test(Map<String, Object> params);
对应测试代码:

public void dynamicForeach3Test() {  
    SqlSession session = Util.getSqlSessionFactory().openSession();  
    BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
    final List<Integer> ids = new ArrayList<Integer>();  
    ids.add(1);  
    ids.add(2);  
    ids.add(3);  
    ids.add(6);  
    ids.add(7);  
    ids.add(9);  
    Map<String, Object> params = new HashMap<String, Object>();  
    params.put("ids", ids);  
    params.put("title", "中国");  
    List<Blog> blogs = blogMapper.dynamicForeach3Test(params);  
    for (Blog blog : blogs)  
        System.out.println(blog);  
    session.close();  
}

自己遇到的例子

orgcabin格式为”C/Y/W”,分割后生成orgcabin的list,放入map,供mybatis中使用,
变更前舱位:增加多舱位的解析

if (StringUtils.isNotBlank(cons.getOrgCabin())) { //变更前舱位
    String orgCabinArray[] = cons.getOrgCabin().split(Symbol_Split_SLASH);//'/'分割多舱位
    List<String> orgCabinList = Arrays.asList(orgCabinArray);
    map.put("orgcabinList", orgCabinList);
}

变更前舱位list的解析:

<sql id="where">
    <where>
        <if test="@com.travelsky.adap.re.ais.dcm.common.OgnlUtil@isNotEmpty(orgcabinList)">
            and orgcabin in
            <foreach collection="orgcabinList" item="orgcabinItem" index="index" open="(" close=")" separator=",">
                #{orgcabinItem}
            </foreach>            
        </if>
    </where>      
</sql>

参考


上一篇 2015年运动记录

下一篇 Linux-常用命令

域名迁移公告
2017年12月20日起,本博客迁移到新域名madaimeng.com,旧域名masikkk.com不再更新内容,但将永久保持可访问!
阅读
3,712
阅读预计16分钟
创建日期 2015-11-16
修改日期 2017-07-24
类别
百度推荐