MyBatis学习笔记三——映射配置文件

最新推荐文章于 2024-05-10 20:19:53 发布

崔同学提了个桶

最新推荐文章于 2024-05-10 20:19:53 发布

阅读量330

点赞数

本文链接：https://blog.csdn.net/Mactavish_Cui/article/details/116042595

版权

一、Mybatis映射配置文件组成

首先给出一个映射配置文件的实例

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

从中可以看出，映射配置文件与核心配置文件一样由两个部分组成，分别是用于检查语法等的头部声明，另一部分是由mapper标签包裹的配置部分，mapper标签内包含了命名空间的声明，关于全限定名和短id在简介与入门的部分已经做过介绍，包括id重复的处理等等，这里就不再赘述了，我们在此文章中只讨论关于mapper标签内部的内容。
mapper标签内可以有以下几种顶级元素

cache – 该命名空间的缓存配置。
cache-ref – 引用其它命名空间的缓存配置。
resultMap – 描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。
~~- parameterMap – 老式风格的参数映射。此元素已被废弃，并可能在将来被移除！请使用行内参数映射。文档中不会介绍此元素。~~
sql – 可被其它语句引用的可重用语句块。
insert – 映射插入语句。
update – 映射更新语句。
delete – 映射删除语句。
select – 映射查询语句。

下面就对每一种顶级元素进行介绍

二、查询语句select

Mybatis在执行插入、更新和删除操作之前会执行多个查询操作，因此查询操作是十分重要的，一个简单的select配置如下所示

<select id="selectPerson" parameterType="int" resultType="hashmap">
  SELECT * FROM PERSON WHERE ID = #{id}
</select>

select标签内部是相应的查询SQL语句，注意#{id}，他的作用是创建一个通配符？，并将？传递到预处理语句当中，当然这里使用${id}看上去也是合理的，但是他们之间存在着一些区别。

#{}是采用的预编译处理的方式，将传入的参数作为字符串，而${}则是采用字符串直接替换的方式，这就可能会引起SQL注入的问题，因此在语句中尽可能地使用#{}，而${}更多的是用作传递数据库对象，如表名等

举个很直接的例子：

@Select("select * from user where id = #{id}")
User findById(@Param("id") long id);

@Select("select * from user where name = #{name}")
User findByName(@Param("name") String name);

@Select("select * from user where email = #{email}")
User findByEmail(@Param("email") String email);

可以直接写成

@Select("select * from user where ${column} = #{value}")
User findByColumn(@Param("column") String column, @Param("value") String value);

其中 ${column} 会被直接替换，而 #{value} 会使用 ? 预处理。这样，就能完成同样的任务：

User userOfId1 = userMapper.findByColumn("id", 1L);
User userOfNameKid = userMapper.findByColumn("name", "kid");
User userOfEmail = userMapper.findByColumn("email", "noone@nowhere.com");

可以看到，表名采用了字符串直接替换的方式，保证功能的正常执行，而参数采用了通配符的方式防止sql注入攻击
#{}中除了指定名称之外还有一些属性可以设置，如指定java数据类型和JDBC数据类型，指定类处理器

#{age,javaType=int,jdbcType=NUMERIC,typeHandler=MyTypeHandler}

设置小数点保留的位数

#{height,javaType=double,jdbcType=NUMERIC,numericScale=2}

尽管上面这些选项很强大，但大多时候，你只须简单指定属性名，顶多 要为可能为空的列指定 jdbcType ，其他的事情交给 MyBatis 自己去推断就行了。

#{firstName}
#{middleInitial,jdbcType=VARCHAR}
#{lastName}

select标签还有诸多的属性可以进行配置

<select
  id="selectPerson"
  parameterType="int"
  parameterMap="deprecated"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">

在这里插入图片描述
statementType中采用STATEMENT是直接操作sql，使用$直接进行字符串的替换，而默认的PREPARED则是采用预编译占位符的方式，CALLABLE则是执行存储过程（存储过程是为了完成特定功能的SQL语句集，经编译创建并保存在数据库中，用户可通过指定存储过程的名字并给定参数(需要时)来调用执行）

三、数据变更语句insert、update、delete

三个语句的实现是非常接近的

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">

<update
  id="updateAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="deleteAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

相关的设置如下
在这里插入图片描述
这里注意以下自动生成主键的使用如果你的数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），那么你可以设置 useGeneratedKeys=”true”，然后再把 keyProperty 设置为目标属性就 OK 了。例如，如果上面的 Author 表已经在 id 列上使用了自动生成，那么语句可以修改为：

<insert id="insertAuthor" useGeneratedKeys="true" keyProperty="id">
  insert into Author (username,password,email,bio)
  values (#{username},#{password},#{email},#{bio})
</insert>

如果你的数据库还支持多行插入, 你也可以传入一个 Author 数组或集合，并返回自动生成的主键。

<insert id="insertAuthor" useGeneratedKeys="true"
    keyProperty="id">
  insert into Author (username, password, email, bio) values
  <foreach item="item" collection="list" separator=",">
    (#{item.username}, #{item.password}, #{item.email}, #{item.bio})
  </foreach>
</insert>

四、可复用语句sql

这个元素可以用来定义可重用的 SQL 代码片段，以便在其它语句中使用。参数可以静态地（在加载的时候）确定下来，并且可以在不同的 include 元素中定义不同的参数值。比如：

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

这个 SQL 片段可以在其它语句中使用，例如：

<select id="selectUsers" resultType="map">
  select
    <include refid="userColumns"><property name="alias" value="t1"/></include>,
    <include refid="userColumns"><property name="alias" value="t2"/></include>
  from some_table t1
    cross join some_table t2
</select>

也可以在 include 元素的 refid 属性或内部语句中使用属性值，例如：

<sql id="sometable">
  ${prefix}Table
</sql>

<sql id="someinclude">
  from
    <include refid="${include_target}"/>
</sql>

<select id="select" resultType="map">
  select
    field1, field2, field3
  <include refid="someinclude">
    <property name="prefix" value="Some"/>
    <property name="include_target" value="sometable"/>
  </include>
</select>

五、结果映射resultMap

这里给出一个resultMap标签的实例

<resultMap id="userResultMap" type="com.cui.User">
  <id property="id" column="user_id" />
  <result property="username" column="user_name"/>
  <result property="password" column="hashed_password"/>
</resultMap>

resultMap标签有三个属性，分别是id、type和autoMapping，其他标签可以通过resultMap等于此id来引用这一映射关系，而type则指向了一个javaBean类（注意要使用全路径名），如果设置autoMapping，MyBatis 将会为本结果映射开启或者关闭自动映射。resultMap标签中有id和result标签，其中的property对应了javabean中的属性字段，而column就对应了数据库中的字段。
这是一个引用的方式

<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

除了id和result之外，这里还有一些其他的标签可以设置

<!-- 非常复杂的结果映射 -->
<resultMap id="detailedBlogResultMap" type="Blog">
  <constructor>
    <idArg column="blog_id" javaType="int"/>
  </constructor>
  <result property="title" column="blog_title"/>
  <association property="author" javaType="Author">
    <id property="id" column="author_id"/>
    <result property="username" column="author_username"/>
    <result property="password" column="author_password"/>
    <result property="email" column="author_email"/>
    <result property="bio" column="author_bio"/>
    <result property="favouriteSection" column="author_favourite_section"/>
  </association>
  <collection property="posts" ofType="Post">
    <id property="id" column="post_id"/>
    <result property="subject" column="post_subject"/>
    <association property="author" javaType="Author"/>
    <collection property="comments" ofType="Comment">
      <id property="id" column="comment_id"/>
    </collection>
    <collection property="tags" ofType="Tag" >
      <id property="id" column="tag_id"/>
    </collection>
    <discriminator javaType="int" column="draft">
      <case value="1" resultType="DraftPost"/>
    </discriminator>
  </collection>
</resultMap>

在这里插入图片描述
下面来对每一个标签进行详细的介绍

5.1、id & result

<id property="id" column="post_id"/>
<result property="subject" column="post_subject"/>

这些元素是结果映射的基础。id 和 result 元素都将一个列的值映射到一个简单数据类型（String, int, double, Date 等）的属性或字段。

这两者之间的唯一不同是，id 元素对应的属性会被标记为对象的标识符，在比较对象实例时使用。这样可以提高整体的性能，尤其是进行缓存和嵌套结果映射（也就是连接映射）的时候。

两个元素都有一些属性：
在这里插入图片描述

5.2、构造方法Constructor

通过修改对象属性的方式，可以满足大多数的数据传输对象（Data Transfer Object, DTO）以及绝大部分领域模型的要求。但有些情况下你想使用不可变类。一般来说，很少改变或基本不变的包含引用或数据的表，很适合使用不可变类。构造方法注入允许你在初始化时为类设置属性的值，而不用暴露出公有方法。MyBatis 也支持私有属性和私有 JavaBean 属性来完成注入，但有一些人更青睐于通过构造方法进行注入。 constructor 元素就是为此而生的。

看看下面这个构造方法:

public class User {
   //...
   public User(Integer id, String username, int age) {
     //...
  }
//...
}

为了将结果注入构造方法，MyBatis 需要通过某种方式定位相应的构造方法。在下面的例子中，MyBatis 搜索一个声明了三个形参的构造方法，参数类型以 java.lang.Integer, java.lang.String 和 int 的顺序给出。

<constructor>
   <idArg column="id" javaType="int"/>
   <arg column="username" javaType="String"/>
   <arg column="age" javaType="_int"/>
</constructor>

当你在处理一个带有多个形参的构造方法时，很容易搞乱 arg 元素的顺序。从版本 3.4.3 开始，可以在指定参数名称的前提下，以任意顺序编写 arg 元素。为了通过名称来引用构造方法参数，你可以添加 @Param 注解，或者使用 ‘-parameters’ 编译选项并启用 useActualParamName 选项（默认开启）来编译项目。下面是一个等价的例子，尽管函数签名中第二和第三个形参的顺序与 constructor 元素中参数声明的顺序不匹配。

<constructor>
   <idArg column="id" javaType="int" name="id" />
   <arg column="age" javaType="_int" name="age" />
   <arg column="username" javaType="String" name="username" />
</constructor>

5.3、关联association

关联用于处理一个有“类型”的关系，比如Blog类有一个Author字段，这种并非基本数据类型的字段在resultMap中的映射就需要使用关联了，下面给出一个关联的典型实例

    <resultMap id="BaseResultMap" type="com.cui.domain.store.Catalog">
        <id column="id" jdbcType="VARCHAR" property="id"/>
        <result column="name" jdbcType="VARCHAR" property="name"/>
        <result column="remark" jdbcType="VARCHAR" property="remark"/>
        <result column="state" jdbcType="VARCHAR" property="state"/>
        <result column="course_id" jdbcType="VARCHAR" property="courseId"/>
        <result column="create_time" jdbcType="TIMESTAMP" property="createTime"/>
        <association property="course" column="course_id" javaType="com.cui.domain.store.Course"
                     select="com.cui.dao.store.CourseDao.findById"></association>
    </resultMap>

其中的属性有这样几个
在这里插入图片描述

其中需要重点注意的是property、column、select和javaType四项，property和column的含义与id以及result标签是一致的，都分别代表了bean对象中的字段名称和数据库中存储的字段名称。
较为独特的是select和javaType两项，而javaType代表了属性对应的java类，这一类在bean中可以明确，而select指向的是select语句的查询方法的id，向这个id传递的参数就是column

5.6、集合collection

集合与关联基本一致，只是javaType指向了集合的类，而ofType属性指向了集合中存储的元素的类型，下面给出collection的使用实例

        <collection
            property="questionItemList"
            javaType="java.util.List"
            ofType="com.cui.domain.store.QuestionItem"
            select="com.cui.dao.store.QuestionItemDao.findByQuestionId"
            column="id"
        />

5.7、自动映射

所谓自动映射，就是将数据库中的字段查询出来，将其赋值给同名的bean类对象的属性字段当中（不区分大小写），在下面的例子中，id 和 userName 列将被自动映射，hashed_password 列将根据配置进行映射

<select id="selectUsers" resultMap="userResultMap">
  select
    user_id             as "id",
    user_name           as "userName",
    hashed_password
  from some_table
  where id = #{id}
</select>

<resultMap id="userResultMap" type="User">
  <result property="password" column="hashed_password"/>
</resultMap>

自动映射的开关在核心配置文件的setting中可以进行设置，有三种等级

NONE - 禁用自动映射。仅对手动映射的属性进行映射。
PARTIAL 对除在内部定义了嵌套结果映射（也就是连接的属性）以外的属性进行映射
FULL - 自动映射所有属性。

默认是PARTIAL，无论设置的自动映射等级是哪种，你都可以通过在结果映射resultMap上设置 autoMapping 属性来true或dalse为指定的结果映射设置启用/禁用自动映射。

六、缓存cache

MyBatis 内置了一个强大的事务性查询缓存机制，它可以非常方便地配置和定制。为了使它更加强大而且易于配置，我们对 MyBatis 3 中的缓存实现进行了许多改进。

默认情况下，只启用了本地的会话缓存，它仅仅对一个会话中的数据进行缓存。要启用全局的二级缓存，只需要在你的 SQL 映射文件中添加一行：

<cache/>

基本上就是这样。这个简单语句的效果如下:

映射语句文件中的所有 select 语句的结果将会被缓存。
映射语句文件中的所有 insert、update 和 delete 语句会刷新缓存。
缓存会使用最近最少使用算法（LRU, Least Recently Used）算法来清除不需要的缓存。
缓存不会定时进行刷新（也就是说，没有刷新间隔）。
缓存会保存列表或对象（无论查询方法返回哪种）的 1024 个引用。
缓存会被视为读/写缓存，这意味着获取到的对象并不是共享的，可以安全地被调用者修改，而不干扰其他调用者或线程所做的潜在修改。

缓存只作用于 cache 标签所在的映射文件中的语句。如果你混合使用 Java API 和 XML 映射文件，在共用接口中的语句将不会被默认缓存。你需要使用 @CacheNamespaceRef 注解指定缓存作用域。

这些属性可以通过 cache 元素的属性来修改。比如：

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

这个更高级的配置创建了一个 FIFO 缓存，每隔 60 秒刷新，最多可以存储结果对象或列表的 512 个引用，而且返回的对象被认为是只读的，因此对它们进行修改可能会在不同线程中的调用者产生冲突。

可用的清除策略有：

LRU – 最近最少使用：移除最长时间不被使用的对象。
FIFO – 先进先出：按对象进入缓存的顺序来移除它们。
SOFT – 软引用：基于垃圾回收器状态和软引用规则移除对象。
WEAK – 弱引用：更积极地基于垃圾收集器状态和弱引用规则移除对象。

默认的清除策略是 LRU。

flushInterval（刷新间隔）属性可以被设置为任意的正整数，设置的值应该是一个以毫秒为单位的合理时间量。默认情况是不设置，也就是没有刷新间隔，缓存仅仅会在调用语句时刷新。

size（引用数目）属性可以被设置为任意正整数，要注意欲缓存对象的大小和运行环境中可用的内存资源。默认值是 1024。

readOnly（只读）属性可以被设置为 true 或 false。只读的缓存会给所有调用者返回缓存对象的相同实例。因此这些对象不能被修改。这就提供了可观的性能提升。而可读写的缓存会（通过序列化）返回缓存对象的拷贝。速度上会慢一些，但是更安全，因此默认值是 false。
除此之外，还可以自定义缓存

崔同学提了个桶

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
MyBatis学习笔记三——映射配置文件

一、Mybatis映射配置文件组成首先给出一个映射配置文件的实例<?xml version="1.0" encoding="UTF-8" ?><!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="org.mybatis.example.BlogMapper">
复制链接

扫一扫