上一篇博客写的是Mybatis基础配置文件。这一篇我们来聊一聊Mybatis的映射文件。
Mybatis的mapper映射文件中有很多常用的标签,如insert
、update
、delete
、select
、resultMap
、sql
等,也会有很多属性,如resultType
、reusltMap
、parameterType
、parameterMap
、useGeneratedKeys
、keyProperty
等。相信这些在项目都有使用,但是这里还是要梳理一下(知识体系都是在不断梳理中完善和获得新知)。
下面就直入主题啦!
insert标签
<insert id="batchInsert" parameterType="com.zdydoit.dao.model.User" useGeneratedKeys="true" keyProperty="id">
insert into t_user
(
user_name,
phone,
age
)
values
(
#{userName},
#{phone},
#{age}
)
</insert>
标签的属性
属性 | 描述 |
---|---|
id | 命名空间中的唯一标识符,可被用来代表这条语句。 |
parameterType | 将要传入语句的参数的完全限定类名或别名。这个属性是可选的,因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数,默认值为 unset。 |
parameterMap | 这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。 |
flushCache | 将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:true(对应插入、更新和删除语句)。 |
timeout | 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。 |
statementType | STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。 |
useGeneratedKeys | (仅对 insert 和 update 有用)这会令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法来取出由数据库内部生成的主键(比如:像 MySQL 和 SQL Server 这样的关系数据库管理系统的自动递增字段),默认值:false。 |
keyProperty | (仅对 insert 和 update 有用)唯一标记一个属性,MyBatis 会通过 getGeneratedKeys 的返回值或者通过 insert 语句的 selectKey 子元素设置它的键值,默认:unset 。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 |
keyColumn | (仅对 insert 和 update 有用)通过生成的键值设置表中的列名,这个设置仅在某些数据库(像 PostgreSQL)是必须的,当主键列不是表中的第一列的时候需要设置。如果希望得到多个生成的列,也可以是逗号分隔的属性名称列表。 |
databaseId | 如果配置了 databaseIdProvider,MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句;如果带或者不带的语句都有,则不带的会被忽略。 |
主要属性说明
insert
标签本身没有什么可说的,这里来主要的说明一下属性。
parameterType
参数类型,指定传入参数的类型,这里使用的全类名,同样也可以使用别名(需要在配置文件配置别名规则)。useGeneratedKeys
使用自动生成主键,这个属性要和keyProperty
配合使用,用来将插入数据自动增长的id返回回来,这里还有另一种使用方式。如下:
<selectKey order="AFTER" keyProperty="id" resultType="java.lang.Integer">
SELECT LAST_INSERT_ID()
</selectKey>
这句话用在insert
标签内,insert
语句前。作用与useGeneratedKeys
和keyProperty
配置使用的效果一样。由于使用的数据库不同,对应的selectKey
标签属性和内容都是不一样的。上面的是MySQL的获取方式,下面展示一下Oracle的获取方式:
<selectKey order="BEFORE" keyProperty="id" resultType="java.lang.Integer">
SELECT SEQ_USER_ID.nextval from dual
</selectKey>
变化是在order
上和SQL语句上。order
字段,当在MySQL数据的时候,是先做数据插入再返回对应的id,当是Oracle时,是先拿到id,再做数据的插入,这是不同数据库执行的一种机制。
insert
标签下面还有类似姊妹的属性,parameterMap
是parameterType
的姊妹属性,但是实际使用是有很大差别的。在传入的参数使用Map封装的时候,就使用parameterMap
来指定,在获取的时候,直接写Map中的key就可以。但是这种方式已经很少有用的了,原因有很多。第一代码冗余,在正常的开发习惯中,涉及到多参数,业务代码中都是使用实体对象来传递,如果这里再使用Map,还要有一段实体对象转成Map集合的代码;第二维护性差,这种写法存在一定的耦合性,在别人熟悉代码的过程中很痛苦,只看接口完全不懂这个接口传入的参数,还要去看调用这个接口的业务代码,才能了解字段Map集合中到底封装的是什么内容。所以这里只是提一下,知道就好,基本没人用。
insert
其他属性,statementType
是用来指定sql执行的statement类型,这个如果对原生JDBC代码有了解的可以知道,常用的statement有PreparedStatement
、Statement
、CallableStatement
,这里就是指定使用哪一个。提供的可选值有三个CALLABLE
、PREPARED
、STATEMENT
。有兴趣的可以研究一下这个字段,这里不多说,采用默认的(PREPARED
)就好。其他的后面再总结。
select标签
在SQL语句里面,select
标签可以说是占据了半壁江山之多,而且select
标签的属性也是最多的。
<select id="11" parameterType="java.lang.Integer" resultType="com.zdydoit.dao.model.User">
select * from t_user where id = #{id}
</select>
标签的属性
属性 | 描述 |
---|---|
id | 在命名空间中唯一的标识符,可以被用来引用这条语句。 |
parameterType | 将会传入这条语句的参数类的完全限定名或别名。这个属性是可选的,因为 MyBatis 可以通过 TypeHandler 推断出具体传入语句的参数,默认值为 unset。 |
parameterMap | 这是引用外部 parameterMap 的已经被废弃的方法。使用内联参数映射和 parameterType 属性。 |
resultType | 从这条语句中返回的期望类型的类的完全限定名或别名。注意如果是集合情形,那应该是集合可以包含的类型,而不能是集合本身。使用 resultType 或 resultMap,但不能同时使用。 |
resultMap | 外部 resultMap 的命名引用。结果集的映射是 MyBatis 最强大的特性,对其有一个很好的理解的话,许多复杂映射的情形都能迎刃而解。使用 resultMap 或 resultType,但不能同时使用。 |
flushCache | 将其设置为 true,任何时候只要语句被调用,都会导致本地缓存和二级缓存都会被清空,默认值:false。 |
useCache | 将其设置为 true,将会导致本条语句的结果被二级缓存,默认值:对 select 元素为 true。 |
timeout | 这个设置是在抛出异常之前,驱动程序等待数据库返回请求结果的秒数。默认值为 unset(依赖驱动)。 |
fetchSize | 这是尝试影响驱动程序每次批量返回的结果行数和这个设置值相等。默认值为 unset(依赖驱动)。 |
statementType | STATEMENT,PREPARED 或 CALLABLE 的一个。这会让 MyBatis 分别使用 Statement,PreparedStatement 或 CallableStatement,默认值:PREPARED。 |
resultSetType | FORWARD_ONLY,SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一个,默认值为 unset (依赖驱动)。 |
databaseId | 如果配置了 databaseIdProvider,MyBatis 会加载所有的不带 databaseId 或匹配当前 databaseId 的语句;如果带或者不带的语句都有,则不带的会被忽略。 |
resultOrdered | 这个设置仅针对嵌套结果 select 语句适用:如果为 true,就是假设包含了嵌套结果集或是分组了,这样的话当返回一个主结果行的时候,就不会发生有对前面结果集的引用的情况。这就使得在获取嵌套的结果集的时候不至于导致内存不够用。默认值:false 。 |
resultSets | 这个设置仅对多结果集的情况适用,它将列出语句执行后返回的结果集并每个结果集给一个名称,名称是逗号分隔的。 |
主要属性说明
parameterType
和parameterMap
与在insert
标签内使用的方法是相同的。
resultType
结果类型,这里使用全类名,也是可以同parameterType
一样用别名,需要在配置文件中配置别名规则。这里需要详细说的是其姊妹属性resultMap
。
resultMap标签
这个标签可以用的很复杂,也可以用的很简单,这篇文章是偏重了解基础,所以只做简单的说明,后期在深入的时候再具体说其复杂的用法。
<resultMap id="base_column_map" type="com.zdydoit.dao.model.User">
<id column="id" property="id"/>
<result column="user_name" property="userName"/>
<result column="phone" property="phone"/>
<result column="age" property="age"/>
</resultMap>
最简单的写法,用id
标签指定主键,用result
标签指定各列的对应关系,不论id
还是result
标签,都有jdbcType
、javaType
、typeHandler
,这些字段都是可选字段。jdbcType
这个表示JDBC的类型,有的人习惯写,但是不写也没有影响,显然我是懒人。同样javaType
也可以不写。不过jdbcType
、javaType
这些对应关系可以在TypeHandlerRegistry
找到,可以打开这个类看一下,一目了然。
最后typeHandler
就是类型处理器,因为有的自定义类型可能在mybatis中没有对应关系,如自定义的枚举,这个时候就要手动写类型转换的处理器,需要在特定的字段上配置此处理器,但是一般用的很少,这个不多做介绍,以后有机会再单独开个博客来说说这个事。
这里再说一个子标签,那就是constructor
构造器,一般用在实体类中没有无参构造方法的时候。
<resultMap id="base_column_map" type="com.zdydoit.dao.model.User">
<constructor>
<idArg column="id" name="id"/>
<arg column="user_name" name="userName"/>
</constructor>
<result column="phone" property="phone"/>
<result column="age" property="age"/>
</resultMap>
因为在给实体类参数设值的时候,首先是要创建对象,mybatis默认的是根据无参构造方法创建,但是如果这个实体类中有有参构造方法,且没有手写无参构造,就会导致mybatis创建对象失败。所以这里提供了构造方法的标签,用来指定用那个构造方法创建对象。
sql标签
sql标签很简单,就是做SQL公共片段的抽取,就像java里面的公共代码抽取一样。如下:
<sql id="base_column">
id,user_name,phone,age
</sql>
<!-- 根据ID查询用户 -->
<select id="selectById" resultType="com.zdydoit.dao.model.User">
select <include refid="base_column"/> from t_user where id = #{id}
</select>
<!-- 根据手机号码查询用户 -->
<select id="selectByPhone" resultType="com.zdydoit.dao.model.User">
select <include refid="base_column"/> from t_user where phone = #{phone}
</select>
这样抽取以后就不需要重复的写列名了,是一种优化配置文件一种很好的方式,也很好理解。
udpate、delete标签
这两个标签没有太多的内容可说的,所用到的属性上面也都说过和列出,因为重复的东西就没有多说。