MyBatis入门案例及全局配置文件

简介

1. 什么是 MyBatis ？

MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生信息，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。

2. Mybatis架构

1. MyBatis配置

   • mybatis.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。
   • mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中映射加载。

2. 通过mybatis环境等配置信息构造SqlSessionFactory即会话工厂

3. 由会话工厂创建sqlSession即会话，操作数据库需要通过sqlSession进行。

4. mybatis底层自定义了Executor执行器接口操作数据库，Executor接口有两个实现，一个是基本执行器,一个是缓存执行器。

5. Mapped Statement也是mybatis一个底层封装对象，它包装了mybatis配置信息及sql映射信息等。mapper.xml文件中一个sql对应一个Mapped Statement对象，sql的id即是Mapped statement的id。

6. Mapped Statement对sql执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行sql前将输入的java对象映射至sql中，输入参数映射就是jdbc编程中对preparedStatement设置参数。

7. Mapped Statement对sql执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor

下载jar包地址：https://github.com/mybatis/mybatis-3

官方文档地址：http://www.mybatis.org/mybatis-3/zh/index.html

 

一、简单入门实例 ：MyBatis3.4.6  

要使用 MyBatis， 只需将 mybatis-x.x.x.jar 文件置于 classpath 中即可。

这里使用 Maven 来构建项目，则需引入依赖即可：

1、pom.xml中引入 mybatis 依赖 

	<dependencies>
<!-- mybatis -->
		<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis</artifactId>
			<version>3.4.6</version>
		</dependency>
<!-- mysql -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.46</version>
		</dependency>
		<dependency>
			<groupId>log4j</groupId>
			<artifactId>log4j</artifactId>
			<version>1.2.17</version>
		</dependency>
		<dependency>
			<groupId>commons-logging</groupId>
			<artifactId>commons-logging</artifactId>
			<version>1.2</version>
		</dependency>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
		</dependency>
	</dependencies>

日志文件：log4j.properties

log4j.rootLogger = debug,stdout, D
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.Threshold = INFO
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p %m%n
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = ./log4j.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern=%d %p %m%n

资源配置文件：application.properties

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis_demo?useUnicode=true&characterEncoding=utf8&useSSL=true
jdbc.user=root
jdbc.password=123456

2、新建mybatis的全局配置文件mybatis.xml (官方文档入门部分有demo,复制)

<?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>
	<!-- 1. 导入资源文件 -->
	<properties resource="application.properties"></properties>
	<settings>
		<!-- 开启自动驼峰命名规则映射,即从经典数据库列名 A_COLUMN 到POJO类属性名 aColumn的类似映射。 -->
		<setting name="mapUnderscoreToCamelCase" value="true"/>
	</settings>	

 	<!-- 2. 配置数据库的连接环境（default为id的值），即默认加载的数据库环境	 -->
	<environments default="mysql">
		<environment id="mysql"> 		<!-- 配置具体的数据库环境    id唯一	 -->
			<transactionManager type="JDBC" />  <!-- 指定使用的事务处理管理器 -->
			<dataSource type="POOLED">  	<!-- 指定使用的数据源连接池		 -->
				<property name="driver" value="${jdbc.driverClass}" />
				<property name="url" value="${jdbc.url}" />
				<property name="username" value="${jdbc.user}" />
				<property name="password" value="${jdbc.password}" />
			</dataSource>
		</environment>
	</environments>
	
	<!-- 3. 引入mapper映射文件 -->
	<mappers>
		<mapper resource="cn/jq/mybatis/dao/UserMapper.xml" />
	</mappers>
</configuration>

3、创建POJO对象和Dao类

model类: User

public class User {
	private int id;
	private String username;
	private String pazzword;
	private Integer state; //0：禁用，1：正常
	private Date regDate; //用户注册时间
...
}

Dao接口: UserMapper

public interface UserMapper {
	/**
	 * 根据id获取一条记录
	 */
	public User getUser(Integer id);
}

4、 新建mybatis的sql映射文件(官方文档入门部分有demo,复制)，即将Dao层接口中的方法和该文件中的标签映射

<?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">

<!-- namespace - 命名空间对应接口的全限定名 -->  
<mapper namespace="cn.jq.mybatis.dao.UserMapper">
	<!-- id - 对应接口中的方法 名称
  	     resultType - 从这条语句中返回的期望类型的类的完全限定名或别名
   -->
	<!-- <select id="getUser" resultType="u"> -->
	<select id="getUser" resultType="cn.jq.mybatis.model.User">
		select * from t_user where id = #{id}
	</select>
</mapper>

5、新建测试方法

public class MybatisTest {
	@Test
	public void test() throws IOException {
		//1. 创建SqlSessionFacotry工厂类对象，根据读取全局配置文件
                Resources.setCharset(Charset.forName("utf-8"));//设置编码格式
		InputStream inputStream = Resources.getResourceAsStream("mybatis.xml");
		SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
		
		//2. 打开数据库连接会话
		SqlSession session = sqlSessionFactory.openSession();
		
		try {
			//3.通过会话操作sql 返回的是代理对象 jdk动态代理
			UserMapper userMapper = session.getMapper(UserMapper.class);
			//4.调用查询一条记录的方法
			User user = userMapper.getUser(1);
			System.out.println(user);
		} finally {
			//关闭会话
			session.close();
		}		
	}
}

User [id=1, username=admin, pazzword=172eee54aa664e9dd0536b063796e54e, state=1, regDate=Sun Oct 14 00:00:00 CST 2018]

  

注意：POJO类的属性名和数据表的字段名不一致时，不要使用*号，通过别名来建立关联（不推荐）

mybatis 使用 <settings> 标签的mapUnderscoreToCamelCase参数来配置

 

二、MyBatis 的全局配置文件：mybatis.xml

MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置（settings）和属性（properties）信息。文档的顶层结构如下：

• configuration 配置
  • properties 属性
  • settings 设置
  • typeAliases 类型别名
  • typeHandlers 类型处理器
  • objectFactory 对象工厂
  • plugins 插件
  • environments 环境
    • environment 环境变量
      • transactionManager 事务管理器
      • dataSource 数据源
  • databaseIdProvider 数据库厂商标识
  • mappers 映射器

1、properties ：主要作用是读取外面的properties属性文件

注意：了解一下即可，因为在项目和spring整合时，数据源是要交个spring管理的，所有肯定不会用这个配置的

2、settings：详细参数见官方文档

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。下表描述了设置中各项的意图、默认值等。

mapUnderscoreToCamelCase

是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。

true | false

False

一个配置完整的 settings 元素的示例如下：

<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>

3、typeAliases

类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关，存在的意义仅在于用来减少类完全限定名的冗余。

 1）全局映射文件

	<typeAliases>
		<!-- 配置别名 
			type - 原来的类型名
			name - 别名 	 -->
		<typeAlias type="cn.jq.mybatis.model.User" alias="uu"/> 
		<!-- 定义一个包 
			在没有注解的情况下，会使用 Bean 的首字母小写的非限定类名来作为它的别名。 若有注解，则别名为其注解值 -->
		<package name="cn.jq.mybatis.model"/>
	</typeAliases>

 2）sql映射文件

<mapper namespace="cn.jq.mybatis.dao.UserMapper">
<!-- 	<select id="getUser" resultType="u11">  -->
	<select id="getUser" resultType="uu"> 
		select * from t_user where id = #{id}
	</select>
</mapper>

 3）POJO类

@Alias("u11")
public class User {
...}

注意：Mybatis已经为一些常见的 Java 类型内建的相应的类型别名。它们都是大小写不敏感的，我们的别名不能和它们重复

4、配置环境（environments）：了解

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者共享相同 Schema 的多个生产数据库， 想使用相同的 SQL 映射。许多类似的用例。

不过要记住：尽管可以配置多个环境，每个 SqlSessionFactory 实例只能选择其一

环境元素（environment）定义了如何配置环境。

 1）事务管理器（transactionManager）

在 MyBatis 中有两种类型的事务管理器（也就是 type=”[JDBC|MANAGED]”）：

• JDBC – 这个配置就是直接使用了 JDBC 的提交和回滚设置，它依赖于从数据源得到的连接来管理事务作用域。
• MANAGED – 这个配置几乎没做什么。它从来不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接，然而一些容器并不希望这样，因此需要将 closeConnection 属性设置为 false 来阻止它默认的关闭行为。

 2）数据源（dataSource）

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

• 许多 MyBatis 的应用程序会按示例中的例子来配置数据源。虽然这是可选的，但为了使用延迟加载，数据源是必须配置的。

有三种内建的数据源类型（也就是 type=”[UNPOOLED|POOLED|JNDI]”）：

UNPOOLED– 这个数据源的实现只是每次被请求时打开和关闭连接。虽然有点慢，但对于在数据库连接可用性方面没有太高要求的简单应用程序来说，是一个很好的选择。 不同的数据库在性能方面的表现也是不一样的，对于某些数据库来说，使用连接池并不重要，这个配置就很适合这种情形。

POOLED– 这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，避免了创建新的连接实例时所必需的初始化和认证时间。 这是一种使得并发 Web 应用快速响应请求的流行处理方式。

JNDI – 这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。

注意： 在项目和spring整合时，数据源是要交个spring管理的，比如c3p0

5、映射器（mappers）

既然 MyBatis 的行为已经由上述元素配置完了，我们现在就要定义 SQL 映射语句了。但是首先我们需要告诉 MyBatis 到哪里去找到这些语句。 Java 在自动查找这方面没有提供一个很好的方法，所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用， 或完全限定资源定位符（包括 file:/// 的 URL），或类名和包名等。

1）使用相对于类路径的资源引用

	<mappers>
		<mapper resource="cn/jq/mybatis/dao/UserMapper.xml" />
	</mappers>

2）使用映射器接口实现类的完全限定类名

	<mappers>
		<mapper class="cn.jq.mybatis.dao.UserMapper" />
	</mappers>

注意：使用class属性来讲mapper文件注入到全部配置文件里，就必须保证mapper的文件名和接口的文件名一样，只是后缀不一样，且必须都在一个包目录里才ok。

使用class属性来配置，还可以使用注解的方式来关联sql语句，不需要写UserDao.xml，只需要在接口的方法上使用注解@Select

public interface UserMapper {
	@Select("select * from t_user where id = #{id}")
	public User getUser(Integer id);
}

在项目开发中，注解上的sql往往是比较简单的和不怎么会修改的，才会使用注解，因为打包发布后，java文件是不能修改的，比较复杂和重要的，可能会修改的sql语句，放到xml配置文件里，这样便于以后维护，两者配合使用。

 3）将包内的映射器接口实现全部注册为映射器（推荐使用）

	<mappers>
		<package name="cn.jq.mybatis.dao" /> 
	</mappers>

注意：xml文件和接口必须同名，且在同一个包里才得行！或者接口和xml文件不在同一个包，必须新建一个资源文件夹，并在新建一个和接口类所在的包名，一样的包，xml文件和接口同名，把xml文件放这里，就可以搞定！视觉上号上不在一起，但发布后在classes这个类路径下看到还是在同一个包里的。

xml全局配置文件 就说到这里， 一般配置好之后，不会修改该文件。