MyBatis框架学习笔记（三）：MyBatis重要文件详解：配置文件与映射文件

1 mybatis-config.xml-配置文件详解

1.1 说明 

（1）mybatis 的核心配置文件(mybatis-config.xml)，比如配置 jdbc 连接信息，注册 mapper 等等都是在这个文件中进行配置,我们需要对这个配置文件有详细的了解

（2）文档地址: mybatis – MyBatis 3 | 配置

1.2 properties 属性 

通过该属性，可以指定一个外部的 jdbc.properties 文件，引入我们的 jdbc 连接信息 

案例演示 

（1）创建 src\main\resources\jdbc.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
jdbc.user=root
jdbc.pwd=123456

（2）修改 mybatis-confing.xml 

 注意：配置文件中元素的顺序一定要和规定的顶层结构相同

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">

<configuration>
    
    <properties resource="jdbc.properties">

    </properties>

    <settings>
    </settings>

    <typeAliases>
   </typeAliases>

    <environments default="development">
        <environment id="development">
            <!--配置事务管理器-->
            <transactionManager type="JDBC"/>
            <!--配置数据源-->
            <dataSource type="POOLED">
                <property name="driver" value="${jdbc.driver}"/>
                <property name="url" value="${jdbc.url}"/>
                <property name="username" value="${jdbc.user}"/>
                <property name="password" value="${jdbc.pwd}"/>
            </dataSource>
        </environment>
    </environments>
    <!--
    1. 这里我们配置需要关联的Mapper.xml
    2. 这里我们可以通过菜单 Path from source root
    -->
    <mappers>
        <mapper resource="com/mapper/MonsterMapper.xml"/>
        <mapper resource="com/mapper/MonkMapper.xml"/>
        <mapper class="com.mapper.MonsterAnnotation"/>
    </mappers>
</configuration>

（3）修改父项目的 pom.xml(如果已经配置了*.properties 就不用再配置) 并完成测试 

1.3 settings 全局参数定义 

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。 （具体可查看文档）

1.4 typeAliases 别名处理器

（1）别名是为 Java 类型命名一个短名字。它只和 XML 配置有关，用来减少类名重复的部分

（2）如果指定了别名,我们的 MappperXxxx.xml 文件就可以做相应的简化处理

（3）注意指定别名后，还是可以使用全名的

 例如：

<typeAliases>
  <typeAlias alias="Author" type="domain.blog.Author"/>
  <typeAlias alias="Blog" type="domain.blog.Blog"/>
  <typeAlias alias="Comment" type="domain.blog.Comment"/>
  <typeAlias alias="Post" type="domain.blog.Post"/>
  <typeAlias alias="Section" type="domain.blog.Section"/>
  <typeAlias alias="Tag" type="domain.blog.Tag"/>
</typeAliases>

 如果一个包下有很多的类，我们可以直接引入包，这样就是给该包下面的所有类的设置了别名，可以直接使用。在没有注解的情况下，会使用 Bean 的非限定类名(首字母大小写均可)来作为它的别名。

<typeAliases>
  <package name="domain.blog"/>
</typeAliases>

 若有注解，则别名为其注解值。

@Alias("author")
public class Author {
    ...
}

1.5 typeHandlers 类型处理器 

（4）java 类 型 和 jdbc 类 型 映 射 关 系 一 览 [ 手 册 ]

1.6 mappers 映射器

（1）resource 注册 Mapper 文件 

<mapper resource="com/mapper/MonsterMapper.xml"/>

（2）class:接口注解实现 

<mapper class="com.mapper.MonsterAnnotation"/>

（3）url:外部路径,使用很少

<mapper url="file:///D:\yy\kk\yy\MOnsterMapper.xml" />

（4）package 方式注册 

说明

• 当一个包下有很多的Mapper.xml文件和基于注解实现的接口时，为了方便，我们可以以包方式进行注册
• 这样的方式将下面的所有xml文件和注解接口都进行注册 

<package name="com.hspedu.mapper"/>

2 XxxxMapper.xml-SQL 映射文件

2.1 官方文档 

https://mybatis.org/mybatis-3/zh_CN/sqlmap-xml.html

2.2 XxxMapper.xml-基本介绍 

（1）MyBatis 的真正强大在于它的语句映射(在 XxxMapper.xml 配置), 由于它的异常强大, 如果拿它跟具有相同功能的 JDBC 代码进行对比，你会立即发现省掉了将近 95% 的代码。 MyBatis 致力于减少使用成本，让用户能更专注于 SQL 代码

（2）SQL 映射文件常用的几个顶级元素（按照应被定义的顺序列出）：

cache – 该命名空间的缓存配置。

cache-ref – 引用其它命名空间的缓存配置。

resultMap – 描述如何从数据库结果集中加载对象，是最复杂也是最强大的元素。

parameterType - 将会传入这条语句的参数的类全限定名或别名

sql – 可被其它语句引用的可重用语句块。

insert – 映射插入语句。

update – 映射更新语句。

delete – 映射删除语句。

select – 映射查询语句。 

2.3 XxxMapper.xml-详细说明 

2.3.1 新建 Module xml-mapper

（3）创建 MonsterMapper.java 接口、MonsterMapper.xml 映射文件 和 MonsterMapperTest.java测试类

2.3.2 parameterType(输入参数类型)

说明

（4）当传入的参数类型是 String 时，需要使用 ${} 来接收参数

案例演示

（1）在MonsterMapper.java 接口中增加方法

// 通过id 或者 名字查询
public List<Monster> findMonsterByNameORId(Monster monster);

//查询名字中含有‘精’的妖怪
public List<Monster> findMonsterByName(String name);

 （2）配置映射文件 MonsterMapper.xml

<?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">

<!--
1. 这是一个mapper xml 文件
2. 该文件可以去实现对应的接口的方法
3. namespace 指定该xml文件和哪个接口对应!!!
-->
<mapper namespace="com.mapper.MonsterMapper">

    <!--
   1. 配置/实现public List<Monster> findMonsterByNameORId(Monster monster);
   2. 通过id 或者名字查询
   3. `id` = #{id} `id`表示表的字段名 #{id} 中的id表示你传入的Monster对象的属性名
   -->
    <select id="findMonsterByNameORId" parameterType="monster" resultType="monster">
        select * from `monster` where `id` = #{id} or `name` = #{name}
    </select>

    <!--
    1. 配置/实现 public List<Monster> findMonsterByName(String name);
    2. 请查询 name 中 包含 "精" 的妖怪 - 是模糊查询
    3. 模糊查询的使用 取值 需要使用 ${name} 取值
    -->
    <select id="findMonsterByName" parameterType="string" resultType="monster">
        select * from `monster` where `name` like '%${name}%'
    </select>

</mapper>

（3）在测试类 MonsterMapperTest.java 中编写测试方法

package com.mapper;

import com.entity.Monster;
import com.util.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Before;
import org.junit.Test;

import java.util.List;

public class MonsterMapperTest {

    //属性
    private SqlSession sqlSession;
    private MonsterMapper monsterMapper;

    @Before
    public void init(){
        sqlSession = MyBatisUtils.getSqlSession();
        monsterMapper = sqlSession.getMapper(MonsterMapper.class);
        System.out.println("monsterMapper = " + monsterMapper);
    }

    @Test
    public void findMonsterByNameORId(){
        Monster monster = new Monster();
        monster.setId(1);
        monster.setName("狐狸精-100");
        // 会返回 id 为 1 或者 name = ‘狐狸精-100’ 的妖怪
        List<Monster> monsterList = monsterMapper.findMonsterByNameORId(monster);
        for (Monster o : monsterList) {
            System.out.println(o);
        }
        sqlSession.close();
    }

    @Test
    public void findMonsterByName(){
        List<Monster> monsterList =  monsterMapper.findMonsterByName("精");
        for (Monster o : monsterList) {
            System.out.println(o);
        }
        sqlSession.close();
    }
}

测试结果如下

2.3.3 传入 HashMap 类型参数

说明

 HashMap 传入参数更加灵活，比如可以灵活的增加查询的属性，而不受限于 Monster 这个 Pojo 属性本身

传入 HashMap- 应用实例 1 

要求：声明一个方法，按传入参数是 HashMap 的方式，查询 id > 10 并且 salary 大于 40 的所有妖怪

//查询 id > 10 并且 salary 大于 40, 要求传入的参数是HashMap
public List<Monster> findMonsterByIdAndSalary_PrameterHashMap(Map<String, Object> map);

（2）修改 MonsterMapper.xml

<!--
    1. 配置/实现public List<Monster> findMonsterByIdAndSalary_PrameterHashMap(Map<String, Object> map);
    2. id > 10 并且 salary 大于 40, 要求传入的参数是HashMap
    3. 如果是以map形式传入参数，当你这样写条件 `id` > #{id} 表示你的map 中有一个k-v 中 key是id
-->
<select id="findMonsterByIdAndSalary_PrameterHashMap" parameterType="map" resultType="monster">
    select * from `monster` where `id` > #{id} and `salary` > #{salary}
</select>

 （3）修改 MonsterMapperTest.java 进行测试

@Test
public void findMonsterByIdAndSalary_PrameterHashMap() {
    Map<String, Object> map = new HashMap<>();
    map.put("id", 5);
    map.put("salary", 40);
    List<Monster> monsters =
            monsterMapper.findMonsterByIdAndSalary_PrameterHashMap(map);

    for (Monster monster : monsters) {
        System.out.println("monster--" + monster);
    }

    if (sqlSession != null) {
        sqlSession.close();
    }

    System.out.println("操作成功~");
}

测试结果

 传入和返回 HashMap- 应用实例2

要求：将上面的方法的改成返回参数也以 HashMap 的类型 

（1）修改 MonsterMapper.java

//查询 id > 10 并且 salary 大于 40, 要求传入的参数是HashMap
public List<Map<String, Object>>
findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(Map<String, Object> map);

（2）修改 MonsterMapper.xml

<!--
1. 配置/实现 public List<Map<String, Object>>
  findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(Map<String, Object> map);
2. id > 10 并且 salary 大于 40, 要求传入的参数和返回的是HashMap
-->
<select id="findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap" parameterType="map" resultType="map">
    select * from `monster` where `id` > #{id} and `salary` > #{salary}
</select>

（3）修改 MonsterMapperTest.java

@Test
public void findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap() {

    Map<String, Object> map = new HashMap<>();
    map.put("id", 5);
    map.put("salary", 40);
    List<Map<String, Object>> monsterList =
            monsterMapper.findMonsterByIdAndSalary_PrameterHashMap_ReturnHashMap(map);

    //取出返回的结果-以map取出
    //map遍历
    for (Map<String, Object> monsterMap : monsterList) {
        //System.out.println("monsterMap-" + monsterMap);

        //遍历monsterMap(方式1) ,取出属性和对应值
        //Set<String> keys = monsterMap.keySet();
        //for (String key : keys) {
        //    System.out.println(key + "=>" + monsterMap.get(key));
        //}

        //遍历monsterMap(方式2) ,取出属性和对应值
        for (Map.Entry<String, Object> entry : monsterMap.entrySet()) {
            System.out.println(entry.getKey() + "==>" + entry.getValue());
        }
        System.out.println("------------------------");
    }

    if (sqlSession != null) {
        sqlSession.close();
    }

    System.out.println("操作成功~");

}

 测试结果

2.3.4 resultMap(结果集映射)

2.3.4.1 基本介绍 

当实体类的属性和表的字段名字不一致时，我们可以通过 resultMap 进行映射，从而屏蔽实体类属性名和表的字段名的不同

2.3.4.2 应用案例

（1）创建表 user

-- 创建的 user 表
CREATE TABLE `user` (
`user_id` INT NOT NULL AUTO_INCREMENT,
`user_email` VARCHAR(255) DEFAULT '',
`user_name` VARCHAR(255) DEFAULT '',
PRIMARY KEY (`user_id`)
)CHARSET=utf8

（2）创建 entity src\main\java\com\entity\User.java

package com.entity;

public class User {
    private Integer user_id;
    private String username;
    private String userEmail;

    public Integer getUser_id() {
        return user_id;
    }

    public void setUser_id(Integer user_id) {
        this.user_id = user_id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getUserEmail() {
        return userEmail;
    }

    public void setUserEmail(String userEmail) {
        this.userEmail = userEmail;
    }

    @Override
    public String toString() {
        return "User{" +
                "user_id=" + user_id +
                ", username='" + username + '\'' +
                ", useremail='" + userEmail + '\'' +
                '}';
    }
}

 （3）创建 src\main\java\com\mapper\UserMapper.java

package com.mapper;

import com.entity.User;

import java.util.List;

public interface UserMapper {

    //添加方法
    public void addUser(User user);

    //查询所有的User
    public List<User> findAllUser();
}

 （4）创建 src\main\java\com\mapper\UserMapper.xml

<?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">

<!--
1. 这是一个mapper xml 文件
2. 该文件可以去实现对应的接口的方法
3. namespace 指定该xml文件和哪个接口对应!!!
-->
<mapper namespace="com.mapper.UserMapper">

    <!--
    1、配置方法public void addUser(User user);
    2、完成添加用户的任务, 注意这里user属性和表的字段名不一致
    -->
    <insert id="addUser" parameterType="User">
        INSERT INTO `user` (`user_email`,`user_name`)
        VALUE (#{userEmail}, #{username})
    </insert>

    <!--
    1. 配置方法public List<User> findAllUser();
    2. 返回所有的user信息
    3. 按照传统的方式完成，会出现什么问题?=> 如果对象属性名和表字段相同时，就会设置值, 如果不同, 就会是默认值
    4. 我们可以使用resultMap来解决
    5. resultMap : 表示我们要定义一个resultMap
    6. id="findAllUserMap"  => id 就是程序员指定的resultMap id ,后面通过id可以使用他
    7. type="User" ， 就是你需要返回的对象类型
    8. result column="user_email" property="useremail":  column="user_email" 表的字段名, property="useremail" 对象属性名
    9. resultMap="findAllUserMap" 表示使用我们定义的 resultMap , 通过id关联
    -->
    <resultMap id="findAllUserMap" type="User">
        <result column="user_email" property="userEmail"/>
        <result column="user_name" property="username"/>
    </resultMap>
    <select id="findAllUser" resultMap="findAllUserMap">
        SELECT * FROM `user`
    </select>


    <!--使用表字段别名，来解决表的字段名和对象属性名，不一致问题, 可以用，但推荐使用resultmap-->
    <!--<select id="findAllUser" resultType="User">-->
    <!--    SELECT user_id ,user_name AS username,user_email AS userEmail FROM `user`-->
    <!--</select>-->
</mapper>

 （5）修改  src\main\resources\mybatis-config.xml

<mappers>
    <!--
    1. 当一个包下有很多的Mapper.xml文件和基于注解实现的接口时，
    为了方便，可以以包方式进行注册
    2. 将下面的所有xml文件和注解接口 都进行注册
    -->
    <package name="com.mapper"/>
</mappers>

（6）创建 src\test\java\com\hspedu\mapper\UserMapperTest.java 完成测试

package com.mapper;

import com.entity.User;
import com.util.MyBatisUtils;
import org.apache.ibatis.session.SqlSession;
import org.junit.Before;
import org.junit.Test;

import java.util.List;

public class UserMapperTest {

    //属性
    private SqlSession sqlSession;
    private UserMapper userMapper;

    //初始化
    @Before
    public void init() {

        sqlSession = MyBatisUtils.getSqlSession();
        userMapper = sqlSession.getMapper(UserMapper.class);

    }

    @Test
    public void addUser() {
        User user = new User();
        user.setUsername("wang");
        user.setUserEmail("wang@qq.com");

        userMapper.addUser(user);

        //如果是增删改, 需要commit()
        if(sqlSession != null) {
            sqlSession.commit();
            sqlSession.close();
        }

        System.out.println("操作OK~");
    }

    @Test
    public void findAllUser() {
        List<User> users = userMapper.findAllUser();
        for (User user : users) {
            System.out.println("user--" + user);
        }

        if(sqlSession != null) {
            sqlSession.close();
        }

        System.out.println("操作OK~");
    }

}

 测试效果

2.4 特别说明