MyBatis 介绍
什么是MyBatis
MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code，并且改名为MyBatis 。2013年11月迁移到Github。 MyBatis是一个优秀的持久层框架，它对jdbc的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。Mybatis通过xml或注解的方式将要执行的各种statement（statement、preparedStatement、CallableStatement）配置起来，并通过java对象和statement中的sql进行映射生成最终执行的sql语句，最后由mybatis框架执行sql并将结果映射成java对象并返回。
MyBatis架构 MyBatis的执行流程
SqlMapConfig.xml，此文件作为mybatis的全局配置文件，配置了mybatis的运行环境等信息。mapper.xml文件即sql映射文件，文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。通过MyBatis环境等配置信息构造SqlSessionFactory(会话工厂)由SqlSessionFactory(会话工厂)创建sqlSession(会话)，操作数据库需要通过sqlSession进行。mybatis底层自定义了Executor(执行器)接口操作数据库，Executor接口有两个实现，一个是基本执行器、一个是缓存执行器。Mapped Statement也是MyBatis一个底层封装对象，它包装了MyBatis配置信息及SQL映射信息等。mapper.xml文件中一个SQL对应一个Mapped Statement对象，SQL的id即是Mapped statement的id。Mapped Statement对SQL执行输入参数进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行SQL前,将输入的java对象映射至SQL中，输入参数映射就是JDBC编程中对PreparedStatement设置参数。Mapped Statement对SQL执行输出结果进行定义，包括HashMap、基本类型、pojo，Executor通过Mapped Statement在执行SQL后将输出结果映射至java对象中，输出结果映射过程相当于JDBC编程中对结果的解析处理过程。
组件介绍
SqlSessionFactoryBuilder SqlSessionFactoryBuilder用于创建SqlSessionFacoty，SqlSessionFacoty一旦创建完成就不需要SqlSessionFactoryBuilder了，因为SqlSession是通过SqlSessionFactory生产，所以可以将SqlSessionFactoryBuilder当成一个工具类使用，最佳使用范围是方法范围即方法体内局部变量。
SqlSessionFactory SqlSessionFactory是一个接口，接口中定义了openSession的不同重载方法，SqlSessionFactory的最佳使用范围是整个应用运行期间，一旦创建后可以重复使用，通常以单例模式管理SqlSessionFactory。
SqlSession SqlSession是一个面向用户的接口， sqlSession中定义了数据库操作方法。 每个线程都应该有它自己的SqlSession实例。SqlSession的实例不能共享使用，它也是线程不安全的。因此最佳的范围是请求或方法范围。绝对不能将SqlSession实例的引用放在一个类的静态字段或实例字段中。
SqlSession的使用范围 SqlSession中封装了对数据库的操作，如：查询、插入、更新、删除等。 通过SqlSessionFactory创建SqlSession，而SqlSessionFactory是通过SqlSessionFactoryBuilder进行创建。
MyBatis 包结构
MyBatis 基础环境配置
log4j.properties日志文件
# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n
SqlMapConfig.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>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理-->
<transactionManager type="JDBC" />
<!-- 数据库连接池-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 导入User.xml -->
<mappers>
<mapper resource="User.xml"/>
</mappers>
</configuration>
Pojo
Public class User {
private int id;
private String username;// 用户姓名
private String sex;// 性别
private Date birthday;// 生日
private String address;// 地址
get/set方法省略
User.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="User">
<!--
id:sql语句唯一标识
parameterType:指定传入参数类型
resultType:返回结果集类型
#{}占位符:起到占位作用,如果传入的是基本类型(string,long,double,int,boolean,float等),那么#{}中的变量名称可以随意写.
-->
<select id="findUserById" parameterType="java.lang.Integer" resultType="com.lsy.pojo.User">
select * from user where id=#{id}
</select>
<!--
#{}:如果传入的是pojo类型,那么#{}中的变量名称必须是pojo中对应的属性.属性.属性.....
如果要返回数据库自增主键:可以使用select LAST_INSERT_ID()
-->
<insert id="insertUser" parameterType="cn.itheima.pojo.User" >
<!-- 执行 select LAST_INSERT_ID()数据库函数,返回自增的主键
keyProperty:将返回的主键放入传入参数的Id中保存.
order:当前函数相对于insert语句的执行顺序,在insert前执行是before,在insert后执行是AFTER
resultType:id的类型,也就是keyproperties中属性的类型
-->
<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
select LAST_INSERT_ID()
</selectKey>
insert into user (username,birthday,sex,address) values(#{username},#{birthday},#{sex},#{address})
</insert>
<delete id="delUserById" parameterType="int">
delete from user where id=#{id}
</delete>
<update id="updateUserById" parameterType="com.lsy.pojo.User">
update user set username=#{username} where id=#{id}
</update>
</mapper>
Dao
public class Test {
@Test
public void testFindUserById() throws Exception{
String resource = "SqlMapConfig.xml";
//通过流将核心配置文件读取进来
InputStream inputStream = Resources.getResourceAsStream(resource);
//通过核心配置文件输入流来创建会话工厂
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
//通过工厂创建会话
SqlSession openSession = sqlSessionFactory .openSession();
//第一个参数:所调用的sql语句= nameSpace+.+sql的ID
//nameSpace在User.xml中配置的
User user = openSession.selectOne("User.findUserById", 1);
System.out.println(user);
openSession.close();
}
}
配置文件详解
SqlSessionFactory重要属性
properties（属性）
SqlMapConfig.xml可以引用java属性文件中的配置信息db.properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
SqlMapConfig.xml引用
<properties resource="db.properties"/>
<environments default="development">
<environment id="development">
<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>
MyBatis 将按照下面的顺序来加载属性： 在 properties 元素体内定义的属性首先被读取。 然后会读取properties 元素中resource或 url 加载的属性，它会覆盖已读取的同名属性。
typeAliases（类型别名）
MyBatis支持的别名
别名映射的类型别名映射的类型
_bytebyte_longlong_shortshort_intint_integerint_doubledouble_floatfloat_booleanbooleanstringStringbyte BytelongLongshortShortintIntegerintegerIntegerdoubleDoublefloatFloatbooleanBooleandateDatedecimalBigDecimalbigdecimalBigDecimalmapMap
自定义别名
<typeAliases>
<!-- 单个别名定义 -->
<typeAlias alias="user" type="com.lsy.mybatis.dao.User"/>
<!-- 批量别名定义，扫描整个包下的类，别名为类名（首字母大写或小写都可以） -->
<package name="com.lsy.mybatis.dao"/>
<package name="其它包"/>
</typeAliases>
mappers（映射器）
<mapper resource=" " /> 使用相对于类路径的资源.如：<mapper resource="sqlmap/User.xml" /><mapper class=" " /> 使用mapper接口类路径.如：<mapper class="com.lsy.mybatis.mapper.UserMapper"/> 注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中。<package name=""/> 注册指定包下的所有mapper接口.如：<package name="cn.itcast.mybatis.mapper"/> 注意：此种方法要求mapper接口名称和mapper映射文件名称相同，且放在同一个目录中。
SqlSession重要属性
#{}和${}在XML中的作用
#{}表示一个占位符号，通过#{}可以实现PreparedStatement向占位符中设置值，自动进行java类型和JDBC类型转换，#{}可以有效防止sql注入。 #{}可以接收简单类型值或pojo属性值。 如果ParameterType传输单个简单类型值，#{}括号中可以是value或其它名称。${}表示拼接sql串，通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换，
可
以
接
收
简
单
类
型
值
或
p
o
j
o
属
性
值
，
如
果
p
a
r
a
m
e
t
e
r
T
y
p
e
传
输
单
个
简
单
类
型
值
，
{}可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，
可以接收简单类型值或pojo属性值，如果parameterType传输单个简单类型值，{}括号中只能是value。
parameterType和resultType
parameterType：指定输入参数类型，mybatis通过ognl从输入对象中获取参数值拼接在sql中。resultType：指定输出结果类型，mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。
selectOne和selectList
selectOne查询一条记录，如果使用selectOne查询多条记录，则抛出异常。selectList可以查询一条或多条记录。
MyBatis 持久层整合
Dao层
public interface UserDao {
public User findUserById(Integer id);
public List<User> findUserByUserName(String userName);
}
DaoImpl层
public class UserDaoImpl implements UserDao {
private SqlSessionFactory sqlSessionFactory;
//通过构造方法注入
public UserDaoImpl(SqlSessionFactory sqlSessionFactory) {
this.sqlSessionFactory = sqlSessionFactory;
}
@Override
public User findUserById(Integer id) {
//sqlSesion是线程不安全的,所以它的最佳使用范围在方法体内
SqlSession openSession = sqlSessionFactory.openSession();
User user = openSession.selectOne("User.findUserById", id);
return user;
}
@Override
public List<User> findUserByUserName(String userName) {
SqlSession openSession = sqlSessionFactory.openSession();
List<User> list = openSession.selectList("User.findUserByUserName", userName);
return list;
}
}
UserDaoTest
public class UserDaoTest {
private SqlSessionFactory sqlSessionFactory;
//在测试方法前，构造SqlSessionFactory
@Before
public void setUp() throws Exception{
String resource = "SqlMapConfig.xml";
//通过流将核心配置文件读取进来
InputStream inputStream = Resources.getResourceAsStream(resource);
//通过核心配置文件输入流来创建会话工厂
sqlSessionFactory= new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindUserById() throws Exception{
//将初始化好的工厂注入到实现类中
UserDao userDao = new UserDaoImpl(sqlSessionFactory);
User user = userDao.findUserById(1);
System.out.println(user);
}
@Test
public void testFindUserByUserName () throws Exception{
UserDao userDao = new UserDaoImpl(sqlSessionFactory);
List<User> list = userDao.findUserByUserName("王");
System.out.println(list);
}
}
MyBatis Mapper动态代理
Mapper接口开发方法只需要程序员编写Mapper接口（相当于Dao接口），由Mybatis框架根据接口定义创建接口的动态代理对象，代理对象的方法体同上边Dao接口实现类方法。Mapper接口开发需要遵循以下规范： 1、 Mapper.xml文件中的namespace与mapper接口的类路径相同。 2、 Mapper接口方法名和Mapper.xml中定义的每个statement的id相同 3、 Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同 4、 Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同UserMapper.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="com.lsy.mapper.UserMapper">
<select id="findUserById" parameterType="int" resultType="cn.itheima.pojo.User">
select * from user where id=#{id}
</select>
<select id="findUserByUserName" parameterType="string" resultType="user">
select * from user where username like '%${value}%'
</select>
</mapper>
UserMapper.java
public interface UserMapper {
public User findUserById(Integer id);
//动态代理形势中,如果返回结果集问List,那么mybatis会在生成实现类的使用会自动调用selectList方法
public List<User> findUserByUserName(String userName);
}
SqlMapConfig.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>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用jdbc事务管理-->
<transactionManager type="JDBC" />
<!-- 数据库连接池-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
<property name="username" value="root" />
<property name="password" value="root" />
</dataSource>
</environment>
</environments>
<!-- 导入User.xml -->
<mappers>
<!-- 使用包扫描的方式批量引入Mapper接口
使用规则:
1. 接口的名称和映射文件名称除扩展名外要完全相同
2. 接口和映射文件要放在同一个目录下
-->
<package name="com.lsy.mapper"/>
</mappers>
</configuration>
UserMapperTest
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;
//在测试方法前，构造SqlSessionFactory
@Before
public void setUp() throws Exception{
String resource = "SqlMapConfig.xml";
//通过流将核心配置文件读取进来
InputStream inputStream = Resources.getResourceAsStream(resource);
//通过核心配置文件输入流来创建会话工厂
sqlSessionFactory= new SqlSessionFactoryBuilder().build(inputStream);
}
@Test
public void testFindUserById() throws Exception{
SqlSession openSession = sqlSessionFactory.openSession();
//通过getMapper方法来实例化接口
UserMapper mapper = openSession.getMapper(UserMapper.class);
User user = mapper.findUserById(1);
System.out.println(user);
}
@Test
public void testFindUserByUserName() throws Exception{
SqlSession openSession = sqlSessionFactory.openSession();
//通过getMapper方法来实例化接口
UserMapper mapper = openSession.getMapper(UserMapper.class);
List<User> list = mapper.findUserByUserName("王");
System.out.println(list);
}
}
MyBatis 动态SQL
if where foreach sql片段 关联查询
MyBatis 整合Spring
