MyBatis 3.2.4 官方文档

MyBatis V3.2.4官方文档

目录

MyBatis3.2.4官方文档 (1)

1MyBatis 简介 (4)

2入门 (4)

2.1安装 (4)

2.2从xml构建 SqlSessionFactory (4)

2.3不使用XML构建SqlSessionFactory (5)

2.4从SqlSessionFactory中获取SqlSession (6)

2.5深入研究Mapped SQL语句 (7)

2.6命名空间说明 (7)

2.7范围和生命周期 (8)

3Configuration XML (10)

3.1properties (10)

3.2settings (11)

3.3typeAliases (13)

3.4typeHandlers (15)

3.5Handling Enums (18)

3.6objectFactory (20)

3.7plugins (20)

3.8environments (21)

3.9databaseIdProvider (25)

3.10mappers (25)

4Mapper XML Files (27)

4.1Select (28)

4.2insert，update，delete (29)

4.3sql (32)

4.4Parameters (33)

4.5String Substitution (34)

4.6ResultMap (34)

4.7Advanced Result Maps (36)

4.8鉴别discriminator (48)

4.9Auto-mapping (50)

4.10Cache (51)

5动态SQL (53)

5.1if (54)

5.2Choose(when, otherwise ) (54)

5.3Trim(where, set) (55)

5.4foreach (57)

5.5bind (57)

5.6Multi-db vendor support (57)

5.7Pluggable Scripting Languages For Dynamic SQL (58)

6Java API (59)

6.1应用目录结构 (59)

6.2SqlSessions (60)

7SQL Builder Class (71)

7.1The Problem (71)

7.2The Solution (71)

7.3The SQL Class (72)

7.4SqlBuilder和SelectBuilder（不推荐使用） (75)

8Logging (76)

8.1日志配置 (78)

9附录 (79)

9.1MyBatis与Ibatis比较 (79)

9.2代码示例 (81)

1MyBatis 简介

MyBatis的前身叫iBatis，本是apache的一个开源项目, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis。MyBatis是支持普通SQL 查询、存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及结果集的检索。MyBatis使用简单的XML或注解用于配置和原始映射，将接口和Java的POJOs（Plan Old Java Objects，普通的Java对象）映射成数据库中的记录。

2入门

2.1安装

在classpath路径下加入mybatis-x.x.x.jar包。

假如使用Maven，那么在 pom.xml中加入以下的依赖关系：

org.mybatis

mybatis

x.x.x

2.2从xml构建 SqlSessionFactory

每一个MyBatis的应用程序都以一个SqlSessionFactory 对象的实例为核心。SqlSessionFactory对象的实例可以通过SqlSessionFactoryBuilder对象来获得。SqlSessionFactoryBuilder对象可以从XML配置文件，或从Configuration类的自定义预处理的实例中构建SqlSessionFactory对象。

从XML文件中构建SqlSessionFactory的实例非常简单。这里建议使用classpath的资源文件来配置，但是可以使用任意的Reader实例，这个实例包括由文本文件路径或URL形式的文件路径file://来创建。MyBatis包含了一些工具类，称作为资源，这些工具类包含一些方法，这些方法使得从classspath或其他位置加载资源文件更加简单。

String resource ="org/mybatis/example/mybatis-config.xml";

InputStream inputStream =Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory =new

SqlSessionFactoryBuilder().build(inputStream);

XML配置文件包含对MyBatis系统的核心设置，包含获取数据库连接实例的数据源和决定事务范围和控制的事务管理器。关于XML配置文件的详细内容可以在文档后面找到，这里给出一个简单的示例：

PUBLIC "-////DTD Config 3.0//EN"

"/dtd/mybatis-3-config.dtd">

当然，在XML配置文件中还有很多可以配置的，上面的示例指出的则是最关键的部分。要注意XML头部的声明，需要用来验证XML文档正确性。environment元素体中包含对事务管理和连接池的环境配置。mappers元素是包含一系列mapper列表，这些mapper

的XML文件包含SQL代码和映射定义信息。

2.3不使用XML构建SqlSessionFactory

如果你喜欢从Java程序而不是从XML文件中直接创建配置实例，或创建你自己的配置构建器，MyBatis也提供完整的Configuration 类，提供所有从XML文件中加载配置信息