Mybatis中Mapper映射文件详解

一时失言乱红尘 2022-06-16 12:08 337阅读 0赞

紧接上文所述，在这篇文章中我将对Mapper映射文件进行详细的说明。

Mapper映射文件是一个xml格式文件，必须遵循相应的dtd文件规范，如ibatis-3-mapper.dtd。我们先大体上看看支持哪些配置？如下所示，从Eclipse里截了个屏：

![Center][]

从上图可以看出，映射文件是以<mapper>作为根节点，在根节点中支持9个元素，分别为insert、update、delete、select（增删改查）;cache、cache-ref、resultMap、parameterMap、sql。

下文中，我们将首先对增删改进行描述，然后对查进行详细说明，最后对其他五个元素进行简单说明。

（1）insert、update、delete

我们先从配置文件看起：

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN" "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">  <mapper namespace="com.dy.dao.UserDao"> <insert  id="addUser"  parameterType="user"  flushCache="true"  statementType="PREPARED"  keyProperty=""  keyColumn=""  useGeneratedKeys="false"  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>

上面给出了一个比较全面的配置说明，但是在实际使用过程中并不需要都进行配置，可根据自己的需要删除部分配置项。

在这里，我列举出我自己的配置文件，精简之后是这样的：

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN" "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> <mapper namespace="com.majing.learning.mybatis.dao.UserDao"> <insert id="addUser" parameterType="user" useGeneratedKeys="true" keyProperty="id"> insert into user(name,password,age) values(#{name},#{password},#{age}) </insert> <delete id="deleteUser" parameterType="int"> delete from user where id = #{id} </delete> <update id="updateUser" parameterType="user" > update user set name = #{name}, password = #{password}, age = #{age} where id = #{id} </update> </mapper>

这里的parameterType设置成user是因为如果不设置的情况下，会自动将类名首字母小写后的名称，原来的类名为User。不过，建议大家还是使用typeAlias进行配置吧。唯一需要说明的就是<insert>元素里面的useGeneratedKeys和keyProperties属性，这两个属性是用来获取数据库中的主键的。

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

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

<selectKey  keyProperty="id"  resultType="int"  order="BEFORE"  statementType="PREPARED"> </selectKey>

针对不能使用自增长特性的数据库，可以使用下面的配置来实现相同的功能：

<insert id="insertUser" parameterType="com.dy.entity.User">  <selectKey resultType="int" order="BEFORE" keyProperty="id"> select seq_user_id.nextval as id from dual </selectKey> insert into user(id, name, password, age, deleteFlag) values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag}) </insert>

讲完了insert、update、delete，接下来我们看看用的比较多的select。

（2）select、resultType、resultMap

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

<select  id="findUserById"  parameterType="int"  resultType="User"  resultMap="userResultMap"  flushCache="false"  useCache="true"  timeout="10000"  fetchSize="256"  statementType="PREPARED"  resultSetType="FORWARD_ONLY">

我们还是从具体的示例来看看，

<select id="findUserById" resultType="User"> select * from user where id = #{id} </select>

这里我们根据用户id去查询这个用户的信息，resultType=User是一个别名，如果我们接触到的是这种一对一的问题，那么可以简单的定义一个实体，这个实体代表数据库表中的一条记录即可。但是如果我们遇到一对多的问题呢，就拿这里的查询用户信息来说，如果每个用户有各种兴趣，需要维护每个用户的兴趣信息，那么我们可能就存在下面的数据表结构：

CREATE TABLE `user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `name` varchar(255) NOT NULL, `password` varchar(255) NOT NULL, `age` int(3) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8; CREATE TABLE `userinterests` ( `userid` int(11) DEFAULT NULL, `interestid` int(11) DEFAULT NULL ) ENGINE=InnoDB DEFAULT CHARSET=utf8; CREATE TABLE `interests` ( `interestid` int(11) NOT NULL, `interestname` varchar(255) DEFAULT NULL, PRIMARY KEY (`interestid`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

其中user表用于记录用户信息，interests表用于维护所有的兴趣标签，而userinterests用于维护每个用户的兴趣情况。

这时候，如果我们需要根据用户id去查询用户的信息和兴趣信息该怎么做呢？这时候我们就要用到<select>中的另一个重要属性了，那就是resultMap。

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

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

根据上面的说明，我们来看看之前的问题怎么解决？

先截图给出三个表的数据情况：

![Center 1][]

![Center 2][]

![Center 3][]

接着，我们来定义兴趣类，并改写之前的用户实体类

package com.majing.learning.mybatis.entity; public class Interests { private int id; private String name; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } @Override public String toString() { return "Interests [id=" + id + ", name=" + name + "]"; } }

package com.majing.learning.mybatis.entity; import java.util.List; public class User2 { private int id; private String name; private String password; private int age; private List<Interests> interests; private String author; public List<Interests> getInterests() { return interests; } public void setInterests(List<Interests> interests) { this.interests = interests; } public String getAuthor() { return author; } public void setAuthor(String author) { this.author = author; } public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getPassword() { return password; } public void setPassword(String password) { this.password = password; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } @Override public String toString() { return "User2 [id=" + id + ", name=" + name + ", password=" + password + ", age=" + age + ", interests=" + interests + ", author=" + author + "]"; } }

紧接着，我们改写Dao接口：

package com.majing.learning.mybatis.dao; import com.majing.learning.mybatis.entity.User2; public interface UserDao2 { /** * 查询 * @param userId * @return */ User2 findUserById (int userId); }

然后，我们给相关实体类创建一下别名：

然后再创建一个对应跟UserDao2对应的Mapper映射文件：

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN" "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd"> <mapper namespace="com.majing.learning.mybatis.dao.UserDao2"> <resultMap type="UserWithInterests" id="UserWithInterestsMap"> <id property="id" column="id"/> <result property="name" column="name"/> <result property="password" column="password"/> <result property="age" column="age"/> <collection property="interests" column="interestname" ofType="Interests"> <id property="id" column="interestid"/> <result property="name" column="interestname"/> </collection> </resultMap> <select id="findUserById" resultMap="UserWithInterestsMap"> select a.*,c.* from user as a right join userinterests as b on a.id = b.userid right join interests as c on b.interestid = c.interestid where id = #{id} </select> </mapper>

最后将这个映射文件添加到<mappers>元素配置下：

下面我们来写个测试代码来测试一下是否可以正常运行：

public class UserDaoTest3 { @Test public void testFindUserById(){ SqlSession sqlSession = getSessionFactory().openSession(true); UserDao2 userMapper = sqlSession.getMapper(UserDao2.class); User2 user = userMapper.findUserById(10); System.out.println("记录为："+user); } // Mybatis 通过SqlSessionFactory获取SqlSession, 然后才能通过SqlSession与数据库进行交互 private static SqlSessionFactory getSessionFactory() { SqlSessionFactory sessionFactory = null; String resource = "configuration.xml"; try { sessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader(resource)); } catch (IOException e) { e.printStackTrace(); } return sessionFactory; } }

运行代码后，我们可以看到成功啦！

![Center 4][]

（3）sql

sql元素的意义，在于我们可以定义一串SQL语句，其他的语句可以通过引用它而达到复用它的目的。因为平时用到的也不多，这里就不多介绍了，感兴趣的朋友可以自行查阅资料了解一下。

（4）cache、cache-ref

关于缓存的这块逻辑还没有研究过，后面专门写篇文章针对缓存进行针对性的说明，敬请关注。

至此，关于mapper映射文件的相关配置和使用讲解的便差不多了，希望对大家有所帮助。

如果想了解我最新的博文，请关注我的博客，谢谢。如果想看到更多相关技术文章并愿意支持我继续写下去，欢迎给我打赏，对您的打赏我表示感谢。![吐舌头][tongue.gif]

![20170430151631454][]![20170430151912379][]

[Center]: /images/20220616/54cc41aefb7a4b208cfa78bc6b5fdf3d.png
[Center 1]: /images/20220616/547bf10cea494a72970087dcf236f621.png
[Center 2]: /images/20220616/c05fddbd06524be28fd90551894351c9.png
[Center 3]: /images/20220616/e43c107d084144749bbadb87e3d46e4d.png
[Center 4]: /images/20220616/919385b17e2a44349d78b5e48647b661.png
[tongue.gif]: /images/20220616/58b6e2441c7d4c7e9cdb2d0a10f72b40.png
[20170430151631454]: https://img-blog.csdn.net/20170430151631454
[20170430151912379]: /images/20220616/f1ee8fe242244cf78bf6fc1990e07ffe.png