MyBatis-0.简介

悠扬前奏

发布于 2019-05-31 10:24:34

5030

发布于 2019-05-31 10:24:34

文章被收录于专栏：悠扬前奏的博客

1. 什么是MyBatis（What）

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

2. 为什么使用MyBatis（Why）

MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

3. 如何使用（How）

3.1 安装

将mybatis-x.x.x.jar文件置于classpath中即可。或者使用Maven

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

3.2 从XML中构建SqlSessionFactory

基于MyBatis的应用都以一个SqlSessionFactory实例为中心。SqlSessionFactory的实例可以通过SqlSessionFactoryBuilder获得。SqlSessionFactoryBuilder可以从XML配置文件或者一个预先定制的Configuration的实例构建出SqlSessionFactory的实例。

可以从XML文件中构建SqlSessionFactory。

配置

建议使用类路径下的资源文件来进行配置；也可以使用任意的输入流（InputStream）实例，包括字符串形式的文件路径或者file://的URL形式的文件路径来配置。 MyBatis包含的Resources工具类包含的方法可以使从classpath加载文件更加容易。

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

配置文件

XML配置文件（configuration XML）中包含了对MyBatis的设置。主要有获取数据库连接实例的数据源（DataSource）和决定事务作用域和控制方式的事务管理器（TransactionManager）。简单示例如下：

<?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="config.properties">
        <!--这里可以配置属性名和值-->
    </properties>
    <environments default="development">
        <environment id="development">
            <!--事务管理-->
            <transactionManager type="JDBC"/>
            <!--数据库连接池，mybatis管理-->
            <dataSource type="POOED">
                <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>
    <!--加载映射文件-->
    <mappers>
        <mapper resource="org/junzerg/mapper/TestMapping.xml"/>
    </mappers>
</configuration>

建立config.properties文件

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=sa

3.3 从Java程序中构建SqlSessionFactory

MyBatis提供了配置类，以供从Java程序中创建configuration，或者创建自己的configuration构建器。

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);

3.4 从SqlSessionFactory中获取SqlSession

得到SqlSessionFactory之后，从中获取SqlSession。它包含了面向数据库执行SQL命令的所有方法。包括通过SqlSession实例来执行已映射的SQL语句：

SqlSession session = sqlSessionFactory.openSession();
try {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
} finally {
  session.close();
}

3.5 如何映射SQL语句

以下是可以满足3.4中例子的SqlSession的基于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">
<mapper namespace="org.junzerg.mapper">
    <select id="selectUser" resultType="User">
        select * from user where id = #{id};
    </select>
</mapper>

命令空间“org.junzerg.mapper”定义了一个名为selectUser的语句，可以使用完全限定名“org.junzerg.mapper. selectUser”来调用映射语句：

User user = (User) session.selectOne("org.junzerg.mapper. selectUser", 10);

还可以使用下面方法调用：

UserMapping mapper = session.getMapper(UserMapper.class);
User user = mapper.selectUser(10);

第二种方法不是基于字符串常量的，更安全。在有代码补全的IDE中，可以在已映射的SQL语句之上使用这个功能。

对于映射器类（Mapping class来说），还可以用Java注解来映射：

package org.junzerg.mapper
public interface UserMapper {
    @Select("select * from user where id = #{id}")
    User selectUser(int id);
}

建议使用xml映射。

4 作用域（Scope）和生命周期

对于生命周期的错误使用可能导致并发问题。

对象生命周期和依赖注入框架

依赖注入框架可以创建线程安全的、基于事务的 SqlSession 和映射器（mapper）并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。

4.1 SqlSessionFactoryBuilder

该类可以被实例化，使用和丢弃，创建了SqlSessionFactory之后就不再需要它了。它的最佳作用域是方法作用域（也就是局部方法变量）。可以重用SqlSessionFactoryBuilder来创建多个SqlSessionFactory实例。但是不要让其一直存在以保证所有的XML解析资源开放给别的事情。

4.2 SqlSessionFactory

SqlSessionFactory一旦被创建就应该在应用的运行期间一直存在，不要对它进行清楚或重建。它在应用运行期间不要重复创建多次。因此它的最佳作用域是应用作用域。有很多方法可以做到，最简单就是使用单例模式或静态单例模式。

4.3 SqlSession

每个线程都有自己的SqlSession实例。SqlSession实例也不是线程安全，不能被共享。它的最佳作用域是请求或方法作用域。不能将SqlSession实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。不能将SqlSession实例的引用放在任何类型的管理作用域中 web应用中，每次收到HTTP请求，要打开一个SqlSession，返回一个响应，就关闭它（关闭操作很重要，一般放在finally语句块中）。