MyBatis框架

第1章 MyBatis简介

1.1 MyBatis历史

1）MyBatis是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation 迁移到了Google Code，随着开发团队转投Google Code旗下， iBatis3.x 正式更名为MyBatis ，代码于2013年11月迁移到Github。

2）MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发 者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection创 建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。

3） Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatemnt、 CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终 执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。

4）iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis 提供的持久层框架包括SQL Maps和Data Access Objects（DAO）。

1.2 MyBatis简介

1） MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架。

2） MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。

3） MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO（Plain Old Java Objects，普通的Java对象）映射成数据库中的记录。

4） 半自动ORM（Object Relation Mapping对象关系映射）框架。

1.3 为什么要使用MyBatis – 现有持久化技术的对比

1）JDBC开发步骤

①加载数据库驱动

②创建并获取数据库链接

③创建jdbc statement对象

④设置sql语句

⑤设置sql语句中的参数(使用preparedStatement)

⑥通过statement执行sql并获取结果

⑦对sql执行结果进行解析处理

⑧释放资源(resultSet、preparedstatement、connection)

示例：

public static void main(String[] args) {
	Connection connection = null;
	PreparedStatement preparedStatement = null;
	ResultSet resultSet = null;
  
	try {
		// 加载数据库驱动
		Class.forName("com.mysql.jdbc.Driver");

		// 通过驱动管理类获取数据库链接
		connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8", "root", "root");
		// 定义sql语句 ?表示占位符
		String sql = "select * from user where username = ?";
		// 获取预处理statement
		preparedStatement = connection.prepareStatement(sql);
		// 设置参数，第一个参数为sql语句中参数的序号（从1开始），第二个参数为设置的参数值
		preparedStatement.setString(1, "李丽");
		// 向数据库发出sql执行查询，查询出结果集
		resultSet = preparedStatement.executeQuery();
		// 遍历查询结果集
		while (resultSet.next()) {
			System.out.println(resultSet.getString("id") + "  " + resultSet.getString("username"));
		}
	} catch (Exception e) {
		e.printStackTrace();
	} finally {
		// 释放资源
		if (resultSet != null) {
			try {
				resultSet.close();
			} catch (SQLException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
		if (preparedStatement != null) {
			try {
				preparedStatement.close();
			} catch (SQLException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
		if (connection != null) {
			try {
				connection.close();
			} catch (SQLException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
		}
	}
}

上边使用jdbc的原始方法（未经封装）实现了查询数据库表记录的操作。

JDBC存在的问题:

①、数据库连接创建、释放频繁造成系统资源浪费，从而影响系统性能。如果使用数据库连接池可解决此问题。

②、Sql语句在代码中硬编码，造成代码不易维护，实际应用中sql变化的可能较大，sql变动需要改变java代码。

③、使用preparedStatement向占有位符号传参数存在硬编码，因为sql语句的where条件不一定，可能多也可能少，修改sql还要修改代码，系统不易维护。

④、对结果集解析存在硬编码（查询列名），sql变化导致解析代码变化，系统不易维护，如果能将数据库记录封装成pojo对象解析比较方便。

2） Hibernate和JPA

① 长难复杂SQL，对于Hibernate而言处理也不容易

② 内部自动生产的SQL，不容易做特殊优化

③ 基于全映射的全自动框架，大量字段的POJO进行部分映射时比较困难。导致数据库性能下降

3）MyBatis

① 对开发人员而言，核心sql还是需要自己优化

② sql和java编码分开，功能边界清晰，一个专注业务、一个专注数据

第2章 MyBatis HelloWorld

Mybatis的架构图：

2.1 开发环境的准备

0) 创建Java project,新建lib包

1) 导入MyBatis框架的jar包、Mysql驱动包、log4j的jar包

myBatis-3.4.1.jar

mysql-connector-java-5.1.37-bin.jar

log4j.jar

2) 导入log4j.xml 的配置文件

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
 
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
 
 <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
   <param name="Encoding" value="UTF-8" />
   <layout class="org.apache.log4j.PatternLayout">
    <param name="ConversionPattern" value="%-5p %d{MM-dd HH:mm:ss,SSS} %m  (%F:%L) \n" />
   </layout>
 </appender>
 <logger name="java.sql">
   <level value="debug" />
 </logger>
 <logger name="org.apache.ibatis">
   <level value="info" />
 </logger>
 <root>
   <level value="debug" />
   <appender-ref ref="STDOUT" />
 </root>
</log4j:configuration>

3）创建项目

2.2 创建测试表

-- 创建库
CREATE DATABASE test_mybatis;
-- 使用库
USE test_mybatis;
-- 创建表
CREATE TABLE tbl_employee(
   id INT(11) PRIMARY KEY AUTO_INCREMENT,
   last_name VARCHAR(50),
   email VARCHAR(50),
   gender CHAR(1)
);

2.3 创建实体类javaBean

public class Employee {

	private Integer id ; 
	private String lastName; 
	private String email ;
	private String gender ;
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getLastName() {
		return lastName;
	}
	public void setLastName(String lastName) {
		this.lastName = lastName;
	}
	public String getEmail() {
		return email;
	}
	public void setEmail(String email) {
		this.email = email;
	}
	public String getGender() {
		return gender;
	}
	public void setGender(String gender) {
		this.gender = gender;
	}
	@Override
	public String toString() {
		return "Employee [id=" + id + ", lastName=" + lastName + ", email=" + email + ", gender=" + gender + "]";
	}

2.3 创建MyBatis的全局配置文件

1) 参考MyBatis的官网手册

mybatis-config.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="com.mysql.jdbc.Driver" />
				<property name="url" value="jdbc:mysql://localhost:3306/test_mybatis" />
				<property name="username" value="root" />
				<property name="password" value="1234" />
			</dataSource>
		</environment>
	</environments>
	<!-- 引入SQL映射文件,Mapper映射文件 	-->
	<mappers>
		<mapper resource="EmployeeMapper.xml" />
	</mappers>
</configuration>

2.4 创建Mybatis的sql映射文件

1) 参考MyBatis的官方手册

EmployeeMapper.xml 配置如下：

<?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="suibian">
	<select id="selectEmployee" resultType="com.atguigu.myabtis.helloWorld.Employee">
		select id ,last_name lastName ,email ,gender from tbl_employee where id = #{id}
		<!-- select * from tbl_employee  where id = #{id} -->
	</select>
</mapper>

Tip:需要在mybatis-config.xml 中引入。

2.5 测试

1) 参考MyBatis的官方手册

@Test
	public void test() throws Exception {
		String resource = "mybatis-config.xml";
		InputStream inputStream = Resources.getResourceAsStream(resource);
		SqlSessionFactory sqlSessionFactory = 
					new SqlSessionFactoryBuilder().build(inputStream);
		System.out.println(sqlSessionFactory);
		SqlSession session  = sqlSessionFactory.openSession();
		try {
			Employee employee = 
					session.selectOne("suibian.selectEmployee", 1001);
			System.out.println(employee);
		} finally {
			session.close();
		}
	}

2.6 Mapper接口开发MyBatis HelloWorld

1) 编写Mapper接口（不用编写实现类）

3) 完成两个绑定

//Mapper接口开发需要遵循以下规范：

①XxxMapper.xml文件中的namespace与XxxMapper接口的类路径相同。

②XxxMapper接口方法名和XxxMapper.xml中定义的每个。

statement（select/update/insert/delete）的id相同 。

③XxxMapper接口方法的输入参数类型和XxxMapper.xml中定义的每个sql

的parameterType的类型相同。

④XxxMapper接口方法的输出参数类型和XxxMapper.xml中定义的每个sql的

resultType的类型相同。

3) 获取Mapper接口的代理实现类对象

@Test
	public void test()  throws Exception{
		String resource = "mybatis-config.xml";
		InputStream inputStream =
                 Resources.getResourceAsStream(resource);
		SqlSessionFactory sqlSessionFactory = 
				new SqlSessionFactoryBuilder()
              .build(inputStream);		
		SqlSession session =  sqlSessionFactory.openSession();
		try {
			//Mapper接口:获取Mapper接口的 代理实现类对象
			EmployeeMapper mapper =
                 session.getMapper(EmployeeMapper.class);		
			Employee employee =  mapper.getEmployeeById(1006);
			System.out.println(employee);
		} finally {
			session.close();
		}
	}
 * Mapper接口开发的好处:
			 * 	 1. 有更明确的类型
			 * 	 2. 接口本身: 接口本身就是抽象. 抽出了规范. 
			 * 	EmployeeDao: EmployeeDaoJdbcImpl 、 EmployeeDaoHibernateImpl、MyBatis代理实现类 
			 
#{}表示一个占位符号，通过#{}可以实现preparedStatement向占位符中设置值，自动进行java类型和jdbc类型转换。#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。 如果parameterType传输单个简单类型值，#{}括号中可以是value或其它名称。

${}表示拼接sql串，通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换， ${}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，${}括号中只能是value。

* Mapper接口开发的好处:

* 1. 有更明确的类型

* 2. 接口本身: 接口本身就是抽象. 抽出了规范.

* EmployeeDao: EmployeeDaoJdbcImpl 、 EmployeeDaoHibernateImpl、MyBatis代理实现类

#{}表示一个占位符号，通过#{}可以实现preparedStatement向占位符中设置值，自动进行java类型和jdbc类型转换。#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。 如果parameterType传输单个简单类型值，#{}括号中可以是value或其它名称。

${}表示拼接sql串，通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换， ${}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，${}括号中只能是value。

第3章 MyBatis全局配置文件

3.1 MyBatis全局配置文件简介

1) The MyBatis configuration contains settings and properties that have a dramatic effect on how MyBatis behaves。

MyBatis 的配置文件包含了影响 MyBatis 行为甚深的设置（settings）和属性（properties）信息。

2) 文件结构如下:（也是mybatis-config.xml 中配置的顺序）

3.2 properties属性

1) 可外部配置且可动态替换的，既可以在典型的 Java 属性文件中配置，亦可通过 properties 元素的子元素来配置

<properties>
     <property name="driver" value="com.mysql.jdbc.Driver" />
     <property name="url" 
             value="jdbc:mysql://localhost:3306/test_mybatis" />
     <property name="username" value="root" />
     <property name="password" value="1234" />
 </properties>
写在mybatis-config.xml配置文件 不灵活，使用外部的properties属性文件
	<properties resource="db.properties">
		 <property name="jdbc.driver" value="com.mysql.jdbc.Driver"/> -
	</properties>

2) 然而properties的作用并不单单是这样，你可以创建一个资源文件，名为jdbc.properties的文件,将四个连接字符串的数据在资源文件中通过键值 对(key=value)的方式放置，不要任何符号，一条占一行

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis_1129
jdbc.username=root
jdbc.password=1234

在mybatis-config.xml
<!-- 
		properties: 引入外部的属性文件
			resource: 从类路径下引入属性文件 
			url:  引入网络路径或者是磁盘路径下的属性文件
-->
<properties resource="jdbc.properties" ></properties>

3) 在environment元素的dataSource元素中为其动态设置

<environments default="oracle">
		<environment id="mysql">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" 
                         value="${jdbc.username}" />
				<property name="password" 
                         value="${jdbc.password}" />
			</dataSource>
		</environment>
	</environments>

3.3 settings设置

1) 这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。

2) 包含如下的setting设置:

<settings>
<setting name="cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="multipleResultSetsEnabled" value="true"/>
<setting name="useColumnLabel" value="true"/>
<setting name="useGeneratedKeys" value="false"/>
<setting name="autoMappingBehavior" value="PARTIAL"/>
<setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
<setting name="defaultExecutorType" value="SIMPLE"/>
<setting name="defaultStatementTimeout" value="25"/>
<setting name="defaultFetchSize" value="100"/>
<setting name="safeRowBoundsEnabled" value="false"/>
<setting name="mapUnderscoreToCamelCase" value="false"/>
<setting name="localCacheScope" value="SESSION"/>
<setting name="jdbcTypeForNull" value="OTHER"/>
<setting name="lazyLoadTriggerMethods"
           value="equals,clone,hashCode,toString"/>
</settings>

<setting name="mapUnderscoreToCamelCase" value="true"/>
默认为false，现在设置为true
驼峰命名：用处
如：在mysql的表中有些字段为 last_name，类中的成员变量为lastName
CREATE TABLE tbl_employee(
   id INT(11) PRIMARY KEY AUTO_INCREMENT,
   last_name VARCHAR(50),
   email VARCHAR(50),
   gender CHAR(1)
);
类中的属性
public class Employee {
	private Integer id ; 
	private String lastName; 
	private String email ;
	private String gender ;
}
在XxxMapper.xml 中如果没有使用别名,查询得到此字段的值为null，此时把驼峰命名设置为true，此时没有使用别名也可取到值
<select id="selectEmployeeById" resultType="com.stackit.beans.Employee">
		select id ,last_name lastName ,email ,gender from tbl_employee where id = #{id}
</select>
<!-- . settings:  包含了很多重要的设置项 -->
	<settings>
		<!-- 映射下划线到驼峰命名 -->
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>

3.4 typeAliases 别名处理

1) 类型别名是为 Java 类型设置一个短的名字，可以方便我们引用某个类。

<typeAliases>
	 	<typeAlias type="com.atguigu.mybatis.beans.Employee" alias="emp"/>
</typeAliases>

2) 类很多的情况下，可以批量设置别名这个包下的每一个类创建一个默认的别名，就是简单类名小写(不区分首字符大小写,不同包类重名,可以在类上使用注解@Aliase自定义)

<typeAliases>
	 	<package name="com.atguigu.mybatis.beans"/>
</typeAliases>

3) MyBatis已经取好的别名

<!-- 3. typeAliases: 别名处理
		 		<typeAlias>: 给某个java类型取别名
		 			type: 指定java的全类名
		 			alias:指定别名. 默认的别名就是类名. 
		 		<package>: 为指定的包以及子包下的类批量取别名. 
		 				      如 果有别名冲突的情况， 可以使用@Alias()注解为冲突的类具体指定别名. 
	 -->
	<typeAliases>
		<!--  <typeAlias type="com.atguigu.mybatis.beans.Employee" alias="employee"/> -->
		<package name="com.atguigu.mybatis.beans"/>
	</typeAliases>

3.5 environments 环境配置

1) MyBatis可以配置多种环境，比如开发、测试和生产环境需要有不同的配置

2) 每种环境使用一个environment标签进行配置并指定唯一标识符

3) 可以通过environments标签中的default属性指定一个环境的标识符来快速的切换环境

4) environment-指定具体环境

id：指定当前环境的唯一标识

transactionManager、和dataSource都必须有

<!-- 4. 环境们 
		environments: Mybatis支持配置多个环境， 通过 default来指定具体使用的环境.
			environment: 具体的环境
				<transactionManager>: 事务管理 
					JDBC   :JdbcTransactionFactory
					MANAGED:ManagedTransactionFactory
					结论: 事务管理将来是交给Spring来做.
				<dataSource>: 数据源
					UNPOOLED :UnpooledDataSourceFactory
					POOLED   :PooledDataSourceFactory
					JNDI     :PooledDataSourceFactory
					结论: 数据源将来交给Spring. -->
<environments default="oracle">
		<environment id="mysql">
			<transactionManager type="JDBC" />
			<dataSource type="POOLED">
				<property name="driver" value="${jdbc.driver}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.username}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
		 <environment id="oracle">
			<transactionManager type="JDBC"/>	
			<dataSource type="POOLED">
				<property name="driver" value="${orcl.driver}" />
				<property name="url" value="${orcl.url}" />
				<property name="username" value="${orcl.username}" />
				<property name="password" value="${orcl.password}" />
			</dataSource>
		</environment> 
	</environments>

5) transactionManager

type： JDBC | MANAGED | 自定义

JDBC：使用了 JDBC 的提交和回滚设置，依赖于从数据源得到的连接来管理事务范围。 JdbcTransactionFactory

MANAGED：不提交或回滚一个连接、让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 ManagedTransactionFactory

自定义：实现TransactionFactory接口，type=全类名/别名

6) dataSource

type： UNPOOLED | POOLED | JNDI | 自定义

UNPOOLED：不使用连接池， UnpooledDataSourceFactory

POOLED：使用连接池， PooledDataSourceFactory

JNDI： 在EJB 或应用服务器这类容器中查找指定的数据源

自定义：实现DataSourceFactory接口，定义数据源的获取方式。

7) 实际开发中我们使用Spring管理数据源，并进行事务控制的配置来覆盖上述配置

3.6 mappers 映射器

1) 用来在mybatis初始化的时候，告诉mybatis需要引入哪些Mapper映射文件

2) mapper逐个注册SQL映射文件

resource : 引入类路径下的文件

url : 引入网络路径或者是磁盘路径下的文件

class : 引入Mapper接口.

有SQL映射文件 , 要求Mapper接口与 SQL映射文件同名同位置.

没有SQL映射文件 , 使用注解在接口的方法上写SQL语句.

<mappers>
		<mapper resource="EmployeeMapper.xml" />
		<mapper class="com.atguigu.mybatis.dao.EmployeeMapper"/>
		<package name="com.atguigu.mybatis.dao"/>
</mappers>

3) 使用批量注册，这种方式要求SQL映射文件名必须和接口名相同并且在同一目录下

<mappers><!-- 两种都可以 -->
		<package name="com.atguigu.mybatis.dao"/>
       <package name="com/atguigu/mybatis/dao"/>
</mappers>
<mappers><!-- 两种都可以 -->
		<package name="com.stackit.dao"/>
		<package name="com/stackit/dao"/>
</mappers>

先写到1-3章，后续还有4-5章

点赞收藏不迷路，更多精彩，敬请期待！