1 框架
- 百度百科介绍:框架(Framework)是整个或者部分系统的可重用设计,表现为一组抽象构件以及构件实例间交互的方法;另一种定义认为,框架是可被应用功能开发者制定的应用骨架。可以说,一个框架是一个可复用的设计构件,它规定了应用的体系结构,阐明了整个设计、协作构件之间的依赖关系、责任分配和控制流程,表现为一组抽象类以及其实例之间协作的方法,它为构件复用提供了上下文(Context)关系。
- 对于程序员来说,框架是一套资源,这套资源会包含Jar包,文档,还有些会包含源码、代码示例等。这套资源从相关的官网中可以下载。一般是以压缩文件的形式出现的。
1.1 MyBatis的下载
- MyBatis的jar包可以在github官网中下载:https://github.com/mybatis
1.2 MyBatis的Jar包
- MyBatis框架的解压目录中只有一个Jar包,它是MyBatis的核心Jar包。另外,还有个lib目录,其中存放着MyBatis所依赖的Jar包。所以,使用MyBatis,需要将其核心Jar包以及lib下的所有Jar包导入。
- 本专题使用的MyBatis为mybatis-3.3.0版本。
2 MyBatis概述
2.1 MyBatis简介
- MyBatis是一个优秀的基于Java的持久层框架,它内部封装了JDBC,使得开发者只需要关注SQL语句本身,而不用再花费精力去处理诸如注册驱动、创建Connection、配置Statement等繁杂过程。
- MyBatis通过xml或者注解的方式将要执行的各种statement(statement、preparedStatement等)配置起来,并通过Java对象和Statement中SQL的动态参数进行映射生成最终执行的SQL语句,最后由MyBatis的框架执行SQL并将结果映射为Java对象并返回。
2.2 MyBatis和Hibernate
- Hibernate框架是提供了全面的数据库封装机制的“全自动”ORM,即实现了POJO和数据库表之间的映射,以及SQL的自动生成和执行。
- 相对于此,MyBatis只能算是“半自动”ORM。其着力点是,是在POJO类与SQL语句之间的映射关系。也就是说,MyBatis并不会为程序员自动生成SQL语句。具体的SQL需要程序员自己编写,然后通过SQL语句映射文件,将SQL所需要的参数,以及返回的结果字段映射到指定POJO中。因此,MyBatis成为了“全自动”ORM的一种有益补充。
- 与Hibernate相比较,MyBatis具有以下几个特点:
1、在XML文件中配置SQL语句,实现了SQL语句与代码的分离,给程序的维护带来了很大便利;
2、因为需要程序员自己去编写SQL语句,程序员可以结合数据库自身的特点来灵活控制SQL语句,因此能够实现比Hibernate等全自动ORM框架更高的查询效率,能够完成复杂查询。
3、简单,易于学习,易于使用,上手快。2.3 MyBatis的体系结构
3 MyBatis工作原理
4 MyBatis工作原理
- 需求:实现将Student信息写入到DB中。
4.1 基本程序
4.1.1 导入Jar包
- 除了需要导入MyBatis的核心Jar包以及依赖包外,还需要导入MySql的驱动Jar包,JUnit测试的Jar包。核心Jar包以及依赖Jar包,均在MyBatis框架的解压目录下。
4.1.2 定义实体类
public class Student { private Integer id; private String name; private int age; private double score; //无参和有参 //setter and getter() //string() }
4.1.3 在DB中生成表结构,即创建空表
- 注意,由于后面要创建的MyBatis映射文件映射的是SQL语句,而非像Hibernate一样,是类到表,属性到字段的映射。所以,MyBatis要求,在创建数据库表时,字段名要与属性名称一致(当然,不一致时,还可以通过resultMap解决,后面会讲到)
4.1.4 定义Dao接口
public interface IStudentDao { //插入 void insertStudent(Student student); }
4.1.5 定义映射文件
- 映射文件,简称为mapper,主要完成Dao层中SQL语句的映射。具体映射的配置,后面会详细讲解。映射文件名随意,一般放在dao包中。这里的映射文件命名为mapper.xml。
- 映射文件的约束文件mybatis-3-mapper.dtd文件,在MyBatis的核心Jar包的org.apache.ibatis.builder.xml包中存放。当然,主配置文件的约束dtd文件也在该位置存放。
- 在映射文件中添加约束,即配置文件头,可以从MyBatis框架中的文档mybatis-3.3.0.pdf中找到:
- 在pdf中搜索“mybatis-3-mapper.dtd”关键字,即可找到映射文件的约束。
- 映射文件内容为:
<?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="test"> <insert id="insertStu" resultType="com.eason.mybatis.beans.Student"> insert into t_student(name , age, score) values(#{name}, #{age}, #{score}) </insert> </mapper>
- 注意,#{}中写入的是Student类的属性名。
- 对于parameterType属性,框架会自动根据用户执行的SqlSession方法中的参数自动检测到,所以一般我们不用指定parameterType属性。一般写为如下形式:
<mapper namespace="test"> <insert id="insertStu"> insert into t_student(name , age, score) values(#{name}, #{age}, #{score}) <insert> </mapper>
4.1.6 定义主配置文件
- 在主配置文件中添加约束,即配置文件头,可以从MyBatis框架中的额文档mybatis-3.3.0.pdf中找到:
- 在pdf中搜索“mybatis-3-config.dtd"关键字,即可找到映射文件中的约束。
- 主配置文件名也可以随意命名,例如本例定义为mybatis.xml。
- 而对于<dataSource/>标签中<property/>的name属性名称,需要从帮助文档中查找。如下所示:
<?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> <!-- 配置MyBatis运行环境 --> <environments default="myEnv"> <environment id="myEnv"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql:///test"/> <property name="username" value="root"/> <property name="password" value="02000059"/> </dataSource> </environment> </environments> <!-- 注册映射文件 --> <mappers> <mapper resource="com/eason/mybatis/dao/mapper.xml"/> </mappers> </configuration>
4.1.7 定义Dao实现类
public class StudentDaoImpl implements IStudentDao{ private SqlSession session; @Override public void insertStudent(Student student) { try { // 1.读取主配置文件 InputStream inputStream = Resources.getResourceAsStream("mybatis.xml"); // 2.创建SqlSessionFactory对象 SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); // 3.创建SqlSession对象 session = sqlSessionFactory.openSession(); // 4.操作 session.insert("insertStu", student); // 5.SqlSession提交 session.commit(); } catch (IOException e) { e.printStackTrace(); } finally { // 6.SqlSession关闭 if(session != null) { session.close(); } } } }
4.1.8 定义测试类
@Test public void test() { IStudentDao dao = new StudentDaoImpl(); Student student = new Student("赵六", 26, 96.5); dao.insertStudent(student); }
4.1.9 添加日志控制文件
- MyBatis使用Log4j进行日志处理,而Log4j2对此支持并不好,所以在MyBatis中需要将log4j.properties放入到项目的src目录下。
- 若将日志级别设置为debug,则可以显示所执行的SQL语句、参数值、对DB的影响条数等信息。若将级别设置为trace,则还可以显示查询出的每条记录的每个字段名以及值。
-
在MyBatis中,可以指定要输出日志的工作空间的namespace的名字。此时,只会输出该namespace下执行的SQL的日志内容。
##define an appender named console log4j.appender.console=org.apache.log4j.ConsoleAppender #The Target value is System.out or System.err log4j.appender.console.Target=System.out #set the layout type of the apperder log4j.appender.console.layout=org.apache.log4j.PatternLayout #set the layout format pattern log4j.appender.console.layout.ConversionPattern=[%-5p] %m%n ##define a logger log4j.logger.test=debug,console
4.2 使用工具类
- 由于每一次执行SqlSession的方法,均需要首先获取到该对象,而SqlSession对象的获取有相对比较麻烦,所以可以将获取SqlSession对象定义为一个工具类方法。
- SqlSession对象时通过SqlSessionFactory对象创建的。由于SqlSessionFactory类为重量级对象,且为线程安全的,所以可以将SqlSessionFactory对象定义为单例的。
4.2.1 创建工具类
public class MyBatisUtils { private static SqlSessionFactory factory; public static SqlSession getSqlSession() { try { if(factory == null) { //读取主配置文件 InputStream inputStream = Resources.getResourceAsStream("mybatis.xml"); //创建SqlSessionFactory对象 factory = new SqlSessionFactoryBuilder().build(inputStream); } } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } //创建SqlSession对象 return factory.openSession(); } }
4.2.2 修改Dao接口的实现类
-
该实现类使用MyBatisUtils工具类获取SqlSession对象。注意,由于这里没有异常需要处理,但是SqlSession必须要关闭,所以这里的代码必须要有finally{}语句块,但是无需catch{代码块。
public class StudentDaoImpl implements IStudentDao{ private SqlSession session; @Override public void insertStudent(Student student) { try { //使用工具类获取SqlSession对象 session = MyBatisUtils.getSqlSession(); session.insert("insertStu", student); session.commit(); } finally { // 6.SqlSession关闭 if(session != null) { session.close(); } } } }
4.3 从属性文件中读取DB连接四要素
- 为了方便对数据库连接的管理,DB连接四要素数据一般都是存放在一个专门的属性文件中的。MyBatis主配置文件需要从这个属性文件中读取这些数据。
4.3.1 定义属性文件
- 在src下定义属性文件jdbc.properties。
jdbc.driver = com.mysql.jdbc.Dricer jdbc.url = jdbc:mysql:///test jdbc.user = root jdbc.password = 02000059
4.3.2 修改主配置文件
-
对于主配置文件,第一,需要注册属性文件;第二,需要从属性文件中通过key,将其value读取出来。
<configuration> <!-- 注册属性文件 --> <properties resource="jdbc.properties"></properties> <!-- 配置MyBatis运行环境 --> <environments default="myEnv"> <environment id="myEnv"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.user}"/> <property name="password" value="${jdbc.password}"/> </dataSource> </environment> </environments> <!-- 注册映射文件 --> <mappers> <mapper resource="com/eason/mybatis/dao/mapper.xml"/> </mappers> </configuration>
4.4 多个映射文件
- 在真正项目中,一般情况下会有一个Dao接口对应一个映射文件。所以,一个项目中多个映射文件的情况非常普通。
4.4.1 新添加一个映射文件
- 将原来的映射文件直接复制一份,粘贴到相同目录中,并且重新命名,然后,在主配置文件中对其进行注册。
<!-- 注册映射文件 --> <mappers> <mapper resource="com/eason/mybatis/dao/mapper.xml"/> <mapper resource="com/eason/mybatis/dao/mapper2.xml"/> </mappers>
- 此时,再次运行相同的测试,会报错。
Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.builder.BuilderException: Error parsing Mapper XML. The XML location is 'com/eason/mybatis/dao/mapper2.xml'. Cause: java.lang.IllegalArgumentException: Mapped Statements collection already contains value for test.insertStu
- 因为可以匹配上的相同的SQL映射id出现了两个,系统不知道应该执行哪一个。
4.4.2 修改任意一个映射文件
- 因为可以匹配上的相同的SQL映射id出现了两个,系统不知道应该执行哪一个。
- 可以修改任意一个映射文件<mapper/>标签的namespace属性,将两个不同映射文件中的SQL映射,归入为不同的命名空间。
- 命名空间的作用是用于区分不同命名空间中的同名SQL映射的id。例如,将其中的一个namespace修改为eason。
<mapper namespace="eason"> <insert id="insertStu" resultType="com.eason.mybatis.beans.Student"> insert into t_student(name , age, score) values(#{name}, #{age}, #{score}) </insert> </mapper>
4.4.3 修改Dao实现类
- 在Dao实现类中使用时,需要给出具体使用的是哪个命名空间下的SQL映射语句。
@Override public void insertStudent(Student student) { try { //使用工具类获取SqlSession对象 session = MyBatisUtils.getSqlSession(); session.insert("eason.insertStu", student); session.commit(); } finally { // 6.SqlSession关闭 if(session != null) { session.close(); } } }
- 在程序中,即使包含多个命名空间,而所使用的SQL映射在这些命名空间中的id都是唯一的,那么,在使用时不使用命名空间作为前缀,而是直接使用SQL映射的id,也是可以的。但是不建议这样使用。
5 主配置文件详解
- 主配置文件名可以随意命名,其主要完成以下几个功能:
1、注册存放DB连接四要素的属性文件;
2、注册实体类的全限定性类名的别名;
3、配置MyBatis运行环境,即数据源和事务管理器;
4、注册映射文件;5.1 注册DB 连接四要素属性文件
<!-- 注册属性文件 --> <properties resource="jdbc.properties"></properties>
- F2查看其父标签<configuration/>的描述信息可知,<properties/>子标签应该是第一个子标签。
5.2 指定实体类全限定性类名的别名
- 对于实体类的全限定性类名的别名指定方式,一般使用<package/>方式。这样做的好处是会将该包中的所有实体类的简单类名指定为别名,写法简单方便。
<!-- 配置别名 --> <typeAliases> <package name="com.eason.mybatis.dao"/> </typeAliases>
- 不过,还有另外的指定方式:通过<typealias/>指定。(type表示全限定性类名,alias为别名)
- 该方式的好处是,可以指定别名为简单类名以外的其他名称。当然,弊端是,必须逐个指定,比较繁琐。
<!-- 注册类的别名 --> <typeAliases> <typeAlias type="com.eason.mybatis.beans.Student" alias="Student"/> </typeAliases>
- 除了自定义的类型的别名外,MyBatis还提供了内置的类型别名:
- 基本类型:
- 常用包装类型:
5.3 配置MyBatis的运行环境
- 配置MyBatis的运行环境,主要是配置数据源和事务管理器。
5.3.1 <environments/>标签
- 在<environments/>中可以包含多个运行环境<environment/>,但是其default属性指定了当前MyBatis运行时所选择使用的环境。
- <environment/>的id属性为当前定义的运行环境的名称,可以任意命名。该名称会作为<environments/>的default属性的值出现。
5.3.2 <transactionManager/>标签
<!-- 使用jdbc事务管理 --> <transactionManager type="JDBC"/>
- 该标签用于指定MyBatis所使用的事务管理器。MyBatis支持两种事务管理器类型:JDBC与MANAGED。
1、JDBC:使用JDBC的事务管理机制。即,通过Connection的commit()方法提交,通过rollback()方法回滚。但是默认情况下,MyBatis将自动提交功能关闭,改为手动提交。即程序中需要显式的对事务进行提交或者回滚。从日志的输出信息中可以看到:
2、MANAGED:由容器来管理事务的整个生命周期(如Spring容器)5.3.3 <dataSource/>标签
- 该标签用于配置MyBatis使用的数据源类型和数据库连接基本类型。常用的类型有:UNPOOLED、POOLED、JDNI等。
1、UNPOOLED:不使用连接池,即每次请求,都会为其创建一个DB连接,使用完毕后,马上将此连接关闭;
2、POOLED:使用数据库连接池来维护连接;
3、JNDI:数据源可以定义到应用的外部,通过JNDI容器来获取数据库连接;<dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}"/> <property name="url" value="${jdbc.url}"/> <property name="username" value="${jdbc.user}"/> <property name="password" value="${jdbc.password}"/> </dataSource>
- 如上示例,从属性文件中获取DB连接四要素的信息。
5.4 指定映射文件
- 指定映射文件的方式有很多中,但是所有的方式中,都是指定在<mappers/>标签中。
5.4.1 <mapper resource=""/>指定映射文件
- 若映射文件只有一个,则可直接使用如下形式:
<!-- 注册映射文件 --> <mappers> <mapper resource="com/eason/mybatis/dao/mapper.xml"/> </mappers>
- 若映射文件有多个,则可使用如下形式:
<!-- 注册映射文件 --> <mappers> <mapper resource="com/eason/mybatis/dao/mapper.xml"/> <mapper resource="com/eason/mybatis/dao/mapper2.xml"/> </mappers>
5.4.2 <mapper url=""/>指定映射文件(了解)
- 该方式的好处是,可以将映射文件放在本地或者网络的任意位置,通过其url地址即可直接访问。但是通常映射文件是存放在当前应用中的,所以该方式不常用。
5.4.3 <mapper class=""/>指定映射文件
- class属性值为Dao接口的全类名。
<!-- 注册映射文件 --> <mappers> <mapper class="com.eason.mybatis.dao.IStudentDao"/> </mappers>
- 该方式的使用,需要满足以下几个要求:
1、映射文件名要与Dao接口名称相同;
2、映射文件要与接口在同一个包中;
3、映射文件中<mapper/>的namespace属性值为Dao接口的全类名;<mapper namespace="com.eason.mybatis.dao.IStudentDao"> <insert id="insertStu" resultType="com.eason.mybatis.beans.Student"> insert into t_student(name , age, score) values(#{name}, #{age}, #{score}) </insert> </mapper>
5.4.4 <package name=""/>指定映射文件
- 当映射文件较多时,也可以使用如下形式。其中package的name属性指定映射文件所存放的包:
<!-- 注册映射文件 --> <mappers> <package name="com.eason.mybatis.dao"/> </mappers>
- 但是,这种方式的使用需要满足以下几个条件:
1、dao使用mapper动态代理实现;(后面专题会说明)
2、映射文件名要Dao接口名称相同;
3、映射文件要与接口在同一个包内;
4、映射文件中<mapper/>的namespace属性值为Dao接口的全类名;6 API详解
- Dao中需要通过SqlSession对象来操作DB,而SqlSession对象的创建,需要其工厂对象SqlSessionFactory。SqlSessionFactory对象,需要通过其构造器SqlSessionFactoryBuilder的build()方法,在加载了主配置文件的输入流对象后创建。
6.1 Resources类
- Resources类,顾名思义就是资源,用于读取资源文件,其有很多方法通过加载并解析资源文件,并返回不同类型的IO流对象。
6.2 SqlSessionFactoryBuilder类
- SqlSessionFactory的创建,需要使用SqlSessionFactoryBuilder对象的build()方法。由于SqlSessionFactoryBuilder对象在创建完工厂对象后,就完成了历史使命,即可被销毁。所以,一般会将该SqlSessionFactoryBuilder对象创建为一个方法内的局部对象,方法结束,对象被销毁。
- 其被重载的build()方法较多:
6.3 SqlSessionFactory接口
- SqlSessionFactory接口对象是一个重量级对象(系统开销大的对象),是线程安全的。所以一个应用只需要一个该对象即可。创建SqlSession需要使用SqlSessionFactory接口的openSession()方法。
1、openSession(true):创建一个有自动提交功能的SqlSession;
2、openSession(false):创建一个非自动提交功能的SqlSession,需要手动提交;
3、 penSession():同openSession(false);6.4 SqlSession接口
- SqlSession接口对象用于执行持久化操作。一个SqlSession对应着一次数据库会话,一次会话以SqlSession对象的创建开始,以SqlSession对象的关闭结束。
- SqlSession对象是线程不安全的,所以每次数据库会话结束前,需要马上调用其close()方法,将其关闭。再次需要会话,则再次进行创建。而在关闭时会判断当前的SqlSession是否被提交;若没有被提交,则会执行回滚后关闭;若已经被提交,则直接将SqlSession关闭,所以,SqlSession无需手工回滚。
- SqlSession接口常用的方法有:
6.5 源码分析
6.5.1 输入流的关闭
- 在输入流对象使用完毕后,不用手工进行流的关闭。因为在输入流被使用完毕后,SqlSessionFactoryBuilder对象的build()方法中会自动将输入流进行关闭。
6.5.2 SqlSession的创建
- SqlSession对象的创建,需要使用SqlSessionFactory接口对象的openSession()方法。SqlSessionFactory接口的实现类为DefaultSqlSessionFactory。
- 从以上源码中可以看到,无参的openSession()方法,将事务的自动提交直接赋值为false。而所谓创建SqlSession,就是加载了主配置文件,创建了一个执行器对象(将用来执行映射文件中的SQL语句),初始化一个DB数据被修改的标志变量dirty,关闭了事务的自动提交功能。
6.5.3 增删改的执行
- 对于SqlSession的insert()、delete()、update()方法,其底层均是调用执行了update()方法。
- 从以上源码可知,无论是执行增、删还是改操作,均是对数据进行了修改,均将dirty变量设置为了true,且在获取到映射文件中指定的id的SQL语句后,由执行器executor执行。
6.5.4 SqlSession的提交commit()
- 由以上代码可知,isCommitOrRollbackRequired(force)方法的返回值为true,继续跟踪executor的commit()方法:
- 由以上代码可知,执行SqlSession的无参commit()方法,最终会将事务进行提交。
6.5.5 SqlSession的关闭
- 由以上代码可知,isCommitOrRollbackRequired(force)方法的返回值为true。继续跟踪executor的close()方法:
- 再跟踪Executor接口的BaseExecutor抽象类的close()方法:
- 从以上代码分析可知,在SqlSession进行关闭时,会将事务回滚后关闭。所以,对于MyBatis程序,无需通过显式地对SqlSession进行回滚,达到事务回滚的目的。
转载于:https://blog.51cto.com/12402717/2092540