1. Mapper XML映射文件

Posted 2021-03-30 FINANCE RETAIL

Mapper XML映射文件

MyBatis 的真正强大在于它的映射语句，它就是针对 SQL 构建的，并且比普通的方法做的更好。Mapper映射文件是一个 XML 格式文件，必须遵循相应的 dtd 文件规范。

映射文件是以 <mapper>作为根节点，在根节点中支持9个元素，分别为 insert、update、delete、select、cache、cache-ref、resultMap、parameterMap、sql。

insert、update、delete

我们先从配置文件看起：

<!-- mapper 为根元素节点， 一个namespace对应一个dao --> <mapper namespace="MailMapper">  <insert  <!-- --> <!--id （必须配置）  id是命名空间中的唯一标识符，可被用来代表这条语句  一个命名空间（namespace）对应一个dao接口 这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致 -->  id="addUser" <!--parameterType （可选配置, 默认为mybatis自动选择处理）  将要传入语句的参数的完全限定类名或别名 如果不配置，mybatis会通过ParameterHandler根据参数类型,默认选择合适的typeHandler进行处理  parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->  parameterType="user"  <!--flushCache （可选配置，默认配置为true） 将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空 默认值：true（对应插入、更新和删除语句） -->  flushCache="true"  <!--statementType （可选配置，默认配置为PREPARED）  STATEMENT，PREPARED 或 CALLABLE 的一个 这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement 默认值：PREPARED。 -->  statementType="PREPARED"  <!--keyProperty (可选配置， 默认为unset)  （仅对 insert 和 update 有用）唯一标记一个属性 MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值，默认：unset。 如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->  keyProperty=""  <!--keyColumn (可选配置)  （仅对 insert 和 update 有用）通过生成的键值设置表中的列名 这个设置仅在某些数据库（像 PostgreSQL）是必须的，当主键列不是表中的第一列的时候需要设置。 如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表。 -->  keyColumn=""  <!--useGeneratedKeys (可选配置， 默认为false)  仅对 insert 和 update 有用 这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键 比如：像 mysql 和 SQL Server 这样的关系数据库管理系统的自动递增字段，默认值：false。 -->  useGeneratedKeys="false"  <!--timeout (可选配置， 默认为unset, 依赖驱动)  这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数。默认值为 unset（依赖驱动）。 -->  timeout="20">  <update  id="updateUser"  parameterType="user"  flushCache="true"  statementType="PREPARED"  timeout="20">  <delete  id="deleteUser" parameterType="user"  flushCache="true"  statementType="PREPARED"  timeout="20"> </mapper>

上面给出了一个比较全面的配置说明，但是在实际使用过程中并不需要都进行配置，可根据自己的需要删除部分配置项。唯一需要说明的就是 <insert>元素里面的 useGeneratedKeys 和 keyProperties 属性，这两个属性是用来获取数据库中的主键的。

在数据库里面经常性的会给数据库表设置一个自增长的列作为主键，如果我们操作数据库后希望能够获取这个主键该怎么弄呢？正如上面所述，如果是支持自增长的数据库，如 mysql数据库，那么只需要设置 useGeneratedKeys 和 keyProperties属性便可以了，但是对于不支持自增长的数据库（如 oracle）该怎么办呢？

mybatis 里面在 <insert> 元素下面提供了 <selectKey> 子元素用于帮助解决这个问题。来看下配置：

<selectKey  <!-- --> <!-- selectKey 语句结果应该被设置的目标属性 如果希望得到多个生成的列，也可以是逗号分隔的属性名称列表 -->  keyProperty="id"  <!-- 结果的类型 MyBatis 通常可以推算出来，但是为了更加确定写上也不会有什么问题 MyBatis 允许任何简单类型用作主键的类型，包括字符串 如果希望作用于多个生成的列，则可以使用一个包含期望属性的 Object 或一个 Map。 --> resultType="int"  <!-- 这可以被设置为 BEFORE 或 AFTER。 如果设置为 BEFORE，那么它会首先选择主键，设置 keyProperty 然后执行插入语句 如果设置为 AFTER，那么先执行插入语句，然后是 selectKey 元素 这和像 Oracle 的数据库相似，在插入语句内部可能有嵌入索引调用。 -->  order="BEFORE"  <!-- 与前面相同 MyBatis 支持 STATEMENT，PREPARED 和 CALLABLE 语句的映射类型 分别代表 PreparedStatement 和 CallableStatement 类型。 -->  statementType="PREPARED"> </selectKey> 

select、resultType、resultMap

我们先来看看select元素都有哪些配置可以设置：

<select <!-- --> <!-- id （必须配置）  id是命名空间中的唯一标识符，可被用来代表这条语句  一个命名空间（namespace） 对应一个dao接口 这个id也应该对应dao里面的某个方法（相当于方法的实现），因此id 应该与方法名一致 -->  id="findUserById"  <!-- parameterType （可选配置, 默认为mybatis自动选择处理）  将要传入语句的参数的完全限定类名或别名 如果不配置，mybatis会通过ParameterHandler 根据参数类型默认选择合适的typeHandler进行处理  parameterType 主要指定参数类型，可以是int, short, long, string等类型，也可以是复杂类型（如对象） -->  parameterType="int"  <!-- resultType (resultType 与 resultMap 二选一配置)  resultType用以指定返回类型，指定的类型可以是基本类型，可以是java容器，也可以是javaBean -->  resultType="user"  <!-- resultMap (resultType 与 resultMap 二选一配置)  resultMap用于引用我们通过 resultMap标签定义的映射类型，这也是mybatis组件高级复杂映射的关键 -->  resultMap="userResultMap"  <!-- flushCache (可选配置)  将其设置为 true，任何时候只要语句被调用，都会导致本地缓存和二级缓存都会被清空 默认值：false -->  flushCache="false"  <!-- useCache (可选配置)  将其设置为 true，将会导致本条语句的结果被二级缓存 默认值：对 select 元素为 true -->  useCache="true"  <!-- timeout (可选配置)  这个设置是在抛出异常之前，驱动程序等待数据库返回请求结果的秒数 默认值为 unset（依赖驱动） -->  timeout="10000"  <!-- fetchSize (可选配置)  这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等 默认值为 unset（依赖驱动) -->  fetchSize="256"  <!-- statementType (可选配置)  STATEMENT，PREPARED 或 CALLABLE 的一个 这会让 MyBatis 分别使用 Statement，PreparedStatement 或 CallableStatement 默认值：PREPARED -->  statementType="PREPARED"  <!-- resultSetType (可选配置)  FORWARD_ONLY，SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个 默认值为 unset （依赖驱动）-->  resultSetType="FORWARD_ONLY">

在配置查询的返回结果时，resultType 和 resultMap 是二选一的操作。对于比较复杂的查询结果，一般都会设置成 resultMap。

resultMap 该怎么配置呢？又支持哪些配置呢？我们看看下面：

<resultMap type="" id=""> <!-- id, 唯一性 注意，这个id用于标示这个javabean对象的唯一性 不一定会是数据库的主键（不要把它理解为数据库对应表的主键）  property属性对应javabean的属性名，column对应数据库表的列名  这样，当javabean的属性与数据库对应表的列名不一致的时候，就能通过指定这个保持正常映射了  -->  <id property="" column=""/>  <!--  result与id相比， 对应普通属性 -->  <result property="" column=""/>  <!--  constructor对应javabean中的构造方法  -->  <constructor>  <!-- idArg 对应构造方法中的id参数 -->  <idArg column=""/>  <!-- arg 对应构造方法中的普通参数 -->  <arg column=""/>  </constructor>  <!--  collection，对应javabean中容器类型, 是实现一对多的关键  property 为javabean中容器对应字段名  column 为体现在数据库中列名 id select 指定关联的sql -->  <collection property="" column="" ofType="" fetchType=""></collection> <!-- 鉴别器级联 javaype为指定类型 column为指定字段 fetchType为指定延迟加载策略 --> <discriminator javaType="" column = "" fetchType="">  <!--  association 为关联关系，是实现1对1的关键。  property 为javabean中容器对应字段名  column 为体现在数据库中列名 id select 指定关联的sql -->  <association property="" column="" select="" fetchType=""></association> </resultMap>

以下是Java解析XML文件的一个方法：

private void configurationElement(XNode context) { try { String namespace = context.getStringAttribute("namespace"); if (namespace == null || namespace.equals("")) { throw new BuilderException("Mapper's namespace cannot be empty"); } builderAssistant.setCurrentNamespace(namespace); cacheRefElement(context.evalNode("cache-ref")); cacheElement(context.evalNode("cache")); parameterMapElement(context.evalNodes("/mapper/parameterMap")); resultMapElements(context.evalNodes("/mapper/resultMap")); sqlElement(context.evalNodes("/mapper/sql")); buildStatementFromContext(context.evalNodes("select|insert|update|delete")); } catch (Exception e) { throw new BuilderException("Error parsing Mapper XML. Cause: " + e, e); }}

第3行的代码获取当前 mapper 文件的 namespace，namespace 是一个很重要的属性，所有的 <sql>、<resultMap>、<insert>、<delete>、<update>、<select>标签，它们的 id 都是和 namespace 绑定的，从而确保全局的唯一性，当 namespace 未定义或者为空字符串的时候，第5行就会抛出异常，因此每个mapper文件的 namespace都是一个必填内容。

第7行的代码在 MapperBuilderAssistant 中设置了一下 namespace，这样后文可以通过 MapperBuilderAssistant 拿 namespace 而不需要每次传一个String 类型的参数。

第8行~第13行的代码分别用于解析 <cache-ref>、<cache>、<parameterMap>、<resultMap>、<sql>、<select>、<insert>、<update>、<delete> 这几个标签，逐个看一下：

1.cacheRefElement 方法用于解析 <cache-ref> 标签，总结如下：

•解析完的 CacheRef 放在 cacheRefMap 中•cacheRefMap 是一个 HashMap•位于 Configuration 对象中•Key为mapper 文件的 namespace ，Value 为 <cache-ref> 中配置的 namespace

2.cacheElement 方法用于解析 <cache> 标签，总结如下：

•会根据 <cache> 中配置的属性new出一个 org.apache.ibatis.cache.Cache•使用此 Cache 作为 MyBatis 缓存。

3.parameterMapElement 方法用于解析 <parameterMap> 标签，总结如下：

•解析完的 ParameterMap 放在 parameterMaps 中•parameterMaps 是一个 StrictMap•位于 Configuration对象中，StrictMap 是 HashMap 的子类•Key 为当前 mapper 的 namespace + "." + <parameterMap> 标签中的 id 属性，Value 为 ParameterMap 对象。

4.resultMapElements 方法用于解析 <resultMap> 标签在，总结如下：

•解析完的 ResultMap 放在 resultMaps 中•resultMaps 是一个 StrictMap•位于 Configuration 对象中•Key 为当前 mapper 的 namespace + "." + <resultMap> 标签中的id属性，Value 为 ResultMap 对象。

5.sqlElement 方法用于解析 <sql> 标签，总结如下：

•解析完的内容放在 sqlFragments 中•sqlFragments 是一个 StrictMap•位于 XMLMapperBuilder 对象中•Key为当前 mapper 的 namespace + "." + <sql> 标签中的id属性，Value 为 sql 这个 XNode 本身。

6.buildStatementFromContext 用于解析 <select>、<insert>、<update>、<delete>这四个标签，总结如下：

•解析完的内容放在 mappedStatements 中•mappedStatements 是一个 StrictMap•位于 Configuration 对象中•Key 为当前 mapper 的 namespace+"."+<select>|<insert>|<update>|<delete> 标签中的 id 属性，Value 为 MappedStatement对象.