Mybatis映射的XML文件

程序员文章站 2022-04-20 11:13:30

...

Mybatis映射的XML文件

MyBatis真正的力量是在映射语句中。这里是奇迹发生的地方。对于所有的力量，SQL映射的XML文件是相当的简单。当然如果你将它们和对等功能的JDBC代码来比较，你会发现映射文件节省了大约95%的代码量。MyBatis的构建就是聚焦于SQL的，使其远离于普通的方式。

SQL映射文件有很少的几个*元素（按照它们应该被定义的顺序）：

 cache - 配置给定命名空间的缓存。

 cache-ref – 从其他命名空间引用缓存配置。

 resultMap – 最复杂，也是最有力量的元素，用来描述如何从数据库结果集中来加载你的对象。

 parameterMap – 已经被废弃了！老式风格的参数映射。内联参数是首选，这个元素可能在将来被移除。这里不会记录。

 sql – 可以重用的SQL块，也可以被其他语句引用。

 insert – 映射插入语句

 update – 映射更新语句

 delete – 映射删除语句

 select – 映射查询语句

下一部分将从语句本身开始来描述每个元素的细节。

select

查询语句是使用MyBatis时最常用的元素之一。直到你从数据库取出数据时才会发现将数据存在数据库中是多么的有价值，所以许多应用程序的查询操作要比更改数据操作多的多。对于每次插入，更新或删除，那也会有很多的查询。这是MyBatis的一个基本原则，也是将重心和努力放到查询和结果映射的原因。对简单类别的查询元素是非常简单的。比如：

SELECT * FROM PERSON WHERE ID = #{id}

</select>

这个语句被称作selectPerson，使用一个int（或Integer）类型的参数，并返回一个HashMap类型的对象，其中的键是列名，值是列对应的值。

注意参数注释：

#{id}

这就告诉MyBatis创建一个PreparedStatement（预处理语句）参数。使用JDBC，这样的一个参数在SQL中会由一个“?”来标识，并被传递到一个新的预处理语句中，就像这样：

// 相似的JDBC代码，不是MyBatis的

String selectPerson = “SELECT * FROM PERSON WHERE ID=?”;

PreparedStatement ps = conn.prepareStatement(selectPerson);

ps.setInt(1,id);

当然，这需要很多单独的JDBC的代码来提取结果并将它们映射到对象实例中，这就是MyBatis节省你时间的地方。我们需要深入了解参数和结果映射。那些细节部分我们下面来了解。

select元素有很多属性允许你配置，来决定每条语句的作用细节。

<select

id=”selectPerson”

parameterType=”int”

parameterMap=”deprecated”

resultType=”hashmap”

resultMap=”personResultMap”

flushCache=”false”

useCache=”true”

timeout=”10000”

fetchSize=”256”

statementType=”PREPARED”

resultSetType=”FORWARD_ONLY”

insert，update，delete

数据修改语句insert，update和delete在它们的实现中非常相似：

<insert

id="insertAuthor"

parameterType="domain.blog.Author"

flushCache="true"

statementType="PREPARED"

keyProperty=""

useGeneratedKeys=""

timeout="20000">

<update

id="insertAuthor"

parameterType="domain.blog.Author"

flushCache="true"

statementType="PREPARED"

timeout="20000">

<delete

id="insertAuthor"

parameterType="domain.blog.Author"

flushCache="true"

statementType="PREPARED"

timeout="20000">

下面就是insert，update和delete语句的示例：

insert into Author (id,username,password,email,bio)

values (#{id},#{username},#{password},#{email},#{bio})

</insert>

update Author set

username = #{username},

password = #{password},

email = #{email},

bio = #{bio}

where id = #{id}

</update>

delete from Author where id = #{id}

</delete>

如前所述，插入语句有一点多，它有一些属性和子元素用来处理主键的生成。

首先，如果你的数据库支持自动生成主键的字段（比如MySQL和SQL Server数据库），那么你可以设置useGeneratedKeys=”true”，而且设置keyProperty到你已经做好的目标属性上。例如，如果上面的Author表已经对id使用了自动生成的列类型，那么语句可以修改为：

<insert id="insertAuthor" parameterType="domain.blog.Author"

useGeneratedKeys=”true” keyProperty=”id”>

insert into Author (username,password,email,bio)

values (#{username},#{password},#{email},#{bio})

</insert>

sql

这个元素可以被用来定义可重用的SQL代码段，可以包含在其他语句中。比如：

<sql id=”userColumns”> id,username,password </sql>

这个SQL片段可以被包含在其他语句中，例如：

select <include refid=”userColumns”/>

from some_table

where id = #{id}

</select>

Parameters

在之前的语句中，你已经看到了一些简单参数的示例。在MyBatis中参数是非常强大的元素。对于简单的做法，大概90%的情况，是不用太多的，比如：

select id, username, password

from users

where id = #{id}

</select>

上面的这个示例说明了一个非常简单的命名参数映射。参数类型被设置为“int”，因此这个参数可以被设置成任何内容。原生的类型或简单数据类型，比如整型和没有相关属性的字符串，因此它会完全用参数来替代。然而，如果你传递了一个复杂的对象，那么MyBatis的处理方式就会有一点不同。比如：

insert into users (id, username, password)

values (#{id}, #{username}, #{password})

</insert>

如果User类型的参数对象传递到了语句中，id、username和password属性将会被查找，然后它们的值就被传递到预处理语句的参数中。

这点对于传递参数到语句中非常好。但是对于参数映射也有一些其他的特性。

首先，像MyBatis的其他部分，参数可以指定一个确定的数据类型。

#{property,javaType=int,jdbcType=NUMERIC}

像MyBatis的剩余部分，javaType通常可以从参数对象中来确定，除非对象是一个HashMap。那么javaType应该被确定来保证使用正确类型处理器。

注意：如果null被当作值来传递，对于所有可能为空的列，JDBC Type是需要的。也可以通过阅读PreparedStatement. setNull()方法的JavaDocs文档来研究它。

为了以后自定义类型处理器，你可以指定一个确定的类型处理器类（或别名），比如：

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

尽管它看起来繁琐，但是实际上是你很少设置它们其中之一。

对于数值类型，对于决定有多少数字是相关的，有一个数值范围。

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

最后，mode属性允许你指定IN，OUT或INOUT参数。如果参数为OUT或INOUT，参数对象属性的真实值将会被改变，就像你期望你需要你个输出参数。如果mode为OUT（或INOUT），而且jdbcType为CURSOR（也就是Oracle的REFCURSOR），你必须指定一个resultMap来映射结果集到参数类型。要注意这里的javaType属性是可选的，如果左边的空白是jdbcType的CURSOR类型，它会自动地被设置为结果集。

#{department,

mode=OUT,

jdbcType=CURSOR,

javaType=ResultSet,

resultMap=departmentResultMap}

MyBatis也支持很多高级的数据类型，比如结构体，但是当注册out参数时你必须告诉语句类型名称。比如（再次提示，在实际中不要像这样换行）：

#{middleInitial,

mode=OUT,

jdbcType=STRUCT,

jdbcTypeName=MY_TYPE,

resultMap=departmentResultMap}

尽管所有这些强大的选项很多时候你只简单指定属性名，MyBatis会自己计算剩余的。最多的情况是你为jdbcType指定可能为空的列名。

#{firstName}

#{middleInitial,jdbcType=VARCHAR}

#{lastName}

字符串替换

默认情况下，使用#{}格式的语法会导致MyBatis创建预处理语句属性并以它为背景设置安全的值（比如?）。这样做很安全，很迅速，也是首选的做法，有时你只是想直接在SQL语句中插入一个不改变的字符串。比如，像ORDER BY，你可以这样来使用：

ORDER BY ${columnName}

这里MyBatis不会修改或转义字符串。

重要：接受从用户输出的内容并提供给语句中不变的字符串，这样做是不安全的。这会导致潜在的SQL注入攻击，因此你不应该允许用户输入这些字段，或者通常自行转义并检查。

resultMap

resultMap元素是MyBatis中最重要最强大的元素。它就是让你远离90%的需要从结果集中取出数据的JDBC代码的那个东西，而且在一些情形下允许你做一些JDBC不支持的事情。事实上，编写相似于对复杂语句联合映射这些等同的代码，也许可以跨过上千行的代码。ResultMap的设计就是简单语句不需要明确的结果映射，而很多复杂语句确实需要描述它们的关系。

你已经看到简单映射语句的示例了，但没有明确的resultMap。比如：

select id, username, hashedPassword

from some_table

where id = #{id}

</select>

这样一个语句简单作用于所有列被自动映射到HashMap的键上，这由resultType属性指定。这在很多情况下是有用的，但是HashMap不能很好描述一个领域模型。那样你的应用程序将会使用JavaBeans或POJOs（Plain Old Java Objects，普通Java对象）来作为领域模型。MyBatis对两者都支持。看看下面这个JavaBean：

package com.someapp.model;

public class User {

private int id;

private String username;

private String hashedPassword;

public int getId() {

return id;

}

public void setId(int id) {

this.id = id;

}

public String getUsername() {

return username;

}

public void setUsername(String username) {

this.username = username;

}

public String getHashedPassword() {

return hashedPassword;

}

public void setHashedPassword(String hashedPassword) {

this.hashedPassword = hashedPassword;

}

基于JavaBean的规范，上面这个类有3个属性：id，username和hashedPassword。这些在select语句中会精确匹配到列名。

这样的一个JavaBean可以被映射到结果集，就像映射到HashMap一样简单。

<select id=”selectUsers” parameterType=”int”

resultType=”com.someapp.model.User”>

select id, username, hashedPassword

from some_table

where id = #{id}

</select>

要记住类型别名是你的伙伴。使用它们你可以不用输入类的全路径。比如：

<select id=”selectUsers” parameterType=”int”

resultType=”User”>

select id, username, hashedPassword

from some_table

where id = #{id}

</select>

这些情况下，MyBatis会在幕后自动创建一个ResultMap，基于属性名来映射列到JavaBean的属性上。如果列名没有精确匹配，你可以在列名上使用select字句的别名（一个标准的SQL特性）来匹配标签。比如：

select

user_id as “id”,

user_name as “userName”,

hashed_password as “hashedPassword”

from some_table

where id = #{id}

</select>

ResultMap最优秀的地方你已经了解了很多了，但是你还没有真正的看到一个。这些简单的示例不需要比你看到的更多东西。只是出于示例的原因，让我们来看看最后一个示例中外部的resultMap是什么样子的，这也是解决列名不匹配的另外一种方式。

</resultMap>

引用它的语句使用resultMap属性就行了（注意我们去掉了resultType属性）。比如：

<select id=”selectUsers” parameterType=”int”

resultMap=”userResultMap”>

select user_id, user_name, hashed_password

from some_table

where id = #{id}

</select>

如果世界总是这么简单就好了。

高级结果映射

MyBatis创建的一个想法：数据库不用永远是你想要的或需要它们是什么样的。而我们最喜欢的数据库最好是第三范式或BCNF范式，但它们有时不是。如果可能有一个单独的数据库映射，所有应用程序都可以使用它，这是非常好的，但有时也不是。结果映射就是MyBatis提供处理这个问题的答案。

比如，我们如何映射下面这个语句？

<select id="selectBlogDetails" parameterType="int"

resultMap="detailedBlogResultMap">

select

B.id as blog_id,

B.title as blog_title,

B.author_id as blog_author_id,

A.id as author_id,

A.username as author_username,

A.password as author_password,

A.email as author_email,

A.bio as author_bio,

A.favourite_section as author_favourite_section,

P.id as post_id,

P.blog_id as post_blog_id,

P.author_id as post_author_id,

P.created_on as post_created_on,

P.section as post_section,

P.subject as post_subject,

P.draft as draft,

P.body as post_body,

C.id as comment_id,

C.post_id as comment_post_id,

C.name as comment_name,

C.comment as comment_text,

T.id as tag_id,

T.name as tag_name

from Blog B

left outer join Author A on B.author_id = A.id

left outer join Post P on B.id = P.blog_id

left outer join Comment C on P.id = C.post_id

left outer join Post_Tag PT on PT.post_id = P.id

left outer join Tag T on PT.tag_id = T.id

where B.id = #{id}

</select>

你可能想把它映射到一个智能的对象模型，包含一个作者写的博客，有很多的博文，每篇博文有零条或多条的评论和标签。下面是一个完整的复杂结果映射例子（假设作者，博客，博文，评论和标签都是类型的别名）。我们来看看，但是不用紧张，我们会一步一步来说明。当天最初它看起来令人生畏，但实际上非常简单。

</constructor>

</association>

</collection>

</collection>

</discriminator>

</collection>

</resultMap>

resultMap元素有很多子元素和一个值得讨论的结构。下面是resultMap元素的概念视图

resultMap

 constructor – 类在实例化时，用来注入结果到构造方法中

 idArg – ID参数；标记结果作为ID可以帮助提高整体效能

 arg – 注入到构造方法的一个普通结果

 id – 一个ID结果；标记结果作为ID可以帮助提高整体效能

 result – 注入到字段或JavaBean属性的普通结果

 association – 一个复杂的类型关联；许多结果将包成这种类型

 嵌入结果映射 – 结果映射自身的关联，或者参考一个

 collection – 复杂类型的集

 嵌入结果映射 – 结果映射自身的集，或者参考一个

 discriminator – 使用结果值来决定使用哪个结果映射

 case – 基于某些值的结果映射

 嵌入结果映射 – 这种情形结果也映射它本身，因此可以包含很多相同的元素，或者它可以参照一个外部的结果映射。

最佳实践：通常逐步建立结果映射。单元测试的真正帮助在这里。如果你尝试创建一次创建一个向上面示例那样的巨大的结果映射，那么可能会有错误而且很难去控制它来工作。开始简单一些，一步一步的发展。而且要进行单元测试！使用该框架的缺点是它们有时是黑盒（是否可见源代码）。你确定你实现想要的行为的最好选择是编写单元测试。它也可以你帮助得到提交时的错误。

下面一部分将详细说明每个元素。

相关标签： Mybatis 映射 XML文件

上一篇：求教mac上面自己配置的nginx+php，安装phalcon之后怎么配置？

下一篇： ICE之Application 和 slice到C++映射

Mybatis映射的XML文件

JAVA中4种解析XML文件的方法

C#中将xml文件反序列化为实例时采用基类还是派生类的知识点讨论

c# 通过内存映射实现文件共享内存的示例代码

由于扩展配置问题而无法提供您请求的页面。如果该页面是脚本，请添加处理程序。如果应下载文件，请添加 MIME 映射。

JS实现加载和读取XML文件的方法详解

MyBatis学习总结（二）——MyBatis核心配置文件与输入输出映射

Winform中对xml文件进行保存时空白节点自动换行问题的解决

mmap - 内存映射文件 - 减少一次内核空间内数据向用户空间数据拷贝的操作

MyBatis 映射文件配置详解

C#中使用XmlDocument类来创建和修改XML格式的数据文件