发布时间：2024-01-24 12:30
Mybatis是一个非常简单易上手的框架，只要你对java和数据库足够熟悉，而且通过Mybatis实现对数据的操作非常的简单。
例如完成一个插入操作：
第一步：
在Mapper映射配置文件配置SQL语句，假定文件是StudentMapper.xml
< insert id=“insertStudent” parameterType=“Student”>
insert into students(id,name,age)
values(#{id},#{name},#{age})
< /insert>
第二步：
创建StudentMapper接口
public interface StudentMapper{
void insertStudent(Student student);
}
第三步：
编写java代码完成插入
InputStream inputStream = Resources.getResourceAsStream("mybatis-config.xml");
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
SqlSession sqlSession = sqlSessionFactory.openSession();
StudentMapper mapper = session.getMapper(StudentMapper.class);
mapper.insertStudent(student);
Mybatis只需要一个核心jar包，mybatis-3.x.0.jar。在Mybatis框架中一般需要两种文件，第一种：Mybatis配置文件：mybatis-config.xml，包括数据库的连接信息，类型的别名。第二种：mybatis的映射文件：xxMapper.xml，这个xx是对应类的名字，包括xx类所对应的数据库表的各种增删改查sql语句。
下面我们剖析一下Mybatis配置文件，先来一个典型的
<?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>
<properties resource="application.properties">
<property name="username" value="db_user" />
<property name="password" value="verysecurepwd" />
</properties>
<settings>
<setting name="cacheEnabled" value="true" />
</settings>
<typeAliases>
<typeAlias alias="Student" type="com.briup.pojo.Student" />
<package name="com.briup.pojo" />
</typeAliases>
<typeHandlers>
<typeHandler handler="com.mybatis3.typehandlers.PhoneTypeHandler" />
<package name="com.briup.typehandlers" />
</typeHandlers>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driverClassName}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
<environment id="production">
<transactionManager type="MANAGED" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/jdbc/MyBatisDemoDS" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/briup/mappers/StudentMapper.xml" />
<mapper url="file:///D:/mybatisdemo/mappers/StudentMapper.xml" />
<mapper class="com.briup.mappers.StudentMapper" />
</mappers>
</configuration>
直接看configuration里面的
properties标签：properties标签可以把配置值写死到配置文件中，也可以具体到一个属性文件中，上述的标签里我们把数据库连接的属性配置到了application.properties文件中（< properties resource=“application.properties”>），并且为driver等属性使用了占位符。
在applications.properties文件中配置数据库连接参数，如下所示：
jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
jdbc.url=jdbc:oracle:thin:@127.0.0.1:1521:XE
jdbc.username=test
jdbc.password=test
注意：applications.properties文件中的值优先级更高
settings标签：全局参数设置，大多数情况下使用默认值即可，为了满足特定的需求，默认的全局参数设置可以被覆盖。下面列举一些常用的
< !-- 这个配置使全局的映射器启用或禁用缓存 -->
< setting name=“cacheEnabled” value=“true” />
< !-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载 -->
< setting name=“lazyLoadingEnabled” value=“true” />
< !-- 允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动）需要数据库支持 -->
< setting name=“multipleResultSetsEnabled” value=“true” />
< !-- 使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动 -->
< setting name=“useColumnLabel” value=“true” />
< !-- 允许JDBC支持生成的键。需要适合的驱动。 -->
< setting name=“useGeneratedKeys” value=“false” />
< !-- 指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单、没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况）一对一 一对多 -->
< setting name=“autoMappingBehavior” value=“PARTIAL” />
< !-- 允许在嵌套语句中使用分页（RowBounds）默认false -->
< setting name=“safeRowBoundsEnabled” value=“false” />
< !-- 是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。默认false -->
< setting name=“mapUnderscoreToCamelCase” value=“false” />
typeAliases标签：类型别名
在Mapper配置文件中，对于resultType和parameterType属性值，我们需要使用JavaBean的全限定名。
注:parameterType表示将来调用这个sql语句的时候所传的参数的类型(参数值或者参数对象里面的属性值 用来替换sql语句中的占位符)
resultType表示将来调用这个sql语句的时候所返回的结果的类型(方便mybatis给我们自动封装结果集)
我们可以为全限定名取一个别名，然后就可以在需要用全限定名的情况下改成使用别名。我们可以不用为每一个javaBean单独设定别名，我们只需要配置出需要取别名的类所在的包
< type Aliases>
< package name=“com.pojo” />
< /type Aliases>
如果Student.java和Teacher.java定义在这个包里面，那么别名会分别被注册为student和teacher。
还有第三种取别名的方式，使用注解，@Alias("")，我们只需要在类的声明上面加这个注解，双引号里面填写自己想要设定的别名，@Alias("")会覆盖配置文件中的别名的定义，这个注解需要和< package name = “” />标签一起使用，mybatis会自动查看指定包内的类别名的注解，没有注解就会默认使用类的名字。
typeHandlers标签：类型处理器
当Mybatis将一个java对象作为输入参数执行插入语句的时候，它会创建一个PreparedStatement对象，并且使用setXXX()方法对占位符设置相应的参数值 。这里，XXX可以是int，String，Date 等 Java对象属性类型的任意一个。
<insert id="insertStudent" parameterType="Student">
INSERT INTO STUDENTS(STUD_ID,NAME,EMAIL,DOB)
VALUES(#{studId},#{name},#{email},#{dob})
</insert>
为了执行这个语句，Mybatis将会采取以下行为。
创建一个有占位符的PreparedStatement接口。然后对Student对象的属性studId的类型进行检查，使用合适的setxx方法设置参数。
但是Mybatis是怎么知道对int类型的要用setInteger，对String类型的要用setString的呢，是因为Mybatis是通过使用类型处理器决定的，MyBatis对于以下的类型使用内置的类型处理器：所有的基本数据类型、基本类型的包装类型、 byte[]、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚举类型等。所以当MyBatis发现属性的类型属于上述类型，他会使用对应的类型处理器将值设置到PreparedStatement中，同样地，当SQL结果集封装成java类对象的时候，也有类似的过程。
那如果有一个自定义的类型，怎么存储存储到数据库呢？示例如下：假设表STUDENTS 有一个 PHONE 字段，类型为 VARCHAR2(15)，而 Student类有一个自定义类型属性(PhoneNumber类)
java代码:
PhoneNumber 类定义类型的 phoneNumber 属性。
public class PhoneNumber{
private String countryCode;
private String stateCode;
private String number;
public PhoneNumber(){
}
public PhoneNumber(String countryCode, String stateCode, String number) {
this.countryCode = countryCode;
this.stateCode = stateCode;
this.number = number;
}
public String getAsString() {
return countryCode + "-" + stateCode + "-" + number;
}
// Setters and getters
}
public class Student{
private Integer id;
private String name;
private String email;
private PhoneNumber phone;
// Setters and getters
}
xml配置:
<insert id="insertStudent" parameter Type="Student">
insert into students(name,email,phone)
values(#{name},#{email},#{phone})
</insert>
这里，参数对象中的属性phone的值需要传递给#{phone}；而参数对象的属性phone是 PhoneNumber类型。但是，MyBatis 并不知道该怎样来处理这个类型的对象。
为了让MyBatis明白怎样处理这个自定义的Java对象类型，如PhoneNumber，我们可以创建一个自定义的类型处理器,MyBatis提供了抽象类BaseTypeHandler ，我们可以继承此类创建自定义类型处理器。
代码如下所示:
package com.briup.typehandlers;
import java.sql.CallableStatement;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.apache.ibatis.type.BaseTypeHandler;
import org.apache.ibatis.type.JdbcType;
import com.briup.pojo.PhoneNumber;
public class PhoneTypeHandler extends BaseTypeHandler<PhoneNumber>{
//遇到PhoneNumber参数的时候应该如何在ps中设置值
@Override
public void setNonNullParameter(PreparedStatement ps, int i, PhoneNumber parameter, JdbcType jdbcType)
throws SQLException {
ps.setString(i, parameter.getAsString());
}
//查询中遇到PhoneNumber类型的应该如何封装(使用列名封装)
@Override
public PhoneNumber getNullableResult(ResultSet rs, String columnName) throws SQLException {
return new PhoneNumber(rs.getString(columnName));
}
//查询中遇到PhoneNumber类型的应该如何封装(使用列的下标)
@Override
public PhoneNumber getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
return new PhoneNumber(rs.getString(columnIndex));
}
//CallableStatement使用中遇到了PhoneNumber类型的应该如何封装
@Override
public PhoneNumber getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
return new PhoneNumber(cs.getString(columnIndex));
}
}
最后一旦我们实现了自定义的类型处理器，我们需要在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>
<properties resource="application.properties" />
<type Handlers>
<type Handler handler="com.briup.typehandlers.PhoneTypeHandler" />
</type Handlers>
</configuration>
注册PhoneTypeHandler后, MyBatis就能够将Phone类型的对象值存储到VARCHAR类型的列上。
environments元素
environments是配置mybatis当前工作的数据库环境的地方。
MyBatis可以支持配置多个dataSource环境，可以将应用部署到不同的环境上，如DEV(开发环境)，TEST（测试环境），QA（质量评估环境）,UAT(用户验收环境),PRODUCTION（生产环境），可以通过将默认environments值设置成想要的environment的id值。
有时候，我们可能需要在相同的应用下使用多个数据库,比如我们可能有shoppingcart数据库来存储所有的订单明细；使用reports数据库存储订单明细的合计，用作报告。(也就是如果系统在运行期间如果有【切换数据库环境】的需求,mybatis中也可以很轻松的实现).
如果你的应用需要连接多个数据库，你需要将每个数据库配置成独立的环境，并且为每一个数据库创建一个SqlSessionFactory
例如:
<environments default="shoppingcart">
<environment id="shoppingcart">
<transactionManager type="MANAGED" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/jdbc/ShoppingcartDS" />
</dataSource>
</environment>
<environment id="reports">
<transaction Managertype="MANAGED" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/jdbc/ReportsDS" />
</dataSource>
</environment>
</environments>
我们可以为以上每个环境创建一个SqlSessionFactory
java代码:
inputStream = Resources.getResourceAsStream("mybatis-config.xml");
//默认的环境 default
SqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//统计明细的环境
cartSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream, "shoppingcart");
//统计报表的环境
reportSqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream, "reports");
注意:对于environments,我们可以在其中配置多个environment子元素,同时还需要在environment中配置dataSource和transactionManager元素。
dataSource元素
dataSource表示的是数据源:至少会包括该连接数据库的各种信息
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driverClassName}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
dataSource的类型type属性可以配置成其内置类型之一，如UNPOOLED，POOLED，JNDI。
如果将类型设置成UNPOOLED，MyBatis会为每一个数据库操作创建一个新的连接，使用完了并关闭它，该方式适用于只有小规模数量并发用户的简单应用程序上。
如果将属性设置成POOLED，MyBatis会创建一个数据库连接池，连接池中的一个连接将会被用作数据库操作。一旦数据库操作完成，MyBatis会将此连接返回给连接池。在开发或测试环境中，经常使用此种方式。
如果将类型设置成JNDI(Java Naming and Directory Interface , Java命名和目录接口, 是SUN公司提供的一种标准的Java命名系统接口)，MyBatis从在应用服务器向配置好的JNDI数据源dataSource获取数据库连接。在生产环境中，优先考虑这种方式。
transactionManager元素
MyBatis支持两种类型的事务管理器：JDBC 和 MANAGED.
JDBC事务管理器的使用，是在【jdbc程序】负责管理数据库连接的生命周期（提交、回退等等）的时候。如果将TransactionManager 属性设置成JDBC，MyBatis内部将使用JdbcTransactionFactory类创建TransactionManager。例如，部署到ApacheTomcat的应用程序，需要应用程序自己管理事务。
MANAGED 事务管理器的使用，是在【应用服务器】负责管理数据库连接生命周期的时候。如果将TransactionManager属性设置成MANAGED时，MyBatis内部使用ManagedTransactionFactory 类创建事务管理器TransactionManager。例如，当一个Java EE的应用程序部署在类似JBoss，WebLogic，GlassFish应用服务器上时，它们会使用EJB进行应用服务器的事务管理能力。在这些管理环境中，你可以使用MANAGED事务管理器。
注：Managed 是托管的意思，即我们编写的应用程序本身不去管理事务，而是把事务管理交给应用所在的服务器进行管理。
mappers元素: SQL映射
SQLMapper文件中包含的SQL映射语句将会被应用通过使用其标签中的id值来执行。我们需要在mybatis-config.xml文件中配置SQLMapper文件的位置。
<mappers>
<mapper resource="com/mappers/StudentMapper.xml" />
<mapper url="file:///D:/mybatisdemo/app/mappers/StudentMapper.xml" />
<mapper class="com.mappers.StudentMapper" />
<package name="com.mappers" />
</mappers>
以上每一个< mapper> 标签都可以从不同类型的资源中加载映射mapper：
resource属性用来指定在classpath中的mapper文件。
url属性用来通过完全文件系统路径或者web URL地址来指向mapper文件
class属性用来指向一个mapper接口
package属性用来指向可以找到Mapper接口的包名
以上就是Mybatis配置文件了，看起来虽然很多，但是实际使用中不需要用到这么多，而且我们还有Mybatis逆向工程，以上只是需要我们对Mybatis有个更深入的了解，用起来并不麻烦
作为使用Mybatis不可缺少的文件之一，我们也来解析一下它，这个相比较看起来就简单的多了。
<?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="com.dao.TeacherMapper">
<insert id="saveTea">
insert into teacher(id,name,age) values(#{0},#{1},#{2})
</insert>
<delete id="deleteTea">
delete from teacher where id=#{id}
</delete>
<select id="findAll" resultType="com.bean.Teacher">
select * from teacher
</select>
<update id="updateTea">
update teacher set name=#{0} where id=#{1}
</update>
</mapper>
namespace：com.dao.TeacherMapper，指的是和映射文件关联的映射接口。
insert，delete等标签：对应的就是数据库的操作，插入删除等等
id属性：对应的是TeacherMapper.xml文件对应的TeacherMapper.java文件中的方法，如第一个插入id是saveTea，那么在对应的TeacherMapper.java文件中，如果要使用这个语句，就有一个对应的saveTea方法。
插入语句中的#{0}等等，表示占位符，数字表示对应方法中参数的位置。如在第一个语句中，#{0}对应的就是传入的id。
在Mapper.xml文件中还有许多方便的东西，例如动态sql，使用注解sql代替xml中的sql等等，篇幅问题不再叙述