MyBatis 之一（简介、HelloWorld、全局配置文件）

1、MyBatis 简介

• MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架。

• MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。

• MyBatis 可以使用简单的 XML 或注解用于配置和原始映射，将接口和 Java 的 POJO（Plain Old Java Objects，普通的 Java 对象）映射成数据库中的记录。

（1）MyBatis 历史

• 原是 Apache 的一个开源项目 iBatis, 2010年6月这个项目由 Apache Software Foundation 迁移到了 Google Code，随着开发团队转投 Google Code旗下，iBatis3.x 正式更名为 MyBatis ，代码于2013年11月迁移到 Github（下载地址见后）。

• iBatis 一词来源于 “internet” 和 “abatis” 的组合，是一个基于Java 的持久层框架。iBatis 提供的持久层框架包括 SQL Maps 和 Data Access Objects（DAO）

（2）为什么要使用 MyBatis？

• MyBatis 是一个半自动化的持久化层框架。

• JDBC
  –SQL 夹在 Java 代码块里，耦合度高导致硬编码内伤
  –维护不易且实际开发需求中 sql 是有变化，频繁修改的情况多见

• Hibernate 和 JPA
  –长难复杂 SQL，对于 Hibernate 而言处理也不容易
  –内部自动生产的 SQL，不容易做特殊优化。
  –基于全映射的全自动框架，大量字段的 POJO 进行部分映射时比较困难。导致数据库性能下降。

• 对开发人员而言，核心 sql 还是需要自己优化

• sql 和 java 编码分开，功能边界清晰，一个专注业务、一个专注数据。

（3）去哪里找 MyBatis？

下载地址：https://github.com/mybatis/mybatis-3/

MyBatis 官方文档：https://mybatis.org/mybatis-3/zh/index.html

2、MyBatis-HelloWorld

2.1 HelloWorld 简单版

（1）创建一张测试表

CREATE TABLE tbl_employee(
	id INT(11) PRIMARY KEY AUTO_INCREMENT,
	last_name VARCHAR(255),
	gender CHAR(1),
	email VARCHAR(255)
);

（2）创建对应的 javaBean

public class Employee {

    private Integer id;
    private String lastName;
    private String email;
    private String gender;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        return "Employee{" +
                "id=" + id +
                ", lastName='" + lastName + '\'' +
                ", email='" + email + '\'' +
                ", gender='" + gender + '\'' +
                '}';
    }
}

（3）创建mybatis配置文件，sql映射文件

• MyBatis操作数据库
  ①创建MyBatis全局配置文件
  MyBatis 的全局配置文件包含了影响MyBatis 行为甚深的设置（settings）和属性（properties）信息、如数据库连接池信息等。指导着MyBatis进行工作。我们可以参照官方文件的配置示例。

<?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>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="123456"/>
            </dataSource>
        </environment>
    </environments>

    <!-- 将我们写好的 sql 映射文件（EmployeeMapper.xml）一定要注册到全局配置文件（mybatis-config.xml）中 -->
    <mappers>
        <mapper resource="EmployeeMapper.xml"/>
    </mappers>
</configuration>

②创建SQL映射文件
映射文件的作用就相当于是定义 Dao 接口的实现类如何工作。这也是我们使用 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="com.mycode.mybatis.EmployeeMapper">
    <!--
        namespace：名称空间
        id：唯一标识
        resultType：返回值类型
        #{id}：从传递过来的参数中取出 id 值
    -->
    <select id="selectEmp" resultType="com.mycode.mybatis.bean.Employee">
        select * from tbl_employee where id = #{id}
    </select>
</mapper>

注意：配置文件夹 conf 需要与 src 同一级，并需要将其加载进工程：

（4）测试
① 根据全局配置文件，利用 SqlSessionFactoryBuilder 创建 SqlSessionFactory
② 使用 SqlSessionFactory 获取 sqlSession对象。一个 SqlSession 对象代表和数据库的一次会话。
③ 使用 SqlSession 根据方法 id 进行操作

	@Test
    public void test() throws IOException {
    	// 第一步：根据全局配置文件，利用 SqlSessionFactoryBuilder 创建 SqlSessionFactory
        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        SqlSessionFactory sqlSessionFactory =
                new SqlSessionFactoryBuilder().build(inputStream);

        // 第二步：获取 sqlSession 实例，能直接执行已经映射的 sql 语句
        // sql 的唯一标识：statement Unique identifier matching the statement to use.
        // 执行 sql 要用的参数：parameter A parameter object to pass to the statement.
        // 方式一：
        SqlSession openSession = sqlSessionFactory.openSession();
        
        // 第三步：使用 SqlSession 根据方法 id 进行操作
        try {
            Employee employee = openSession.selectOne("com.mycode.mybatis.EmployeeMapper.selectEmp", 1);
            System.out.println(employee);
        } finally {
            openSession.close();
        }

        // 方式二：
//        try (SqlSession openSession = sqlSessionFactory.openSession()) {
//            Employee employee = openSession.selectOne("com.mycode.mybatis.EmployeeMapper.selectEmp", 1);
//            System.out.println(employee);
//        }
    }

2.2 HelloWorld 接口式编程

（1）创建一个 Dao 接口

public interface EmployeeMapper {

    public Employee getEmpById(Integer id);
}

（2）修改 EmployeeMapper.java 文件

<?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="com.mycode.mybatis.dao.EmployeeMapper">
    <!--
        namespace：名称空间;指定为接口的全类名
        id：唯一标识
        resultType：返回值类型
        #{id}：从传递过来的参数中取出 id 值

        public Employee getEmpById(Integer id);
    -->
    <select id="getEmpById" resultType="com.mycode.mybatis.bean.Employee">
        select id,last_name lastName,email,gender from tbl_employee where id = #{id}
    </select>
</mapper>

（3）测试

• 使用 SqlSession 获取映射器进行操作

	@Test
    public void test01() throws IOException {
        // 1、获取 sqlSessionFactory 对象
        SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();

        // 2、获取 sqlSession 对象
        try (SqlSession openSession = sqlSessionFactory.openSession()) {
            // 3、获取接口的实现类对象
            // 会为接口自动创建一个代理对象，代理对象去执行增删改查方法
            EmployeeMapper mapper = openSession.getMapper(EmployeeMapper.class);

            Employee employee = mapper.getEmpById(1);
            System.out.println(mapper.getClass());
            System.out.println(employee);
        }
    }

2.3 SqlSession

• SqlSession 的实例不是线程安全的，因此是不能被共享的。

• SqlSession每次使用完成后需要正确关闭，这个关闭操作是必须的

• SqlSession 可以直接调用方法的id进行数据库操作，但是我们一般还是推荐使用 SqlSession 获取到 Dao 接口的代理类，执行代理对象的方法，可以更安全的进行类型检查操作

2.4 说明

（1）接口式编程
原生： Dao —> DaoImpl
mybatis： Mapper —> xxMapper.xml

（2）SqlSession 代表和数据库的一次会话；用完必须关闭；

（3）SqlSession 和 connection 一样，都是非线程安全。每次使用都应该去获取新的对象。

（4）mapper 接口没有实现类，但是 mybatis 会为这个接口生成一个代理对象。（将接口和 xml 进行绑定）
EmployeeMapper empMapper = sqlSession.getMapper(EmployeeMapper.class);

5、两个重要的配置文件：

• mybatis 的全局配置文件：包含数据库连接池信息，事务管理器信息等…系统运行环境信息
• sql 映射文件：保存了每一个 sql 语句的映射信息：将 sql 抽取出来。

3、MyBatis 全局配置文件

MyBatis 的配置文件包含了影响 MyBatis 行为甚深的设置（settings）和属性（properties）信息。文档的顶层结构如下：

configuration 配置

• properties 属性
• settings 设置
• typeAliases 类型命名
• typeHandlers 类型处理器
• objectFactory 对象工厂
• plugins 插件
• environments 环境
  • environment 环境变量
    • transactionManager 事务管理器
    • dataSource 数据源
• databaseIdProvider 数据库厂商标识
• mappers 映射器

说明：
（1）在 Eclipse中 引入 XML 的 dtd 约束文件，方便编写 XML 的时候有提示

（2）在 IDEA中 引入 XML 的 dtd 约束文件，方便编写 XML 的时候有提示

3.1 properties 属性

dbconfig.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis
jdbc.username=root
jdbc.password=123456

mybatis-config.xml

	<!--
        1、MyBatis 可以使用 properties 来引入外部 properties 配置文件的内容；
        resource：引入类路径下的资源
        url：引入网络路径或者磁盘路径下的资源
     -->
    <properties resource="dbconfig.properties"></properties>

• 如果属性在不只一个地方进行了配置，那么 MyBatis 将按照下面的顺序来加载：
  –在 properties 元素体内指定的属性首先被读取。
  –然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。
  –最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。

3.2 settings 设置

这是MyBatis 中极为重要的调整设置，它们会改变MyBatis 的运行时行为。

mybatis-config.xml

	<settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>

3.3 typeAliases 别名处理器

类型别名是为 Java 类型设置一个短的名字，可以方便我们引用某个类。

① typeAlias：为某个 java 类型起别名

• type：指定要起别名的类型全类名；默认别名就是类名小写；employee
• alias：指定新的别名

	<typeAliases>
        <typeAlias type="com.mycode.mybatis.bean.Employee" alias="emp"/>
    </typeAliases>

② package：为某个包下的所有类批量起别名

• name：指定包名（为当前包以及下面所有的后代包的每一个类都起一个默认别名（类名小写））

	<typeAliases>
        <package name="com.mycode.mybatis.bean"/>
    </typeAliases>

③ 批量起别名的情况下，使用 @Alias 注解为某个类型指定新的别名

@Alias("emp")
public class Employee {

    private Integer id;
    private String lastName;
    private String email;
    private String gender;

值得注意的是，MyBatis 已经为许多常见的 Java 类型内建了相应的类型别名。它们都是大小写不敏感的，我们在起别名的时候千万不要占用已有的别名。

3.4 typeHandlers 类型处理器

无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时，都会用类型处理器将获取的值以合适的方式转换成 Java 类型。

（1）日期类型的处理

• 日期和时间的处理，JDK1.8 以前一直是个头疼的问题。我们通常使用 JSR310 规范领导者 Stephen Colebourne 创建的 Joda-Time 来操作。1.8 已经实现全部的 JSR310 规范了。

• 日期时间处理上，我们可以使用 MyBatis 基于 JSR310（Date and Time API）编写的各种日期时间类型处理器。

• MyBatis3.4 以前的版本需要我们手动注册这些处理器，以后的版本都是自动注册的
  
  （2）自定义类型处理器

我们可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。

步骤：
1）、实现 org.apache.ibatis.type.TypeHandler 接口或者继承org.apache.ibatis.type.BaseTypeHandler
2）、指定其映射某个 JDBC 类型（可选操作）
3）、在 mybatis 全局配置文件中注册

3.5 plugins 插件

插件是 MyBatis 提供的一个非常强大的机制，我们可以通过插件来修改 MyBatis 的一些核心行为。插件通过动态代理机制，可以介入四大对象的任何一个方法的执行。后面会有专门的章节我们来介绍 mybatis 运行原理以及插件

• Executor(update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)

• ParameterHandler(getParameterObject, setParameters)

• ResultSetHandler(handleResultSets, handleOutputParameters)

• StatementHandler(prepare, parameterize, batch, update, query)

3.6 environments 环境

• MyBatis 可以配置多种环境，比如开发、测试和生产环境需要有不同的配置。

• 每种环境使用一个 environment 标签进行配置并指定唯一标识符

• 可以通过 environments 标签中的 default 属性指定一个环境的标识符来快速的切换环境

environment 指定具体环境

• id：指定当前环境的唯一标识

• transactionManager、和 dataSource 都必须有

	<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.username}"/>
                <property name="password" value="${jdbc.password}"/>
            </dataSource>
        </environment>
    </environments>

① transactionManager

• type：JDBC | MANAGED | 自定义

  • JDBC：使用了JDBC 的提交和回滚设置，依赖于从数据源得到的连接来管理事务范围。JdbcTransactionFactory

  • MANAGED：不提交或回滚一个连接、让容器来管理事务的整个生命周期（比如JEE 应用服务器的上下文）。ManagedTransactionFactory

  • 自定义：实现 TransactionFactory 接口，type=全类名/别名

② dataSource

• type：UNPOOLED | POOLED | JNDI | 自定义

  • UNPOOLED：不使用连接池，UnpooledDataSourceFactory

  • POOLED：使用连接池，PooledDataSourceFactory

  • JNDI：在 EJB 或应用服务器这类容器中查找指定的数据源

  • 自定义：实现 DataSourceFactory 接口，定义数据源的获取方式。

注意：实际开发中我们使用Spring管理数据源，并进行事务控制的配置来覆盖上述配置

3.7 databaseIdProvider 环境

MyBatis 可以根据不同的数据库厂商执行不同的语句。

mybatis-config.xml

	<databaseIdProvider type="DB_VENDOR">
        <!-- 为不同的数据库厂商起别名 -->
        <property name="MySQL" value="mysql"/>
        <property name="Oracle" value="oracle"/>
        <property name="SQL Server" value="sqlserver"/>
    </databaseIdProvider>

• Type：DB_VENDOR
  使用 MyBatis 提供的 VendorDatabaseIdProvider 解析数据库厂商标识。也可以实现 DatabaseIdProvider 接口来自定义。

• Property-name：数据库厂商标识

• Property-value：为标识起一个别名，方便 SQL 语句使用 databaseId 属性引用

EmployeeMapper.xml

	<select id="getEmpById" resultType="com.mycode.mybatis.bean.Employee"
        databaseId="mysql">
        select * from tbl_employee where id = #{id}
    </select>
    
    <select id="getEmpById" resultType="com.mycode.mybatis.bean.Employee"
        databaseId="oracle">
        select EMPLOYEE_ID id,LAST_NAME lastName,EMAIL email form employees where EMPLOYEE_ID=#{id}
    </select>

（1）DB_VENDOR

会通过DatabaseMetaData#getDatabaseProductName()返回的字符串进行设置。由于通常情况下这个字符串都非常长而且相同产品的不同版本会返回不同的值，所以最好通过设置属性别名来使其变短

（2）MyBatis匹配规则如下：

① 如果没有配置 databaseIdProvider 标签，那么 databaseId=null

② 如果配置了 databaseIdProvider 标签，使用标签配置的 name 去匹配数据库信息，匹配上设置 databaseId=配置指定的值，否则依旧为 null

③ 如果 databaseId 不为 null，他只会找到配置 databaseId 的 sql 语句

④ MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库 databaseId 属性的所有语句。如果同时找到带有 databaseId 和不带 databaseId 的相同语句，则后者会被舍弃。

3.8 mappers 映射

mappers：将 sql 映射注册到全局配置中

mapper：注册一个 sql 映射

（1）注册配置文件

• resource：引用类路径下的 sql 映射文件；例如：<mapper resource="mybatis/mapper/EmployeeMapper.xml"/>

• url：引用网络路径或者磁盘路径下的 sql 映射文件；例如：<mapper url="file:///var/mappers/AuthorMapper.xml"/>

（2）注册接口

class：引用（注册）接口

• 有 sql 映射文件，映射文件名必须和接口同名，并且放在与接口同一目录下；例如：<mapper class="com.mycode.mybatis.dao.EmployeeMapper"/>
• 没有 sql 映射文件，所有的 sql 都是利用注解写在接口上；例如：<mapper class="com.mycode.mybatis.dao.EmployeeMapperAnnotation"/>
  
  （3）批量注册

<package name="com.mycode.mybatis.dao"/>

注意：此时为了避免配置文件与接口在同一个文件目录下非常混乱，可以建如下目录结构