什么是 MyBatis
MyBatis
是一款优秀的持久层框架,它支持定制化 SQL
、存储过程以及高级映射。MyBatis
避免了几乎所有的 JDBC
代码和手动设置参数以及获取结果集。MyBatis
可以使用简单的 XML
或注解来配置和映射原生信息,将接口和 Java
的 POJOs
(Plain Old Java Objects
,普通的 Java
对象)映射成数据库中的记录。
MyBatis
让程序员将主要精力放在SQL
上,通过MyBatis
提供的映射方式,自由灵活生成(半自动化,大部分需要程序员编写SQL
)满足需要的SQL
语句。
MyBatis
可以将向preparedStatement
中的输入参数自动进行输入映射,将查询结果集灵活映射成Java对象(输出映射)。
MyBatis框架
SqlMapConfig.xml
(是MyBatis
的全局配置文件,名称不固定),配置了数据源、事务等MyBatis
运行环境,配置映射文件(配置SQL
语句)。SqlSessionFactory
(会话工厂),根据配置文件创建工厂。作用:创建SqlSession
。SqlSession
(会话),是一个接口,面向用户(程序员)的接口。作用:操作数据库(发出SQL增、删、改、查)。Executor
(执行器),是一个接口(基本执行器、缓存执行器)。作用:SqlSession
内部通过执行器操作数据库。mapped statement
(底层封装对象)。作用:对操作数据库存储封装,包括SQL语句、输入参数、输出结果类型。
安装
要使用 MyBatis
, 只需将 mybatis-x.x.x.jar
文件置于 classpath
中即可。
如果使用 Maven
来构建项目,则需将下面的 dependency
代码置于 pom.xml
文件中:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>x.x.x</version>
</dependency>
从 XML 中构建 SqlSessionFactory
每个基于 MyBatis
的应用都是以一个 SqlSessionFactory
的实例为中心的。SqlSessionFactory
的实例可以通过 SqlSessionFactoryBuilder
获得。而 SqlSessionFactoryBuilder
则可以从 XML
配置文件或一个预先定制的 Configuration
的实例构建出 SqlSessionFactory
的实例。
XML
配置文件(configuration XML
)中包含了对 MyBatis
系统的核心设置,包含获取数据库连接实例的数据源(DataSource
)和决定事务作用域和控制方式的事务管理器(TransactionManager
)。XML
配置文件一个简单的示例:
<?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
文件中进行配置,上面的示例指出的则是最关键的部分。要注意 XML
头部的声明,用来验证 XML
文档正确性。
environment
元素体中包含了事务管理和连接池的配置。mappers
元素则是包含一组mapper
映射器(这些mapper
的XML
文件包含了SQL
代码和映射定义信息)。
不使用 XML 构建 SqlSessionFactory
如果你更愿意直接从 Java
程序而不是 XML
文件中创建 configuration
,或者创建你自己的 configuration
构建器,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
映射对于大多数高级映射(比如:嵌套 Join
映射)来说仍然是必须的。有鉴于此,如果存在一个对等的 XML
配置文件的话,MyBatis
会自动查找并加载它(这种情况下, BlogMapper.xml
将会基于类路径和 BlogMapper.class
的类名被加载进来)。
从 SqlSessionFactory 中获取 SqlSession
既然有了 SqlSessionFactory
,顾名思义,我们就可以从中获得 SqlSession
的实例了。SqlSession
完全包含了面向数据库执行 SQL
命令所需的所有方法。你可以通过 SqlSession
实例来直接执行已映射的 SQL
语句。例如:
SqlSession session = sqlSessionFactory.openSession();
try {
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
} finally {
session.close();
}
诚然这种方式能够正常工作,并且对于使用旧版本 MyBatis
的用户来说也比较熟悉,不过现在有了一种更直白的方式。使用对于给定语句能够合理描述参数和返回值的接口(比如说BlogMapper.class
),你现在不但可以执行更清晰和类型安全的代码,而且还不用担心易错的字符串字面值以及强制类型转换。例如:
SqlSession session = sqlSessionFactory.openSession();
try {
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
} finally {
session.close();
}
探究已映射的 SQL 语句
在上面提到的两个例子中,一个语句应该是通过 XML
定义,而另外一个则是通过注解定义。
先看 XML
定义这个,事实上 MyBatis
提供的全部特性可以利用基于 XML
的映射语言来实现。这里给出一个基于 XML 映射语句的示例,它应该可以满足上述示例中 SqlSession
的调用:
<?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
头部和文档类型声明占去的部分就显得微不足道了。文件的剩余部分具有很好的自解释性。在命名空间“org.mybatis.example.BlogMapper
”中定义了一个名为“selectBlog
”的映射语句,这样它就允许你使用指定的完全限定名“org.mybatis.example.BlogMapper.selectBlog
”来调用映射语句,就像上面的例子中做的那样:
Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
这和使用完全限定名调用 Java
对象的方法是相似的,之所以这样做是有原因的。这个命名可以直接映射到在命名空间中同名的 Mapper
类,并将已映射的 select
语句中的名字、参数和返回类型匹配成方法。这样你就可以像上面那样很容易地调用这个对应 Mapper
接口的方法。
- 命名空间(
Namespaces
)在之前版本的MyBatis
中是可选的,这样容易引起混淆因此毫无益处。现在命名空间则是必须的,且意于简单地用更长的完全限定名来隔离语句。 - 命名空间使得你所见到的接口绑定成为可能,尽管你觉得这些东西未必用得上,你还是应该遵循这里的规定以防哪天你改变了主意。出于长远考虑,使用命名空间,并将它置于合适的 Java 包命名空间之下,你将拥有一份更加整洁的代码并提高了
MyBatis
的可用性。
命名解析:为了减少输入量,MyBatis
对所有的命名配置元素(包括语句,结果映射,缓存等)使用了如下的命名解析规则:
- 完全限定名(比如“
com.mypackage.MyMapper.selectAllThings
”)将被直接查找并且找到即用。 - 短名称(比如“
selectAllThings
”)如果全局唯一也可以作为一个单独的引用。如果不唯一,有两个或两个以上的相同名称(比如“com.foo.selectAllThings
”和“com.bar.selectAllThings
”),那么使用时就会收到错误报告说短名称是不唯一的,这种情况下就必须使用完全限定名。
让我们再看一遍下面的例子:
BlogMapper mapper = session.getMapper(BlogMapper.class);
Blog blog = mapper.selectBlog(101);
第二种方法(通过注解定义)有很多优势,首先它不是基于字符串常量的,就会更安全;其次,如果你的 IDE
有代码补全功能,那么你可以在有了已映射 SQL
语句的基础之上利用这个功能。
对于像 BlogMapper
这样的映射器类(Mapper class
)来说,还有另一招来处理。它们的映射的语句可以不需要用 XML
来做,取而代之的是可以使用 Java
注解。比如,上面的 XML
示例可被替换如下:
package org.mybatis.example;
public interface BlogMapper {
@Select("SELECT * FROM blog WHERE id = #{id}")
Blog selectBlog(int id);
}
对于简单语句来说,注解使代码显得更加简洁,然而 Java
注解对于稍微复杂的语句就会力不从心并且会显得更加混乱。因此,如果你需要做很复杂的事情,那么最好使用 XML
来映射语句。
选择何种方式以及映射语句的定义的一致性对你来说有多重要这些完全取决于你和你的团队。换句话说,永远不要拘泥于一种方式,你可以很轻松的在基于注解和 XML
的语句映射方式间自由移植和切换。