MyBatis入门学习

MyBatis入门学习

MyBatis是一个Java持久化框架，它通过XML描述符或注解把对象与存储过程或SQL语句关联起来，映射成数据库内对应的纪录。

与其他对象关系映射框架不同，MyBatis没有将Java对象与数据库表关联起来，而是将Java方法与SQL语句关联。MyBatis允许用户充分利用数据库的各种功能，例如存储过程、视图、各种复杂的查询以及某数据库的专有特性。如果要对遗留数据库、不规范的数据库进行操作，或者要完全控制SQL的执行，MyBatis是一个不错的选择。

与JDBC相比，MyBatis简化了相关代码：SQL语句在一行代码中就能执行。MyBatis提供了一个映射引擎，声明式的把SQL语句执行结果与对象树映射起来。通过使用一种内建的类XML表达式语言，或者使用Apache Velocity集成的插件，SQL语句可以被动态的生成。

1.安装

要使用 MyBatis， 只需将 mybatis-x.x.x.jar 文件置于类路径（classpath）中即可。

如果使用 Maven 来构建项目，则需将下面的依赖代码置于 pom.xml 文件中：

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

2.MyBatis的特点

优点

• 与JDBC相比，减少了50%以上的代码量。
• MyBatis是最简单的持久化框架，小巧并且简单。
• MyBatis相当灵活，不会对应用程序或者数据库的现有设计强加任何影响，SQL卸载XML里，从程序代码中彻底分离，降低耦合度，便于统一管理和优化，并可重用。
• 提供XML标签，支持编写动态sql语句。
• 提供映射标签，支持对象与数据库的ORM字段关系映射。

缺点

• 编写SQL语句时工作量很大，尤其是字段多、关联表多时，更是如此。
• SQL语句依赖于数据库，导致数据库移植性差，不能更换数据库。
• 框架还是比较简陋，功能尚有缺失，虽然简化了数据绑定代码，但是整个底层数据库查询实际还是要自己写的，工作量也比较大，而且不太容易适应快速数据库修改。
• 二级缓存机制不佳

3.Mybatis工作流程

• 通过Reader对象读取Mybatis配置文件
• 通过SqlSessionFactoryBuilder对象创建SqlSessionFactory对象
• 获取当前线程的SQLSession
• 事务默认开启
• 通过SQLSession读取映射文件中的操作编号，从而读取SQL语句
• 提交事务
• 关闭资源

4.MyBatis核心接口和类

4.1 从 XML 中构建 SqlSessionFactory

每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先配置的 Configuration 实例来构建出 SqlSessionFactory 实例。

推荐使用类路径下的资源文件进行配置，从 XML 文件中构建 SqlSessionFactory 的实例推荐使用类路径下的资源文件进行配置。也可以使用任意的输入流（InputStream）实例，比如用文件路径字符串或 file:// URL 构造的输入流。MyBatis 包含一个名叫 Resources 的工具类，它包含一些实用方法，使得从类路径或其它位置加载资源文件更加容易。

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

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>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

4.2 不使用 XML 构建 SqlSessionFactory

从 Java 代码中创建配置，MyBatis 也提供了完整的配置类，提供了所有与 XML 文件等价的配置项。

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);

该例中，configuration 添加了一个映射器类（mapper class）。映射器类是 Java 类，它们包含 SQL 映射注解从而避免依赖 XML 文件。不过，由于 Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套联合映射），仍然需要使用 XML 配置。

4.3 从 SqlSessionFactory 中获取 SqlSession

从SqlSessionFactory中获得 SqlSession 的实例,SqlSession 提供了在数据库执行 SQL 命令所需的所有方法。你可以通过 SqlSession 实例来直接执行已映射的 SQL 语句。例如：

try (SqlSession session = sqlSessionFactory.openSession()) {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
}

更简洁的方式——使用和指定语句的参数和返回值相匹配的接口（比如 BlogMapper.class），现在你的代码不仅更清晰，更加类型安全，还不用担心可能出错的字符串字面值以及强制类型转换。

例如：

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

4.4

SqlSessionFactoryBuilder

这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。 你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但最好还是不要一直保留着它，以保证所有的 XML 解析资源可以被释放给更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。 使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建 SqlSessionFactory 被视为一种代码“坏习惯”。因此 SqlSessionFactory 的最佳作用域是应用作用域。 有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。

映射器实例

映射器是一些绑定映射语句的接口。映射器接口的实例是从 SqlSession 中获得的。虽然从技术层面上来讲，任何映射器实例的最大作用域与请求它们的 SqlSession 相同。但方法作用域才是映射器实例的最合适的作用域。 也就是说，映射器实例应该在调用它们的方法中被获取，使用完毕之后即可丢弃。 映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题，但是你很快会发现，在这个作用域上管理太多像 SqlSession 的资源会让你忙不过来。 因此，最好将映射器放在方法作用域内。就像下面的例子一样：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class); // 你的应用逻辑代码 }

5.Mapper映射文件

Mapper映射文件主要是用来定义操作数据库的SQL语句，在Mapper文件中，以mapper作为根节点，其下面可以配置的子节点有： select, insert, update, delete, cache, cache-ref, resultMap。

< mapper>根标签

其namespace属性用于指定该映射文件所映射的Dao接口的全限定类名。

< select>

用于映射查询语句。其包含以下几个常用属性：

• id：命名空间的唯一标识，即接口Dao接口中的方法名称
• useCache ：将其设置为 true 后，将会导致本条语句的结果被二级缓存缓存起来，默认值：对 select 元素为 true。
• parameterType：标识传入SQL语句额参数类的全限定类名，可选属性，因为MyBatis的类型处理器TypeHandler会推断出具体的传入参数类型。
• resultType：执行SQL后返回额结果集类型的全限定类名。
• useCache：用于控制二级缓存的开闭。
• resultMap：对外部 resultMap 的命名引用。resultType 和 resultMap 之间只能同时使用一个。
• flushCache：将其设置为true 后，只要语句被调用，都会导致本地缓存和二级缓存被清空，默认值：false。

< insert>

用于映射插入语句，其包含以下几个属性：

• keyProperty：用于将插入或更新操作时的返回值赋值给POJO的某个属性，通常设置为主键对应的属性，如我们需要返回插入成功后的新数据的主键值，就可以利用该属性。
• keyColumn：当主键不是第一列时，用于设置第几列是主键。

< update>、< delete>

用于映射更新和删除的SQL语句。

< resultMap>

表示用于结果集映射，< resultMap>中包含两个常用的子标签，分别为< collection>和< association>,他们是用来处理多表时的关联关系的,< collection>用于一对多的关联关系，< association>用于一对一的关联关系。

< cache-ref>

对某一namespace命名空间的语句，只会使用该命名空间的缓存进行缓存或刷新。如果想要在多个命名空间中共享相同的缓存配置和实例，可以使用 cache-ref标签来引用另一个缓存。如<cache-ref namespace="com.demo.mybatis.EmployeeMapper"/>

< cache >

默认情况下，MyBatis只启用了本地的会话缓存即SqlSession对象的缓存(一级缓存)，它仅仅对一个会话中的数据进行缓存。 要启用全局的二级缓存即多个SqlSession共享缓存，那么需要在你的Mapper映射文件中添加< cache/>标签。