MyBatis入门简介

2023-11-11 12:45:10

MyBatis入门简介

通过XML构建SqlSessionFactory

每个MyBatis应用都基于SSF（SqlSessionFactory）的实例，可以通过SSF Builder获得。SSF Builder则可以通过XML配置文件或者配置类构建一个SSF。

通过XML文件构建SSF非常方便，推荐使用classpath资源来配置，你也可以通过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);

配置文件包括了MyBatis系统的核心设置，包括取得数据库Connection实例的DataSource，以及确定事务的范围和控制方式。

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

上述内容包括了配置文件中最重要的几个部分，XML header用于验证XML文档，enviornment元素包括用于事务管理和连接池的环境配置，映射器元素包含映射器的列表（XML文件及包含SQL代码和映射定义的标注Java类）

不通过XML构建SqlSessionFactory

你也可以通过创建配置类来直接构建配置。

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

在这个情况下，正在添加一个映射器类。映射器类为能够舍用XML、含有SQL映射标注的Java类。但是，由于Java标注的限制，以及MyBatis某些映射的复杂度，进阶的映射仍需要XML映射（例如嵌套式的Join映射）。因此，MyBatis将自动寻找并加载一个同级别XML文件（如果存在的话，例如，基于BlogMapper.class会加载BlogMapper.xml）。

从SqlSessionFactory获取一个SqlSession

有了SqlSessionFactory之后 ，你就可以获得一个SqlSession的实例。SqlSession包含了所有执行数据库命令的方法。你可以通过SqlSession实例来执行映射的SQL语句，例如：

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

另有一种更清晰的方法，使用接口，正确地描述一个给定语句的参数和返回值，来执行更干净、安全的类型代码。

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

SQL语句映射分析

你可能会疑惑SqlSession和Mapper类是如何被正确执行的。接下来我们通过例子来查看：

在上述的示例代码中，语句可以通过XML或是标注的方法被定义，让我们首先查看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.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

尽管这个XML看上去很复杂，实际上代价是很轻的。你在单个映射器XML文件中定义尽可能多的映射语句。

在mapper元素中，定义了映射语句的名字“selectBlog”，在命名空间“org.mybatis.example.BlogMapper”中，允许你通过指定完全限定名称“org.mybatis.example.BlogMapper.selectBlog”来调用。

Blog blog = session.selectOne(
  "org.mybatis.example.BlogMapper.selectBlog", 101);

这与在一个Java类中调用方法类似，这个名字可以直接映射到与命名空间同名的映射类中，方法的名称、参数和返回类型与映射的选择语句相匹配。如此一来，你可以非常简单地针对映射接口调用该方法。

BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);

有关namespace的提示

Namespaces现在是必要的，且不仅仅为了用较长的、完全限定的名称来隔离语句

命名空间可以实现接口绑定，使用命名空间并将它放在适当的Java包命名空间中，以提高MyBatis的可用性。

命名解析

为了减少输入量，MyBatis对所有命名的配置元素使用以下名称解析规则，包括语句、结果图、缓存等。

  • 完全名称（如"com.mypackage.MyMapper.selectAllThings"）将被直接检索并使用
  • 短名称（如“selectAllThing”）可以用来引用任何明确的条目，如果不同命名空间下有相同的短名称则报错，必须使用完全名称。

另一个不使用XML映射的方式为使用Java的标注功能，例如，上述的XML可以被替换为：

package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}

如果是更为复杂的语句，建议使用XML。

作用域（Scope）和生命周期

SqlSessionFactoryBuilder

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

SqlSessionFactory

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

SqlSession

每个线程都应该有它自己的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。 绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。 也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。 如果你现在正在使用一种 Web 框架，考虑将 SqlSession 放在一个和 HTTP 请求相似的作用域中。 换句话说，每次收到 HTTP 请求，就可以打开一个 SqlSession，返回一个响应后，就关闭它。 这个关闭操作很重要，为了确保每次都能执行关闭操作，你应该把这个关闭操作放到 finally 块中。 下面的示例就是一个确保 SqlSession 关闭的标准模式：

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

在所有代码中都遵循这种使用模式，可以保证所有数据库资源都能被正确地关闭。

映射器实例

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

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}
上一篇：[Mybaits]如何建立Mybatis项目


下一篇：Mybatis源码分析(1)之mybatis入门使用