MyBatis的读音是:[mai’bətɪs],中文音译:麦-波蒂斯,MyBatis的前世是ibatis,这个词是由"internet"和"abatis"组合而成,创始人是Clinton Begin。
abatis的读音是:['æbətɪs],其含义是:篱笆墙。篱笆墙又叫栅栏、护栏,是用来保护院子的一种设施,一般都是由木头,棍子,竹子,芦苇、灌木或者石头构成,常见于我国北方农村以及欧美等地广人稀的国家,用于保护院子。
ibatis一词来源于"internet"和"abatis"的组合,其目的是想当做互联网的篱笆墙,是围绕着数据库提供持久化服务的一个框架。并且是一款优秀的持久层框架,它支持自定义SQL、存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。MyBatis可以通过简单的XML注解来配置和映射原始类型、接口和Java POJO(Plain Old Java Object,普通老式Java对象)为数据库中的记录。
(1)持久层框架
(2)自定义SQL、存储过程以及高级映射
(3)免除大部分JDBC代码以及设置参数和获取结果集的工作
(4)通过XML注解来配置和映射原始类型、接口和POJO为数据库中的记录
MyBatis是一个优秀的持久层框架,它对JDBC的操作数据库的过程进行封装。这个封装的路线是这样的:java.sql.Statement -> MyBatis的Executor -> MyBatis的SqlSession
MyBatis使开发者只需要关注 SQL 本身,而不需要花费精力去处理例如注册驱动、创建Connection、创建Statement、手动设置参数、结果集检索等JDBC繁杂的过程代码。
MyBatis通过xml或注解的方式将要执行的各种Statement(Statement、PreparedStatement、CallableStatement)配置起来,并通过Java对象和Statement中的SQL进行映射生成最终执行的SQL语句,最后由MyBatis框架执行SQL并将结果映射成Java对象并返回。
Mybatis主要分为三层:
(1)API接口层,暴露给开发者使用。
(2)核心处理层,实现MyBatis内部流程。
(3)基础模块层,提供通用的模块功能,例如缓存、反射等等功能。
1、原生态JDBC程序代码
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
public class Test
{
public static void main(String[] args)
{
Connection connection = null;
PreparedStatement preparedStatement = null;
ResultSet resultSet = null;
try
{
//1、加载数据库驱动
Class.forName("com.mysql.jdbc.Driver");
//2、通过驱动管理类获取数据库链接
connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8","root", "root");
//3、定义sql语句,?表示占位符
String sql = "select * from user where username = ?";
//4、获取预处理statement
preparedStatement = connection.prepareStatement(sql);
//5、设置参数,第一个参数为sql语句中参数的序号(从1开始),第二个参数为设置的参数值
preparedStatement.setString(1, "admin");
//6、向数据库发出sql执行查询,查询出结果集
resultSet = preparedStatement.executeQuery();
//7、遍历查询结果集
while (resultSet.next())
{
System.out.println(resultSet.getString("id") + " " + resultSet.getString("username"));
}
}
catch (Exception e)
{
e.printStackTrace();
}
finally
{
//8、释放资源
if (resultSet != null)
{
try
{
resultSet.close();
}
catch (SQLException e)
{
e.printStackTrace();
}
}
if (preparedStatement != null)
{
try
{
preparedStatement.close();
}
catch (SQLException e)
{
e.printStackTrace();
}
}
if (connection != null)
{
try
{
connection.close();
}
catch (SQLException e)
{
e.printStackTrace();
}
}
}
}
}
2、JDBC问题总结
(1)数据库连接频繁开启和关闭,会严重影响数据库的性能。
(2)代码中存在硬编码,分别是数据库的硬编码和SQL执行部分的硬编码。
1、SqlSessionFactory和SqlSessionFactoryBuilder
SqlSessionFactory是MyBatis的核心对象,它是创建SqlSession的工厂类。
SqlSessionFactory对象的实例可以通过SqlSessionFacotryBuilder对象类获得,而SqlSessionFactoryBuilder则可以从XML配置文件或一个预先定制的Configuration的实例构建出SqlSessionFactory的实例。
每一个MyBatis的应用程序都是以一个SqlSessionFactory实例为核心。同时,SqlSessionFactory是线程安全的,SqlSessionFactory一旦被创建,应该在应用执行期间都存在。在应用运行期间不要重复创建多次,建议使用单例模式。
2、SqlSession
SqlSession是MyBatis的关键对象,类似于JDBC中的Connection,它是应用程序与持久层之间执行交互操作的一个单线程对象。
SqlSession的底层封装了JDBC连接,可以用SqlSession实例来直接执行被映射的SQL语句。
SqlSession是线程不安全的,每个线程都应该有它自己的SqlSession实例,SqlSession的实例不能共享。不能将SqlSession实例的引用当做一个类的静态属性。
第一步:MyBatis通过读取配置文件信息(全局配置文件和映射文件),构造出SqlSessionFactory,即会话工厂。MyBatis配置文件,包括MyBatis全局配置文件和MyBatis映射文件,其中全局配置文件配置了数据源、事务等信息;映射文件配置了SQL执行相关的信息。
第二步:通过SqlSessionFactory,MyBatis可以创建SqlSession(即会话),MyBatis是通过SqlSession来操作数据库的。
第三步:MyBatis操作数据库。SqlSession本身不能直接操作数据库,它是通过底层的Executor执行器接口来操作数据库的。Executor接口有两个实现类,一个是普通执行器,一个是缓存执行器(默认)。Executor执行器要处理的SQL信息是封装到一个底层对象MappedStatement中。该对象包括:SQL语句、输入参数映射信息、输出结果集映射信息。其中输入参数和输出结果的映射类型包括Java的简单类型、HashMap集合对象、POJO对象类型。示例代码如下:
public class App
{
public static void main(String[] args) throws Exception
{
// 读取mybatis-config.xml文件
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
// 初始化mybatis,创建SqlSessionFactory类的实例
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
// 创建Session实例
SqlSession session = sqlSessionFactory.openSession();
// 操作数据库方法一:获得xml映射文件中定义的操作语句
Person p = session.selectOne("cn.mybatis.mydemo.mapper.PersonMapper.selectPersonById", 1);
// 打印Person对象
System.out.println(p);
// 操作数据库方法二:获得mapper接口的代理对象
PersonMapper pm = session.getMapper(PersonMapper.class);
// 直接调用接口的方法,查询id为1的Peson数据
Person p2 = pm.selectPersonById(1);
// 打印Peson对象
System.out.println(p2);
// 提交事务
session.commit();
// 关闭Session
session.close();
}
}
要使用MyBatis,只需将mybatis-x.x.x.jar文件置于类路径(classpath)中即可。
当你使用Maven来构建项目的,则需将下面的依赖代码置于pom.xml文件中:
<dependency>
<groupId>org.mybatisgroupId>
<artifactId>mybatisartifactId>
<version>x.x.xversion>
dependency>
当你使用Spring Boot结合MyBatis开发,可以将以下自动配置代码置于pom.xml文件中:
<dependency>
<groupId>org.mybatis.spring.bootgroupId>
<artifactId>mybatis-spring-boot-starterartifactId>
<version>x.x.xversion>
dependency>
每个基于MyBatis的应用都是以一个SqlSessionFactory的实例为核心的。SqlSessionFactory的实例可以通过SqlSessionFactoryBuilder获得。而SqlSessionFactoryBuilder则可以从XML配置文件或一个预先配置的Configuration实例来构建出SqlSessionFactory实例。
从XML文件中构建SqlSessionFactory的实例非常简单,建议使用类路径下的资源文件进行配置。但也可以使用任意的输出流(InputStream)实例,比如用文件路径字符串或file://URL
构造的输入流。MyBatis包含一个名叫Resource的工具类,它包含一些实用方法,使得从类路径或其他位置加载资源文件更加容易。
String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
XML配置文件中包含了对MyBatis系统的核心配置,包括获取数据库连接实例的数据源(DataSource)以及决定事务作用域和控制方式的事务管理器(TransactionManager)。以下是一个简单示例:
<configuration>
<properties>properties>
<settings>
<setting name="" value=""/>
settings>
<typeAliases>
<typeAlias alias="" type="" />
typeAliases>
<typeHandlers>typeHandlers>
<objectFactory type="">objectFactory>
<plugins>
<plugin interceptor="">plugin>
plugins>
<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>
<databaseIdProvider type="">databaseIdProvider>
<mappers>
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
mappers>
configuration>
除此之外,还有很多可以在XML文件中配置的选项。注意XML头部的声明,它用来验证XML文档的正确性。environment
元素体中包含了事务管理和连接池的配置。mappers
元素则包含了一组映射器(mapper),这些映射器的XML映射文件包含了SQL代码和映射定义信息。
如果想直接通过Java代码而不是XML文件中创建配置,或者想要创建自己的配置建造器,MyBatis也提供了完整的配置类,提供了所有与XML文件等价的配置项。
DataSource dataSource = new DataSource(){
...};
TransactionFactory transactionFactory = new JdbcTransactionFactory();
Environment environment = new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(XxxMapper.class);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
注意该例中,configuration添加了一个映射器类(mapper class)。映射器类是Java类,它们包含SQL映射注解从而避免依赖XML文件。不过,由于Java注解的一些限制以及某些MyBatis映射的复杂性,要使用大多数高级映射(比如:嵌套联合映射),仍然需要使用XML配置。有鉴于此,如果存在一个同名XML配置文件,MyBatis会自动查找并加载它(在这个例子中,基于类和XxxMapper.class的类名,会加载XxxMapper.xml)。
既然有了SqlSessionFactory,顾名思义,我们可以从中获得SqlSession的实例。SqlSession提供了在数据库执行SQL命令所需的所有方法。我们可以通过SqlSession实例来直接执行已映射的SQL语句。例如:
try{
SqlSession sqlSession = sqlSessionFactory.openSession();
Member member = (Member)sqlSession.selectOne("org.lks.mybatis.mybatislearn.dao.MemberDAO.selectById", "admin");
System.out.println(member);
}catch(Exception e){
e.printStackTrace();
}
```k
经过运行,这种方式可以正常工作,但是这是旧版的方式。但是现在有了一种更简洁的方式——使用指定语句的参数和返回值相匹配的接口(比如MemberDAO.class),现在我们的代码不仅更清晰,更加类型安全,还不用担心可能出错的字符串字面值以及强制类型转换。示例如下:
```java
try{
SqlSession sqlSession = sqlSessionFactory.openSession();
MemberDAO memberDAO = sqlSession.getMapper(MemberDAO.class);
System.out.println(memberDAO.selectById("admin"));
}catch(Exception e){
e.printStackTrace();
}
下面就探究一下这段代码究竟做了什么。
上面的例子中,一个语句既可以通过XML定义,也可以通过注解定义。我们先看看XML定义语句的方式,事实上MyBatis提供的所有特性都可以利用基于XML的映射语言来实现,这就是过去MyBatis得以流行的原因之一。下面给出一个基于XML映射的语句的示例,它可以满足上个示例中sqlSession的调用。
<mapper namespace="org.lks.mybatis.mybatislearn.dao.MemberDAO">
<sql id="FIELDS">
mid, password
sql>
<select id="selectById" parameterType="String" resultType="Member">
SELECT
<include refid="FIELDS"/>
FROM member WHERE mid=#{mid}
select>
mapper>
为了这个简单的例子,我们似乎写了不少配置,但其实并不多。在一个XML映射文件中,可以定义无数个映射语句,这样一来,XML头部和文档类型声明部分就显得微不足道了。文档的其它部分很直白,容易理解。它在命名空间org.lks.mybatis.mybatislearn.dao.MemberDAO
中定义了一个名为selectById
的映射语句,这样你就可以用全限定名org.lks.mybatis.mybatislearn.dao.MemberDAO.selectById
来调用映射语句了,就像上面的例子中那样:
Member member = (Member)sqlSession.selectOne("org.lks.mybatis.mybatislearn.dao.MemberDAO.selectById", "admin");
你可能会注意到,这种方式和用全限定名调用Java对象的方式类似。这样,该命名就可以直接映射到在命名空间中同名的映射器类,并将已映射的select语句匹配到对应名称、参数和返回类型的方法。因此你就可以像上面那样,不费吹灰之力地在对应的映射器接口调用方法,就像下面这样:
MemberDAO memberDAO = sqlSession.getMapper(MemberDAO.class);
System.out.println(memberDAO.selectById("admin"));
第二种方法有很多优势,首先它不依赖于字符串字面值,会更安全一点;其次,如果你的IDE有代码补全功能,那么代码补全可以帮你快速选择到映射好的SQL语句。
提示:对命名空间的一点补充
在之前版本的MyBatis中,命名空间(Namespace)的作用并不大,是可选的。但现在,随着命名空间越发重要,你必须只当命名空间。
命名空间的作用有两个,一个是利用更长的全限定名来将不同的语句隔离开来,同时也实现了你上面见到的接口绑定。就算你觉得暂时用不到接口绑定,你也应该遵循这里的规定,以防哪天你改变了主意。长远看来,只要将命名空间置于合适的Java命名空间之中,你的代码会变得更加整洁,也有利于你更方便地使用MyBatis。
命名解析:为了减少输入量,MyBatis对所有具有名称的配置元素(包括语句,结果映射,缓存等)使用了如下的命名解析规则。
(1)全限定名(比如 “com.mypackage.MyMapper.selectAllThings“)将被直接用于查找及使用。
(2)短名称(比如“selectAllThings”)如果全局唯一也可以作为一个单独的引用。如果不唯一,有两个或两个以上的相同名称(比如“com.foo.selectAllThings”和“com.bar.selectAllThings”),那么使用时就会产生“短名称不唯一”的错误,这种情况就必须使用全限定名。
对于像MemberDAO这样的映射器类来说,还有另外一种方法来完成语句映射。它们的映射语句可以不用XML来配置,而可以使用Java注解来配置。比如,上面的XML示例可以被替换成如下的配置:
@Select("SELECT mid, password FROM member WHERE mid = #{mid}")
Member selectById(@Param("mid") String mid);
使用注解来映射简单语句会使代码显得更加简洁,但对于稍微复杂一点的语句,Java注解不仅力不从心,还会让你本就复杂的SQL语句更加混乱不堪。因此,如果你需要做一些很复杂的操作,最好用XML来映射语句。
理解我们之前讨论过的不同作用域和生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题。
提示:对象生命周期和依赖注入框架
依赖注入框架可以创建线程安全的、基于事务的SqlSession和映射器,并将它们直接注入到你的bean中,因此可以直接忽略它们的生命周期。
1、SqlSessionFactoryBuilder
这个类可以被实例化、使用和丢弃,一旦创建了SqlSessionFactory,就不再需要它了。因此SqlSessionFactoryBuilder实例的最佳作用域是方法作用域(也就是局部方法变量)。你可以重用SqlSessionFactoryBuilder来创建多个SqlSessionFactory实例,但最好还是不要一直保留着它,以保证所有的XML解析资源可以被释放给更重要的事情。
2、SqlSessionFactory
SqlSessionFactory一旦被创建就应该在应用运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。使用SqlSessionFactory的最佳实践是在应用运行期间不要重复创建多次,多次重建SqlSessionFactory被视为一种代码“坏习惯”。因此SqlSessionFactory的最佳作用域是应用作用域。有很多的方法可以做到,最简单的就是使用单例模式或者静态单例模式。
3、SqlSession
每个线程都应该有它自己的SqlSession实例。SqlSession的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。绝对不能将SqlSession实例的引用放在一个类的静态域,甚至一个类的实例变量也不行。也绝不能将SqlSession实例的引用放在任何类型的托管作用域中,比如Servlet框架中的HttpSession。如果你现在正在使用一种Web框架,考虑将SqlSession放在一个和HTTP请求相似的作用域中。换句话说,每次收到HTTP请求,就可以打开一个SqlSession,返回一个响应后,就关闭它。这个关闭操作很重要,为了确保每次都能执行关闭操作,你应该把这个关闭操作放到finally块中。下面的示例就是一个确保SqlSession关闭的标准模式:
try(SqlSession session = sqlSessionFactory.openSession()){
//你的应用逻辑代码
}
在所有的代码中都遵循这种使用模式,可以保证所有数据库资源都能被正确地关闭。
4、映射器实例
映射器是一些绑定映射语句的接口。映射器接口的实例是从SqlSession中获得的。虽然从技术层面上来讲,任何映射器实例的最大作用域与请求它们的SqlSession相同。但方法作用域才是映射器实例的最适合的作用域。也就是说,映射器实例应该在调用它们的方法中被获取,使用完毕之后即可丢弃。映射器实例并不需要被显式地关闭。尽管在整个请求作用域保留映射器实例不会有什么问题,但是很快会发现,在这个作用域上管理太多像SqlSession的资源会让你忙不过来。因此最好将映射器放在方法的作用域内。示例如下:
try(SqlSession session = sqlSessionFactory.openSession()){
MemberDAO memberDAO = session.getMapper(MemberDAO.class);
//你的应用逻辑代码
}