MyBatis之SQL语句映射文件增删改查和Java参数如何对应

转载 http://limingnihao.iteye.com/blog/781911

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 语句属性配置细节：

属性     描述     取值     默认

id     在这个模式下唯一的标识符，可被其它语句引用         

parameterType     传给此语句的参数的完整类名或别名         

resultType     语句返回值类型的整类名或别名。注意，如果是集合，那么这里填写的是集合的项的整类名或别名，而不是集合本身的类名。（resultType 与resultMap 不能并用）         

resultMap     引用的外部resultMap 名。结果集映射是MyBatis 中最强大的特性。许多复杂的映射都可以轻松解决。（resultType 与resultMap 不能并用）         

flushCache     如果设为true，则会在每次语句调用的时候就会清空缓存。select 语句默认设为false     true|false     false

useCache     如果设为true，则语句的结果集将被缓存。select 语句默认设为false true|false false

timeout      设置驱动器在抛出异常前等待回应的最长时间，默认为不设值，由驱动器自己决定     正整数     未设置

fetchSize     设置一个值后，驱动器会在结果集数目达到此数值后，激发返回，默认为不设值，由驱动器自己决定     正整数     驱动器决定

statementType     statement，preparedstatement，callablestatement。

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语句属性配置细节：

属性     描述     取值     默认

id     在这个模式下唯一的标识符，可被其它语句引用         

parameterType     传给此语句的参数的完整类名或别名         

flushCache     如果设为true，则会在每次语句调用的时候就会清空缓存。select 语句默认设为false     true|false     false

useCache     如果设为true，则语句的结果集将被缓存。select 语句默认设为false true|false false

timeout      设置驱动器在抛出异常前等待回应的最长时间，默认为不设值，由驱动器自己决定     正整数     未设置

fetchSize     设置一个值后，驱动器会在结果集数目达到此数值后，激发返回，默认为不设值，由驱动器自己决定     正整数     驱动器决定

statementType      STATEMENT,PREPARED,CALLABLE     PREPARED

useGeneratedKeys     告诉MyBatis 使用JDBC 的getGeneratedKeys 方法来获取数据库自己生成的主键（MySQL、SQLSERVER 等

关系型数据库会有自动生成的字段）。默认：false  true|false     false

keyProperty     

标识一个将要被MyBatis 设置进getGeneratedKeys 的key 所返回的值，或者为insert 语句使用一个selectKey子元素。

selectKey语句属性配置细节：

属性     描述     取值

keyProperty     selectKey 语句生成结果需要设置的属性。     

resultType     生成结果类型，MyBatis 允许使用基本的数据类型，包括String 、int类型。     

order     可以设成BEFORE 或者AFTER，如果设为BEFORE，那它会先选择主键，然后设置keyProperty，再执行insert语句；如果设为AFTER，它就先运行insert 语句再运行selectKey 语句，通常是insert 语句中内部调用数据库（像Oracle）内嵌的序列机制。      BEFORE

AFTER

statementType     像上面的那样， MyBatis 支持STATEMENT，PREPARED和CALLABLE 的语句形式， 对应Statement ，PreparedStatement 和CallableStatement 响应     STATEMENT,PREPARED,CALLABLE

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语句属性配置细节：

属性     描述     取值     默认

id     在这个模式下唯一的标识符，可被其它语句引用         

parameterType     传给此语句的参数的完整类名或别名         

flushCache     如果设为true，则会在每次语句调用的时候就会清空缓存。select 语句默认设为false     true|false     false

useCache     如果设为true，则语句的结果集将被缓存。select 语句默认设为false true|false false

timeout 设置驱动器在抛出异常前等待回应的最长时间，默认为不设值，由驱动器自己决定     true|false     false

timeout      设置驱动器在抛出异常前等待回应的最长时间，默认为不设值，由驱动器自己决定     正整数     未设置

fetchSize     设置一个值后，驱动器会在结果集数目达到此数值后，激发返回，默认为不设值，由驱动器自己决定     正整数     驱动器决定

statementType     statement，preparedstatement，callablestatement。

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>

parameters

        上面很多地方已经用到了参数，比如查询、修改、删除的条件，插入，修改的数据等，MyBatis可以使用的基本数据类型和Java的复杂数据类型。

        基本数据类型，String，int，date等。

        但是使用基本数据类型，只能提供一个参数，所以需要使用Java实体类，或Map类型做参数类型。通过#{}可以直接得到其属性。

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

2Java实体类型参数

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

<!-- 查询学生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());
}

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

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>

进行查询：Java代码

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

5字符串代入法

        默认的情况下，使用#{}语法会促使MyBatis 生成PreparedStatement 属性并且使用PreparedStatement 的参数（=？）来安全的设置值。尽量这些是快捷安全，也是经常使用的。但有时候你可能想直接未更改的字符串代入到SQL 语句中。比如说，对于ORDER BY，你可能会这样使用：ORDER BY ${columnName}但MyBatis 不会修改和规避掉这个字符串。

        注意：这样地接收和应用一个用户输入到未更改的语句中，是非常不安全的。这会让用户能植入破坏代码，所以，要么要求字段不要允许客户输入，要么你直接来检测他的合法性 。