详解Java的MyBatis框架中SQL语句映射部分的编写

1.resultMap
SQL 映射XML 文件是所有sql语句放置的地方。需要定义一个workspace，一般定义为对应的接口类的路径。写好SQL语句映射文件后，需要在MyBAtis配置文件mappers标签中引用，例如：

<mappers>
  <mapper resource="com/liming/manager/data/mappers/UserMapper.xml" />
  <mapper resource="com/liming/manager/data/mappers/StudentMapper.xml" />
  <mapper resource="com/liming/manager/data/mappers/ClassMapper.xml" />
  <mapper resource="com/liming/manager/data/mappers/TeacherMapper.xml" />
</mappers>

当Java接口与XML文件在一个相对路径下时，可以不在myBatis配置文件的mappers中声明。

SQL 映射XML 文件一些初级的元素：

（1）. cache – 配置给定模式的缓存
（2）. cache-ref – 从别的模式中引用一个缓存
（3）. resultMap – 这是最复杂而却强大的一个元素了，它描述如何从结果集中加载对象
（4）. sql – 一个可以被其他语句复用的SQL 块
（5）. insert – 映射INSERT 语句
（6）. update – 映射UPDATE 语句
（7）. delete – 映射DELEETE 语句
（8）. select  -  映射SELECT语句

1.1 resultMap
resultMap 是MyBatis 中最重要最强大的元素了。你可以让你比使用JDBC 调用结果集省掉90%的代码，也可以让你做许多JDBC 不支持的事。现实上，要写一个等同类似于交互的映射这样的复杂语句，可能要上千行的代码。ResultMaps的目的，就是这样简单的语句而不需要多余的结果映射，更多复杂的语句，除了只要一些绝对必须的语句描述关系以外，再也不需要其它的。
resultMap属性：type为java实体类；id为此resultMap的标识。
 
resultMap可以设置的映射：

（1）. constructor – 用来将结果反射给一个实例化好的类的构造器
a) idArg – ID 参数；将结果集标记为ID，以方便全局调用
b) arg –反射到构造器的通常结果

（2）. id – ID 结果，将结果集标记为ID，以方便全局调用

（3）. result – 反射到JavaBean 属性的普通结果

（4）. association – 复杂类型的结合；多个结果合成的类型
a) nested result mappings – 几resultMap 自身嵌套关联，也可以引用到一个其它上

（5）. collection –复杂类型集合a collection of complex types

（6）. nested result mappings – resultMap 的集合，也可以引用到一个其它上

（7）. discriminator – 使用一个结果值以决定使用哪个resultMap
a) case – 基本一些值的结果映射的case 情形
i. nested result mappings –一个case 情形本身就是一个结果映射，因此也可以包括一些相同的元素，也可以引用一个外部resultMap。
 
1.1.1 id、result
id、result是最简单的映射，id为主键映射；result其他基本数据库表字段到实体类属性的映射。
最简单的例子：

<resultMap type="liming.student.manager.data.model.StudentEntity" id="studentResultMap">
  <id property="studentId"    column="STUDENT_ID" javaType="String" jdbcType="VARCHAR"/>
  <result property="studentName"    column="STUDENT_NAME" javaType="String" jdbcType="VARCHAR"/>
  <result property="studentSex"    column="STUDENT_SEX" javaType="int" jdbcType="INTEGER"/>
  <result property="studentBirthday"  column="STUDENT_BIRTHDAY" javaType="Date" jdbcType="DATE"/>
  <result property="studentPhoto" column="STUDENT_PHOTO" javaType="byte[]" jdbcType="BLOB" typeHandler="org.apache.ibatis.type.BlobTypeHandler" />
</resultMap>

id、result语句属性配置细节：

支持的JDBC类型
       为了将来的引用，MyBatis 支持下列JDBC 类型，通过JdbcType 枚举：
BIT，FLOAT，CHAR，TIMESTAMP，OTHER，UNDEFINED，TINYINT，REAL，VARCHAR，BINARY，BLOB，NVARCHAR，SMALLINT，DOUBLE，LONGVARCHAR，VARBINARY，CLOB，NCHAR，INTEGER，NUMERIC，DATE，LONGVARBINARY，BOOLEAN，NCLOB，BIGINT，DECIMAL，TIME，NULL，CURSOR
 
1.1.2 constructor
我们使用id、result时候，需要定义java实体类的属性映射到数据库表的字段上。这个时候是使用JavaBean实现的。当然我们也可以使用实体类的构造方法来实现值的映射，这个时候是通过构造方法参数的书写的顺序来进行赋值的。使用construcotr功能有限（例如使用collection级联查询）。上面使用id、result实现的功能就可以改为：

<resultMap type="StudentEntity" id="studentResultMap" >
  <constructor>
    <idArg javaType="String" column="STUDENT_ID"/>
    <arg javaType="String" column="STUDENT_NAME"/>
    <arg javaType="String" column="STUDENT_SEX"/>
    <arg javaType="Date" column="STUDENT_BIRTHDAY"/>
  </constructor>
</resultMap>

当然，我们需要定义StudentEntity实体类的构造方法：

public StudentEntity(String studentID, String studentName, String studentSex, Date studentBirthday){
  this.studentID = studentID;
  this.studentName = studentName;
  this.studentSex = studentSex;
  this.studentBirthday = studentBirthday;
}

1.1.3 association联合
联合元素用来处理“一对一”的关系。需要指定映射的Java实体类的属性，属性的javaType（通常MyBatis 自己会识别）。对应的数据库表的列名称。如果想覆写的话返回结果的值，需要指定typeHandler。
不同情况需要告诉MyBatis 如何加载一个联合。MyBatis 可以用两种方式加载：
（1）. select: 执行一个其它映射的SQL 语句返回一个Java实体类型。较灵活；
（2）. resultsMap: 使用一个嵌套的结果映射来处理通过join查询结果集，映射成Java实体类型。
 
例如，一个班级对应一个班主任。
 首先定义好班级中的班主任属性：

private TeacherEntity teacherEntity;

1.1.3.1使用select实现联合
 例：班级实体类中有班主任的属性，通过联合在得到一个班级实体时，同时映射出班主任实体。
 这样可以直接复用在TeacherMapper.xml文件中定义好的查询teacher根据其ID的select语句。而且不需要修改写好的SQL语句，只需要直接修改resultMap即可。

ClassMapper.xml文件部分内容：

<resultMap type="ClassEntity" id="classResultMap">
  <id property="classID" column="CLASS_ID" />
  <result property="className" column="CLASS_NAME" />
  <result property="classYear" column="CLASS_YEAR" />
  <association property="teacherEntity" column="TEACHER_ID" select="getTeacher"/>
</resultMap> 

<select id="getClassByID" parameterType="String" resultMap="classResultMap">
  SELECT * FROM CLASS_TBL CT
  WHERE CT.CLASS_ID = #{classID};
</select>

TeacherMapper.xml文件部分内容：

<resultMap type="TeacherEntity" id="teacherResultMap">
  <id property="teacherID" column="TEACHER_ID" />
  <result property="teacherName" column="TEACHER_NAME" />
  <result property="teacherSex" column="TEACHER_SEX" />
  <result property="teacherBirthday" column="TEACHER_BIRTHDAY"/>
  <result property="workDate" column="WORK_DATE"/>
  <result property="professional" column="PROFESSIONAL"/>
</resultMap> 

<select id="getTeacher" parameterType="String" resultMap="teacherResultMap">
  SELECT *
   FROM TEACHER_TBL TT
   WHERE TT.TEACHER_ID = #{teacherID}
</select>

1.1.3.2使用resultMap实现联合
 与上面同样的功能，查询班级，同时查询器班主任。需在association中添加resultMap（在teacher的xml文件中定义好的），新写sql（查询班级表left join教师表），不需要teacher的select。

修改ClassMapper.xml文件部分内容：

<resultMap type="ClassEntity" id="classResultMap">
  <id property="classID" column="CLASS_ID" />
  <result property="className" column="CLASS_NAME" />
  <result property="classYear" column="CLASS_YEAR" />
  <association property="teacherEntity" column="TEACHER_ID" resultMap="teacherResultMap"/>
</resultMap> 

<select id="getClassAndTeacher" parameterType="String" resultMap="classResultMap">
  SELECT *
   FROM CLASS_TBL CT LEFT JOIN TEACHER_TBL TT ON CT.TEACHER_ID = TT.TEACHER_ID
   WHERE CT.CLASS_ID = #{classID};
</select>

其中的teacherResultMap请见上面TeacherMapper.xml文件部分内容中。

1.1.4 collection聚集
聚集元素用来处理“一对多”的关系。需要指定映射的Java实体类的属性，属性的javaType（一般为ArrayList）；列表中对象的类型ofType（Java实体类）；对应的数据库表的列名称；
不同情况需要告诉MyBatis 如何加载一个聚集。MyBatis 可以用两种方式加载：
（1）. select: 执行一个其它映射的SQL 语句返回一个Java实体类型。较灵活；
（2）. resultsMap: 使用一个嵌套的结果映射来处理通过join查询结果集，映射成Java实体类型。
例如，一个班级有多个学生。
首先定义班级中的学生列表属性：
private List<StudentEntity> studentList; 
1.1.4.1使用select实现聚集
 用法和联合很类似，区别在于，这是一对多，所以一般映射过来的都是列表。所以这里需要定义javaType为ArrayList，还需要定义列表中对象的类型ofType，以及必须设置的select的语句名称（需要注意的是，这里的查询student的select语句条件必须是外键classID）。
ClassMapper.xml文件部分内容：

<resultMap type="ClassEntity" id="classResultMap">
  <id property="classID" column="CLASS_ID" />
  <result property="className" column="CLASS_NAME" />
  <result property="classYear" column="CLASS_YEAR" />
  <association property="teacherEntity" column="TEACHER_ID" select="getTeacher"/>
  <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" select="getStudentByClassID"/>
</resultMap> 

<select id="getClassByID" parameterType="String" resultMap="classResultMap">
  SELECT * FROM CLASS_TBL CT
  WHERE CT.CLASS_ID = #{classID};
</select>

StudentMapper.xml文件部分内容：

<!-- java属性，数据库表字段之间的映射定义 -->
<resultMap type="StudentEntity" id="studentResultMap">
  <id property="studentID" column="STUDENT_ID" />
  <result property="studentName" column="STUDENT_NAME" />
  <result property="studentSex" column="STUDENT_SEX" />
  <result property="studentBirthday" column="STUDENT_BIRTHDAY" />
</resultMap> 

<!-- 查询学生list，根据班级id -->
<select id="getStudentByClassID" parameterType="String" resultMap="studentResultMap">
  <include refid="selectStudentAll" />
  WHERE ST.CLASS_ID = #{classID}
</select>

1.1.4.2使用resultMap实现聚集
 使用resultMap，就需要重写一个sql，left join学生表。

<resultMap type="ClassEntity" id="classResultMap">
  <id property="classID" column="CLASS_ID" />
  <result property="className" column="CLASS_NAME" />
  <result property="classYear" column="CLASS_YEAR" />
  <association property="teacherEntity" column="TEACHER_ID" resultMap="teacherResultMap"/>
  <collection property="studentList" column="CLASS_ID" javaType="ArrayList" ofType="StudentEntity" resultMap="studentResultMap"/>
</resultMap> 

<select id="getClassAndTeacherStudent" parameterType="String" resultMap="classResultMap">
  SELECT *
   FROM CLASS_TBL CT
      LEFT JOIN STUDENT_TBL ST
       ON CT.CLASS_ID = ST.CLASS_ID
      LEFT JOIN TEACHER_TBL TT
       ON CT.TEACHER_ID = TT.TEACHER_ID
   WHERE CT.CLASS_ID = #{classID};
</select>

其中的teacherResultMap请见上面TeacherMapper.xml文件部分内容中。studentResultMap请见上面StudentMapper.xml文件部分内容中。
1.1.5discriminator鉴别器
有时一个单独的数据库查询也许返回很多不同（但是希望有些关联）数据类型的结果集。鉴别器元素就是被设计来处理这个情况的，还有包括类的继承层次结构。鉴别器非常容易理解，因为它的表现很像Java语言中的switch语句。
定义鉴别器指定了column和javaType属性。列是MyBatis查找比较值的地方。JavaType是需要被用来保证等价测试的合适类型（尽管字符串在很多情形下都会有用）。
下面这个例子为，当classId为20000001时，才映射classId属性。

<resultMap type="liming.student.manager.data.model.StudentEntity" id="resultMap_studentEntity_discriminator">
  <id property="studentId"    column="STUDENT_ID" javaType="String" jdbcType="VARCHAR"/>
  <result property="studentName"    column="STUDENT_NAME" javaType="String" jdbcType="VARCHAR"/>
  <result property="studentSex"    column="STUDENT_SEX" javaType="int" jdbcType="INTEGER"/>
  <result property="studentBirthday"  column="STUDENT_BIRTHDAY" javaType="Date" jdbcType="DATE"/>
  <result property="studentPhoto" column="STUDENT_PHOTO" javaType="byte[]" jdbcType="BLOB" typeHandler="org.apache.ibatis.type.BlobTypeHandler" />
  <result property="placeId"      column="PLACE_ID" javaType="String" jdbcType="VARCHAR"/>
  <discriminator column="CLASS_ID" javaType="String" jdbcType="VARCHAR">
    <case value="20000001" resultType="liming.student.manager.data.model.StudentEntity" >
      <result property="classId" column="CLASS_ID" javaType="String" jdbcType="VARCHAR"/>
    </case>
  </discriminator>
</resultMap>

2.增删改查、参数、缓存

2.1 select
一个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类型的对象。
注意参数的标识是：#{studentID}。
 
select 语句属性配置细节：

2.2 insert
 一个简单的insert语句：

<!-- 插入学生 -->
<insert id="insertStudent" parameterType="StudentEntity">
    INSERT INTO STUDENT_TBL (STUDENT_ID,
                     STUDENT_NAME,
                     STUDENT_SEX,
                     STUDENT_BIRTHDAY,
                     CLASS_ID)
       VALUES  (#{studentID},
             #{studentName},
             #{studentSex},
             #{studentBirthday},
             #{classEntity.classID})
</insert>

insert可以使用数据库支持的自动生成主键策略，设置useGeneratedKeys=”true”，然后把keyProperty 设成对应的列，就搞定了。比如说上面的StudentEntity 使用auto-generated 为id 列生成主键.还可以使用selectKey元素。下面例子，使用mysql数据库nextval('student')为自定义函数，用来生成一个key。

<!-- 插入学生 自动主键-->
<insert id="insertStudentAutoKey" parameterType="StudentEntity">
  <selectKey keyProperty="studentID" resultType="String" order="BEFORE">
      select nextval('student')
  </selectKey>
    INSERT INTO STUDENT_TBL (STUDENT_ID,
                 STUDENT_NAME,
                 STUDENT_SEX,
                 STUDENT_BIRTHDAY,
                 CLASS_ID)
       VALUES  (#{studentID},
            #{studentName},
            #{studentSex},
            #{studentBirthday},
            #{classEntity.classID})
</insert>

insert语句属性配置细节：

selectKey语句属性配置细节：

2.3 update、delete
一个简单的update：

<!-- 更新学生信息 -->
<update id="updateStudent" parameterType="StudentEntity">
    UPDATE STUDENT_TBL
      SET STUDENT_TBL.STUDENT_NAME = #{studentName},
        STUDENT_TBL.STUDENT_SEX = #{studentSex},
        STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},
        STUDENT_TBL.CLASS_ID = #{classEntity.classID}
     WHERE STUDENT_TBL.STUDENT_ID = #{studentID};
</update>

一个简单的delete：

<!-- 删除学生 -->
<delete id="deleteStudent" parameterType="StudentEntity">
    DELETE FROM STUDENT_TBL WHERE STUDENT_ID = #{studentID}
</delete>

update、delete语句属性配置细节：

2.4 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>

 2.5 parameters
        上面很多地方已经用到了参数，比如查询、修改、删除的条件，插入，修改的数据等，MyBatis可以使用的基本数据类型和Java的复杂数据类型。
        基本数据类型，String，int，date等。
        但是使用基本数据类型，只能提供一个参数，所以需要使用Java实体类，或Map类型做参数类型。通过#{}可以直接得到其属性。
2.5.1 基本类型参数
 根据入学时间，检索学生列表：

<!-- 查询学生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>

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

2.5.2 Java实体类型参数
 根据姓名和性别，检索学生列表。使用实体类做参数：

<!-- 查询学生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>

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

2.5.3Map参数
根据姓名和性别，检索学生列表。使用Map做参数：

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

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());
}

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

public List<StudentEntity> getStudentListWhereParam(@Param(value = "name") String name, @Param(value = "sex") String sex, @Param(value = "birthday") Date birthdar, @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());
}

2.5.5字符串代入法
        默认的情况下，使用#{}语法会促使MyBatis 生成PreparedStatement 属性并且使用PreparedStatement 的参数（=？）来安全的设置值。尽量这些是快捷安全，也是经常使用的。但有时候你可能想直接未更改的字符串代入到SQL 语句中。比如说，对于ORDER BY，你可能会这样使用：ORDER BY ${columnName}但MyBatis 不会修改和规避掉这个字符串。
        注意：这样地接收和应用一个用户输入到未更改的语句中，是非常不安全的。这会让用户能植入破坏代码，所以，要么要求字段不要允许客户输入，要么你直接来检测他的合法性 。
2.6 cache缓存

MyBatis 包含一个强在的、可配置、可定制的缓存机制。MyBatis 3 的缓存实现有了许多改进，既强劲也更容易配置。默认的情况，缓存是没有开启，除了会话缓存以外，它可以提高性能，且能解决全局依赖。开启二级缓存，你只需要在SQL 映射文件中加入简单的一行：<cache/>

这句简单的语句的作用如下：
（1）. 所有在映射文件里的select 语句都将被缓存。
（2）. 所有在映射文件里insert,update 和delete 语句会清空缓存。
（3）. 缓存使用“最近很少使用”算法来回收
（4）. 缓存不会被设定的时间所清空。
（5）. 每个缓存可以存储1024 个列表或对象的引用（不管查询出来的结果是什么）。
（6）. 缓存将作为“读/写”缓存，意味着获取的对象不是共享的且对调用者是安全的。不会有其它的调用
（7）. 者或线程潜在修改。
 
例如，创建一个FIFO 缓存让60 秒就清空一次，存储512 个对象结果或列表引用，并且返回的结果是只读。因为在不用的线程里的两个调用者修改它们可能会导致引用冲突。

<cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true">
</cache>

还可以在不同的命名空间里共享同一个缓存配置或者实例。在这种情况下，你就可以使用cache-ref 来引用另外一个缓存。
<cache-ref namespace="com.liming.manager.data.StudentMapper"/>

Cache 语句属性配置细节：