<?xml version="1.0" encoding="UTF-8"?>
<!--

       Copyright ${license.git.copyrightYears} the original author or authors.

       Licensed under the Apache License, Version 2.0 (the "License");
       you may not use this file except in compliance with the License.
       You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

       Unless required by applicable law or agreed to in writing, software
       distributed under the License is distributed on an "AS IS" BASIS,
       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       See the License for the specific language governing permissions and
       limitations under the License.

-->
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">

  <properties>
    <title>MyBatis 3 | 入门</title>
    <author email="clinton.begin@gmail.com">Clinton Begin</author>
    <author email="nanlei1987@gmail.com">Nan Lei</author>
    <author email="echowdx@gmail.com">Dongxu Wang</author>
  </properties>

  <body>
    <section name="入门">

    <subsection name="安装">
      <p>要使用 MyBatis， 只需将
      <a href="https://github.com/mybatis/mybatis-3/releases">mybatis-x.x.x.jar</a>
      文件置于 classpath 中即可。</p>
      <p>如果使用 Maven 来构建项目，则需将下面的 dependency 代码置于 pom.xml 文件中：</p>
        <source><![CDATA[
<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>]]></source>
    </subsection>

    <subsection name="从 XML 中构建 SqlSessionFactory">
      <p>
        每个基于 MyBatis 的应用都是以一个 SqlSessionFactory
        的实例为核心的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder
        获得。而 SqlSessionFactoryBuilder 则可以从 XML 配置文件或一个预先定制的
        Configuration 的实例构建出 SqlSessionFactory 的实例。
      </p>

      <p>
        从 XML 文件中构建 SqlSessionFactory
        的实例非常简单，建议使用类路径下的资源文件进行配置。
        但是也可以使用任意的输入流（InputStream）实例，包括字符串形式的文件路径或者
        file:// 的 URL 形式的文件路径来配置。MyBatis 包含一个名叫 Resources
        的工具类，它包含一些实用方法，可使从 classpath 或其他位置加载资源文件更加容易。
      </p>

      <source><![CDATA[
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);]]></source>
      <p>
        XML 配置文件中包含了对 MyBatis
        系统的核心设置，包含获取数据库连接实例的数据源（DataSource）和决定事务作用域和控制方式的事务管理器（TransactionManager）。
        XML 配置文件的详细内容后面再探讨，这里先给出一个简单的示例：
      </p>

      <source><![CDATA[<?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>]]></source>
      <p>
        当然，还有很多可以在 XML 文件中进行配置，上面的示例指出的则是最关键的部分。
        要注意 XML 头部的声明，它用来验证 XML 文档正确性。environment
        元素体中包含了事务管理和连接池的配置。mappers 元素则是包含一组映射器（mapper），这些映射器的
        XML 映射文件包含了 SQL 代码和映射定义信息。
      </p>

    </subsection>

    <subsection name="不使用 XML 构建 SqlSessionFactory">
      <p>
        如果你更愿意直接从 Java 代码而不是 XML 文件中创建配置，或者想要创建你自己的配置构建器，MyBatis
        也提供了完整的配置类，提供所有和 XML 文件相同功能的配置项。
      </p>

      <source><![CDATA[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);]]></source>

      <p>
        注意该例中，configuration 添加了一个映射器类（mapper class）。映射器类是
        Java 类，它们包含 SQL 映射语句的注解从而避免依赖 XML 文件。不过，由于
        Java 注解的一些限制以及某些 MyBatis 映射的复杂性，要使用大多数高级映射（比如：嵌套联合映射），仍然需要使用 XML
        配置。有鉴于此，如果存在一个同名
        XML 配置文件，MyBatis 会自动查找并加载它（在这个例子中，基于类路径和 BlogMapper.class 的类名，会加载
        BlogMapper.xml）。具体细节稍后讨论。
      </p>
    </subsection>

    <subsection name="从 SqlSessionFactory 中获取 SqlSession">
      <p>
        既然有了 SqlSessionFactory，顾名思义，我们就可以从中获得 SqlSession 的实例了。SqlSession
        完全包含了面向数据库执行 SQL 命令所需的所有方法。你可以通过
        SqlSession 实例来直接执行已映射的 SQL 语句。例如：
      </p>

      <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
}]]></source>
      <p>
        诚然，这种方式能够正常工作，并且对于使用旧版本 MyBatis
        的用户来说也比较熟悉。不过现在有了一种更简洁的方式
        ——使用正确描述每个语句的参数和返回值的接口（比如
        BlogMapper.class），你现在不仅可以执行更清晰和类型安全的代码，而且还不用担心易错的字符串字面值以及强制类型转换。</p>

      <p>例如：</p>

      <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
}]]></source>
      <p>现在我们来探究一下这里到底是怎么执行的。</p>
    </subsection>

    <subsection name="探究已映射的 SQL 语句">
      <p>
        现在你可能很想知道 SqlSession 和 Mapper 到底执行了什么操作，但 SQL
        语句映射是个相当大的话题，可能会占去文档的大部分篇幅。
        不过为了让你能够了解个大概，这里会给出几个例子。
      </p>
      <p>
        在上面提到的例子中，一个语句既可以通过 XML 定义，也可以通过注解定义。我们先看看
        XML 定义语句的方式，事实上 MyBatis 提供的全部特性都可以利用基于 XML 的映射语言来实现，这使得
        MyBatis 在过去的数年间得以流行。如果你以前用过 MyBatis，你应该对这个概念比较熟悉。
        不过自那以后，XML 的配置也改进了许多，我们稍后还会再提到。这里给出一个基于 XML
        映射语句的示例，它应该可以满足上述示例中 SqlSession 的调用。
      </p>

      <source><![CDATA[<?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>]]></source>

      <p>
        为了这个简单的例子，我们似乎写了不少配置，但实际上它并不多。在一个
        XML 映射文件中，可以定义无数个映射语句，这样一来，XML
        头部和文档类型声明占去的部分就显得微不足道了。而文件的剩余部分具备自解释性，很容易理解。
        在命名空间 “org.mybatis.example.BlogMapper” 中定义了一个名为 “selectBlog”
        的映射语句，允许你使用指定的完全限定名
        “org.mybatis.example.BlogMapper.selectBlog” 来调用映射语句，就像上面例子中那样：
      </p>

      <source><![CDATA[Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);]]></source>

      <p>
        你可能注意到这和使用完全限定名调用 Java
        对象的方法类似。这样，该命名就可以直接映射到在命名空间中同名的
        Mapper 类，并将已映射的 select 语句中的名字、参数和返回类型匹配成方法。
        因此你就可以像上面那样很容易地调用这个对应 Mapper
        接口的方法，就像下面这样：
      </p>

      <source><![CDATA[BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);]]></source>

      <p>
        第二种方法有很多优势，首先它不依赖于字符串字面值，会更安全一点；
        其次，如果你的 IDE 有代码补全功能，那么代码补全可以帮你快速选择已映射的 SQL
        语句。
      </p>

      <hr/>

      <p><span class="label important">提示</span><strong>对命名空间的一点说明</strong></p>
      <p>
        在之前版本的 MyBatis
        中，<strong>命名空间（Namespaces）</strong>的作用并不大，是可选的。
        但现在，随着命名空间越发重要，你必须指定命名空间。
      </p>
      <p>
        命名空间的作用有两个，一个是利用更长的完全限定名来将不同的语句隔离开来，同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定，你也应该遵循这里的规定，以防哪天你改变了主意。
        长远来看，只要将命名空间置于合适的 Java
        包命名空间之中，你的代码会变得更加整洁，也有利于你更方便地使用 MyBatis。
      </p>
      <p>
        <strong>命名解析：</strong>为了减少输入量，MyBatis
        对所有的命名配置元素（包括语句，结果映射，缓存等）使用了如下的命名解析规则。
      </p>

      <ul>
        <li>完全限定名（比如
        “com.mypackage.MyMapper.selectAllThings）将被直接用于查找及使用。
        </li>
        <li>短名称（比如 “selectAllThings”）如果全局唯一也可以作为一个单独的引用。
        如果不唯一，有两个或两个以上的相同名称（比如 “com.foo.selectAllThings” 和
        “com.bar.selectAllThings”），那么使用时就会产生“短名称不唯一”的错误，这种情况下就必须使用完全限定名。
        </li>
      </ul>
      <hr/>
      <p>
        对于像 BlogMapper 这样的映射器类来说，还有另一种方法来处理映射。
        它们映射的语句可以不用 XML 来配置，而可以使用 Java 注解来配置。比如，上面的 XML
        示例可被替换如下：
      </p>
      <source><![CDATA[package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}]]></source>
      <p>
        使用注解来映射简单语句会使代码显得更加简洁，然而对于稍微复杂一点的语句，Java
        注解就力不从心了，并且会显得更加混乱。
        因此，如果你需要完成很复杂的事情，那么最好使用 XML 来映射语句。
      </p>
      <p>
        选择何种方式来配置映射，以及认为映射语句定义的一致性是否重要，这些完全取决于你和你的团队。
        换句话说，永远不要拘泥于一种方式，你可以很轻松的在基于注解和 XML
        的语句映射方式间自由移植和切换。
      </p>
    </subsection>
    <subsection name="作用域（Scope）和生命周期">
      <p>理解我们目前已经讨论过的不同作用域和生命周期类是至关重要的，因为错误的使用会导致非常严重的并发问题。</p>
      <hr/>
      <p>
        <span class="label important">提示</span>
        <strong>对象生命周期和依赖注入框架</strong>
      </p>
      <p>
        依赖注入框架可以创建线程安全的、基于事务的 SqlSession
        和映射器，并将它们直接注入到你的 bean 中，因此可以直接忽略它们的生命周期。
        如果对如何通过依赖注入框架来使用 MyBatis 感兴趣，可以研究一下 MyBatis-Spring
        或 MyBatis-Guice 两个子项目。</p>
      <hr/>
      <h4>SqlSessionFactoryBuilder</h4>
        <p>
          这个类可以被实例化、使用和丢弃，一旦创建了 SqlSessionFactory，就不再需要它了。
          因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域（也就是局部方法变量）。
          你可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory
          实例，但是最好还是不要让其一直存在，以保证所有的 XML 解析资源可以被释放给更重要的事情。
        </p>
      <h4>SqlSessionFactory</h4>
        <p>
          SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在，没有任何理由丢弃它或重新创建另一个实例。
          使用 SqlSessionFactory 的最佳实践是在应用运行期间不要重复创建多次，多次重建
          SqlSessionFactory 被视为一种代码“坏味道（bad smell）”。因此
          SqlSessionFactory 的最佳作用域是应用作用域。
          有很多方法可以做到，最简单的就是使用单例模式或者静态单例模式。
        </p>
      <h4>SqlSession</h4>
        <p>
          每个线程都应该有它自己的 SqlSession 实例。SqlSession
          的实例不是线程安全的，因此是不能被共享的，所以它的最佳的作用域是请求或方法作用域。
          绝对不能将 SqlSession 实例的引用放在一个类的静态域，甚至一个类的实例变量也不行。
          也绝不能将 SqlSession 实例的引用放在任何类型的托管作用域中，比如 Servlet 框架中的 HttpSession。
          如果你现在正在使用一种 Web 框架，要考虑 SqlSession 放在一个和 HTTP 请求对象相似的作用域中。
          换句话说，每次收到的 HTTP 请求，就可以打开一个 SqlSession，返回一个响应，就关闭它。
          这个关闭操作是很重要的，你应该把这个关闭操作放到 finally 块中以确保每次都能执行关闭。
          下面的示例就是一个确保 SqlSession 关闭的标准模式：
        </p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  // 你的应用逻辑代码
}]]></source>
        <p>在你的所有的代码中一致地使用这种模式来保证所有数据库资源都能被正确地关闭。</p>

      <h4>映射器实例</h4>
        <p>
          映射器是一些由你创建的、绑定你映射的语句的接口。映射器接口的实例是从
          SqlSession 中获得的。因此从技术层面讲，任何映射器实例的最大作用域是和请求它们的
          SqlSession 相同的。尽管如此，映射器实例的最佳作用域是方法作用域。
          也就是说，映射器实例应该在调用它们的方法中被请求，用过之后即可丢弃。
          并不需要显式地关闭映射器实例，尽管在整个请求作用域保持映射器实例也不会有什么问题，但是你很快会发现，像
          SqlSession 一样，在这个作用域上管理太多的资源的话会难于控制。
          为了避免这种复杂性，最好把映射器放在方法作用域内。下面的示例就展示了这个实践：
        </p>
        <source><![CDATA[try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // 你的应用逻辑代码
}
]]></source>

      </subsection>
    </section>
  </body>
</document>
