1.XML 映射器
sql映射文件的顶级元素:
select,insert,update,delete,sql,resultMap,cache,cache-ref。
1.select元素:
<select
id="getUser" //命名空间的对应的方法名称
parameterType="int" //传入的参数类的名称
resultType="User" //返回结果的类名称
resultMap="userMap"//对外部的resultMap的命名引用
flushCache="false" //默认值为false。设置true时,会每次查询都清除本地缓存和二级缓存
useCache="true" //默认值为true。设置true时,会启用本地缓存和二级缓存
timeout="2000" //超时时间
fetchSize="200" //返回的接口不能超过设置值,默认不设置。
>
2.insert元素:
<insert
id="insertUser" //命名空间的对应的方法名称
paramterType="User" //传入的参数类的名称
flushCache="true" //默认值为false。设置true时,会每次查询都清除本地缓存和二级缓存
keyProperty="" //(仅适用于 insert 和 update)实体类对应的主键的名称
keyColumn="" // (仅适用于 insert 和 update)设置生成键值在表中的列名,当主键列不是表中的第一列的时候,是必须设置的
useGeneratedKeys="" // (仅适用于 insert 和 update) 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键
timeout="2000" //超时时间
>
3.update元素:
<update
id="updateUser" //命名空间的对应的方法名称
paramterType="User" //传入的参数类的名称
flushCache="true" //默认值为false。设置true时,会每次查询都清除本地缓存和二级缓存
keyProperty="" //(仅适用于 insert 和 update)实体类对应的主键的名称
keyColumn="" // (仅适用于 insert 和 update)设置生成键值在表中的列名,当主键列不是表中的第一列的时候,是必须设置的
useGeneratedKeys="" // (仅适用于 insert 和 update) 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键
timeout="2000" //超时时间
>
4.delete元素:
<delete
id="deleteUser" //命名空间的对应的方法名称
paramterType="User" //传入的参数类的名称
flushCache="true" //默认值为false。设置true时,会每次查询都清除本地缓存和二级缓存
timeout="2000" //超时时间
>
5.sql元素:
<sql id="selectSql"
>
id,username,userpassword
</sql>
6.include元素:
<select>
select
<include refid="selectSql"></include>
from
t_sys_user
</select>
7.resultMap元素:
//resultMap以及其下级的元素
resultMap
constructor
idArg
arg
id // property,colum,jdbcType,javaType,typeHandler
result // property,colum,jdbcType,javaType,typeHandler
association
collection
discriminator
case
8.association 关联元素:
8.1.使用association的select方法:
<resultMap id="responseResultMap" type="com.lz.org.system.response.ResponseUser" >
<association
property="role"
column="user_id"
javaType="com.lz.org.system.entity.Role"
select="getRolesByUserId"
>
</association>
</resultMap>
<select id="getUserByUserId" resultMap="responseResultMap">
select *
from t_sys_user
where user_id = #{id}
</select>
<select id="getRolesByUserId" resultType="com.lz.org.system.entity.Role">
select * from t_sys_role r join t_sys_user_role ur
on r.role_id=ur.role_id and ur.user_id=#{id}
</select>
8.2.通过join连接返回嵌套结果:
<resultMap id="responseResultMap" type="com.lz.org.system.response.ResponseUser" >
<!-- 一定要写属性相关的result,否则无法显示数据或者数据为null -->
<id property="userId" column="user_id" jdbcType="BIGINT"/>
<result property="userName" column="user_name" jdbcType="VARCHAR"/>
<result property="userPassword" column="user_password" jdbcType="VARCHAR"/>
<result property="salt" column="salt" jdbcType="VARCHAR"/>
<result property="userPhone" column="user_phone" jdbcType="VARCHAR"/>
<result property="userEmai" column="user_emai" jdbcType="VARCHAR"/>
<result property="userTitle" column="user_title" jdbcType="VARCHAR"/>
<result property="createrId" column="creater_id" jdbcType="BIGINT"/>
<result property="createrName" column="creater_name" jdbcType="VARCHAR"/>
<result property="createrTime" column="creater_time" jdbcType="TIMESTAMP"/>
<result property="updaterId" column="updater_id" jdbcType="BIGINT"/>
<result property="updaterName" column="updater_name" jdbcType="VARCHAR"/>
<result property="updaterTime" column="updater_time" jdbcType="TIMESTAMP"/>
<result property="roleIds" column="role_ids" jdbcType="VARCHAR"/>
<result property="roleNames" column="role_names" jdbcType="VARCHAR"/>
<association
property="role"
column="user_id"
javaType="com.lz.org.system.entity.Role"
>
<!-- 一定要写属性相关的result,否则无法显示数据或者数据为null -->
<id property="roleId" column="role_id" jdbcType="BIGINT"/>
<result property="roleName" column="role_name" jdbcType="VARCHAR"/>
<result property="roleCode" column="role_code" jdbcType="VARCHAR"/>
<result property="createrId" column="creater_id" jdbcType="BIGINT"/>
<result property="createrName" column="creater_name" jdbcType="VARCHAR"/>
<result property="createrTime" column="creater_time" jdbcType="TIMESTAMP"/>
<result property="updaterId" column="updater_id" jdbcType="BIGINT"/>
<result property="updaterName" column="updater_name" jdbcType="VARCHAR"/>
<result property="updaterTime" column="updater_time" jdbcType="TIMESTAMP"/>
<result property="permissionIds" column="permission_ids" jdbcType="VARCHAR"/>
<result property="permissionNames" column="permission_names" jdbcType="VARCHAR"/>
</association>
</resultMap>
<select id="getUserByUserId" resultMap="responseResultMap">
select *
FROM t_sys_user AS u
INNER JOIN t_sys_user_role AS ur ON u.user_id = ur.user_id
INNER JOIN t_sys_role AS r ON u.user_id = ur.user_id AND r.role_id = ur.role_id and u.user_id=#{id};
</select>
9.collection 集合元素:
9.1.使用collection的select方法:
<resultMap id="responseResultMap" type="com.lz.org.system.response.ResponseUser" >
<collection property="roles"
column="user_id"
ofType="com.lz.org.system.entity.Role"
select="getRoleListByUserId">
</collection>
</resultMap>
<select id="getUserByUserId" resultMap="responseResultMap">
select * from t_sys_user u where u.user_id=#{id}
</select>
<select id="getRoleListByUserId" resultType="com.lz.org.system.entity.Role">
select * from t_sys_role r left join t_sys_user_role ur
on r.role_id=ur.role_id and ur.user_id=#{userId}
</select>
10.字符串替换:
参数处理:
#{age,javaType=int,jdbcType=NUMERIC}
<insert id="insertUser" parameterType="User">
insert into users (id, username, password)
values (#{id}, #{username}, #{password})
</insert>
<insert id="insertUser" parameterType="User">
insert into users (id, username, password)
values (${id}, ${username}, ${password})
</insert>
备注:
${column} 会被直接替换,而 #{value} 会使用 ? 预处理。
${column}这种方式接受用户的输入,并用作语句参数是不安全的,会导致潜在的 SQL 注入攻击。
2.动态 SQL
if
foreach
trim(where,set)
choose(when,otherwise)
2.1.if
<if test="userId!=null">
#{userId,jdbcType = BIGINT},
</if>
2.2.foreach
说明:
你可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象作为集合参数传递给 foreach。当使用可迭代对象或者数组时,index 是当前迭代的序号,item 的值是本次迭代获取到的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值
<delete id="deleteByIds">
delete from t_sys_user
where user_id in
<foreach item="item" index="index" collection="list" open="("
separator=" , " close=")">#{item}
</foreach>
</delete>
2.3.set
<set>
<if test="userName!=null and userName!=''">
user_name=#{userName,jdbcType = VARCHAR},
</if>
<if test="userPassword!=null and userPassword!=''">
user_password=#{userPassword,jdbcType = VARCHAR},
</if>
<set>
2.4.choose,when,othenwise
<select id="getUser"
resultType="User">
SELECT * FROM BLOG WHERE deteled = ‘0’
<choose>
<when test="userName != null">
AND user_name like #{userName}
</when>
<when test="phone != null">
AND phone like #{phone}
</when>
<otherwise>
AND status = 1
</otherwise>
</choose>
</select>
2.5.where
<select id="getUser"
resultType="User">
SELECT * FROM user
<where>
<if test="userName != null">
user_name = #{userName}
</if>
<if test="phone != null">
AND phone like #{phone}
</if>
<if test="email != null">
AND email like #{email}
</if>
</where>
</select>
2.5.trim
<trim prefix="WHERE" prefixOverrides="AND |OR ">
</trim>
<trim prefix="SET" suffixOverrides=",">
</trim>