MyBatis官⽅⽂档——⼊门
⼊门
安装
要使⽤ MyBatis，只需将 jar ⽂件置于 classpath 中即可。
如果使⽤ Maven 来构建项⽬，则需将下⾯的 dependency 代码置于 l ⽂件中：
<dependency>
<groupId&batis</groupId>
<artifactId>mybatis</artifactId>
<version&</version>
</dependency>
从 XML 中构建 SqlSessionFactory
每个基于 MyBatis 的应⽤都是以⼀个 SqlSessionFactory 的实例为中⼼的。SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。⽽SqlSessionFactoryBuilder 则可以从 XML 配置⽂件或⼀个预先定制的 Configuration 的实例构建出 SqlSessionFactory 的实例。
从 XML ⽂件中构建 SqlSessionFactory 的实例⾮常简单，建议使⽤类路径下的资源⽂件进⾏配置。但是也可以使⽤任意的输⼊流(InputStream)实例，包括字符串形式的⽂件路径或者 file:// 的 URL 形式的⽂件路径来配置。MyBatis 包含⼀个名叫 Resources 的⼯具类，它包含⼀些实⽤⽅法，可使从 classpath 或其他位置加载资源⽂件更加容易。
String resource = "org/mybatis/l";
InputStream inputStream = ResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
  XML 配置⽂件（configuration XML）中包含了对 MyBatis 系统的核⼼设置，包含获取数据库连接实例的数据源（DataSource）和决定事务范围和控制⽅式的事务管理器（TransactionManager）。XML 配置⽂件的详细内容后⾯再探讨，这⾥先给出⼀个简单的⽰例：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-////DTD Config 3.0//EN"
"/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/l"/>
</mappers>
</configuration>
当然，还有很多可以在XML ⽂件中进⾏配置，上⾯的⽰例指出的则是最关键的部分。要注意 XML 头部的声明，⽤来验证 XML ⽂档正确性。environment 元素体中包含了事务管理和连接池的配置。mappers 元素则是包含⼀组 mapper 映射器（这些 mapper 的 XML ⽂件包含了 SQL 代码和映射定义信息）。
不使⽤ XML 构建 SqlSessionFactory
如果你更愿意直接从 Java 程序⽽不是 XML ⽂件中创建 configuration，或者创建你⾃⼰的 configuration 构建器，MyBatis 也提供了完整的配置类，提供所有和 XML ⽂件相同功能的配置项。
DataSource dataSource = BlogDataSource();
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 映射对于⼤多数⾼级映射（⽐如：嵌套 Join 映射）来说仍然是必须的。有鉴于此，如果存在⼀个对等的 XML 配置⽂件的话，MyBatis 会⾃动查并加载它（这种情况下， l 将会基于类路径和BlogMapper.class 的类名被加载进来）。具体细节稍后讨论。
从 SqlSessionFactory 中获取 SqlSession
既然有了 SqlSessionFactory ，顾名思义，我们就可以从中获得 SqlSession 的实例了。SqlSession 完全包含了⾯向数据库执⾏ SQL 命令所需的所有⽅法。你可以通过 SqlSession 实例来直接执⾏已映射的 SQL 语句。例如：
SqlSession session = sqlSessionFactory.openSession();
try {
Blog blog = (Blog) session.selectOne("ample.BlogMapper.selectBlog", 101);
} finally {
session.close();
}
诚然这种⽅式能够正常⼯作，并且对于使⽤旧版本 MyBatis 的⽤户来说也⽐较熟悉，不过现在有了⼀种更直⽩的⽅式。使⽤对于给定语句能够合理描述参数和返回值的接⼝（⽐如说BlogMapper.class），你现在不但可以执⾏更清晰和类型安全的代码，⽽且还不⽤担⼼易错的字符串字⾯值以及强制类型转换。
例如：
SqlSession session = sqlSessionFactory.openSession();
try {
BlogMapper mapper = Mapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
} finally {
session.close();
}
  现在我们来探究⼀下这⾥到底是怎么执⾏的。
探究已映射的 SQL 语句
现在，或许你很想知道 SqlSession 和 Mapper 到底执⾏了什么操作，⽽ SQL 语句映射是个相当⼤的话题，可能会占去⽂档的⼤部分篇幅。不过为了让你能够了解个⼤概，这⾥会给出⼏个例⼦。
在上⾯提到的两个例⼦中，⼀个语句应该是通过 XML 定义，⽽另外⼀个则是通过注解定义。先看 XML 定义这个，事实上 MyBatis 提供的全部特性可以利⽤基于 XML 的映射语⾔来实现，这使得 MyBatis 在过去的数年间得以流⾏。如果你以前⽤过 MyBatis，这个概念应该会⽐较熟悉。不过 XML 映射⽂件已经有了很多的改进，随着⽂档的进⾏会愈发清晰。这⾥给出⼀个基于 XML 映射语句的⽰例，它应该可以满⾜上述⽰例中 SqlSession 的调⽤。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-////DTD Mapper 3.0//EN"
"/dtd/mybatis-3-mapper.dtd">
文档字符串是什么<mapper namespace="ample.BlogMapper">
<select id="selectBlog" resultType="Blog">
select * from Blog where id = #{id}
</select>
</mapper>
  对于这个简单的例⼦来说似乎有点⼩题⼤做了，但实际上它是⾮常轻量级的。在⼀个 XML 映射⽂件中，你想定义多少个映射语句都是可以的，这样下来，XML 头部和⽂档类型声明占去的部分就显得微不⾜道了。⽂件的剩余部分具有很好的⾃解释性。在命名空
间“ample.BlogMapper”中定义了⼀个名为“selectBlog”的映射语句，这样它就允许你使⽤指定的完全限定
名“ample.BlogMapper.selectBlog”来调⽤映射语句，就像上⾯的例⼦中做的那样：
Blog blog = (Blog) session.selectOne("ample.BlogMapper.selectBlog", 101);
  你可能注意到这和使⽤完全限定名调⽤ Java 对象的⽅法是相似的，之所以这样做是有原因的。这个命名可以直接映射到在命名空间中同名的Mapper 类，并在已映射的 select 语句中的名字、参数和返回类型匹配成⽅法。这样你就可以向上⾯那样很容易地调⽤这个对应 Mapper 接⼝的⽅法。不过让我们再看⼀遍下⾯的例⼦：
BlogMapper mapper = Mapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
第⼆种⽅法有很多优势，⾸先它不是基于字符串常量的，就会更安全；其次，如果你的 IDE 有代码补全功能，那么你可以在有了已映射 SQL 语句的基础之上利⽤这个功能。
提⽰命名空间的⼀点注释
命名空间（Namespaces）在之前版本的 MyBatis 中是可选的，容易引起混淆因此是没有益处的。现在的命名空间则是必须的，⽬的是希望能⽐只是简单的使⽤更长的完全限定名来区分语句更进⼀步。
命名空间使得你所见到的接⼝绑定成为可能，尽管你觉得这些东西未必⽤得上，你还是应该遵循这⾥的规定以防哪天你改变了主意。出于长远考虑，使⽤命名空间，并将它置于合适的 Java 包命名空间之下，你将拥有⼀份更加整洁的代码并提⾼了 MyBatis 的可⽤性。
命名解析：为了减少输⼊量，MyBatis 对所有的命名配置元素（包括语句，结果映射，缓存等）使⽤了如下的命名解析规则。
完全限定名（⽐如“package.MyMapper.selectAllThings”）将被直接查并且到即⽤。
短名称（⽐如“selectAllThings”）如果全局唯⼀也可以作为⼀个单独的引⽤。如果不唯⼀，有两个或两个以上的相同名称（⽐
如“com.foo.selectAllThings ”和“com.bar.selectAllThings”），那么使⽤时就会收到错误报告说短名称是不唯⼀的，这种情况下就必须使⽤完全限定名。
对于像 BlogMapper 这样的映射器类（Mapper class）来说，还有另⼀招来处理。它们的映射的语句可以不需要⽤ XML 来做，取⽽代之的是可以使⽤Java 注解。⽐如，上⾯的 XML ⽰例可被替换如下：
ample;
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
对于简单语句来说，注解使代码显得更加简洁，然⽽ Java 注解对于稍微复杂的语句就会⼒不从⼼并且会显得更加混乱。因此，如果你需要做很复杂的事情，那么最好使⽤ XML 来映射语句。
选择何种⽅式以及映射语句的定义的⼀致性对你来说有多重要这些完全取决于你和你的团队。换句话说，
永远不要拘泥于⼀种⽅式，你可以很轻松的在基于注解和 XML 的语句映射⽅式间⾃由移植和切换。
范围（Scope）和⽣命周期
理解我们⽬前已经讨论过的不同范围和⽣命周期类是⾄关重要的，因为错误的使⽤会导致⾮常严重的并发问题。
提⽰对象⽣命周期和依赖注⼊框架
依赖注⼊框架可以创建线程安全的、基于事务的 SqlSession 和映射器（mapper）并将它们直接注⼊到你的 bean 中，因此可以直接忽略它们的⽣命周期。如果对如何通过依赖注⼊框架来使⽤ MyBatis 感兴趣可以研究⼀下 MyBatis-Spring 或 MyBatis-Guice 两个⼦项⽬。
SqlSessionFactoryBuilder
这个类可以被实例化、使⽤和丢弃，⼀旦创建了 SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 实例的最佳范围是⽅法范围（也就是局部⽅法变量）。你可以重⽤ SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例，但是最好还是不要让其⼀直存在以保证所有的 XML 解析资源开放给更重要的事情。
SqlSessionFactory
SqlSessionFactory ⼀旦被创建就应该在应⽤的运⾏期间⼀直存在，没有任何理由对它进⾏清除或重建。使⽤ SqlSessionFactory 的最佳实践是在应⽤运⾏期间不要重复创建多次，多次重建 SqlSessionFactory 被视为⼀种代码“坏味道（bad smell）”。因此 SqlSessionFactory 的最佳范围是应⽤范围。有很多⽅法可以做到，最简单的就是使⽤单例模式或者静态单例模式。
SqlSession
每个线程都应该有它⾃⼰的 SqlSession 实例。SqlSession 的实例不是线程安全的，因此是不能被共享的，所以它的最佳的范围是请求或⽅法范围。绝对不能将 SqlSession 实例的引⽤放在⼀个类的静态域，甚⾄⼀个类的实例变量也不⾏。也绝不能将 SqlSession 实例的引⽤放在任何类型的管理范围中，⽐如 Serlvet 架构中的 HttpSession。如果你现在正在使⽤⼀种 Web 框架，要考虑 SqlSession 放在⼀个和 HTTP 请求对象相似的范围中。换句话说，每次收到的 HTTP 请求，就可以打开⼀个 SqlSession，返回⼀个响应，就关闭它。这个关闭操作是很重要的，你应该把这个关闭操作放到finally 块中以确保每次都能执⾏关闭。下⾯的⽰例就是⼀个确保 SqlSession 关闭的标准模式：
SqlSession session = sqlSessionFactory.openSession();
try {
// do work
} finally {
session.close();
}
  在你的所有的代码中⼀致性地使⽤这种模式来保证所有数据库资源都能被正确地关闭。
映射器实例（Mapper Instances）
映射器是创建⽤来绑定映射语句的接⼝。映射器接⼝的实例是从 SqlSession 中获得的。因此从技术层⾯讲，映射器实例的最⼤范围是和 SqlSession 相同的，因为它们都是从 SqlSession ⾥被请求的。尽管如此，映射器实例的最佳范围是⽅法范围。也就是说，映射器实例应该在调⽤它们的⽅法中被请求，⽤过之后即可废弃。并不需要显式地关闭映射器实例，尽管在整个请求范围（request scope）保持映射器实例也不会有什么问题，但是很快你会发现，像 SqlSession ⼀样，在这个范围上管理太多的资源的话会难于控制。所以要保持简单，最好把映射器放在⽅法范围（method scope）内。下⾯的⽰例就展⽰了这个实践：
SqlSession session = sqlSessionFactory.openSession();
try {
BlogMapper mapper = Mapper(BlogMapper.class);
// do work
} finally {
session.close();
}

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。