一 MyBatis介绍

MyBatis 本是apache的一个开源项目iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为MyBatis,实质上Mybatis对ibatis进行一些改进。
MyBatis是一个优秀的持久层框架,它对jdbc的操作数据库的过程进行封装,使开发者只需要关注 SQL 本身,而不需要花费精力去处理例如注册驱动、创建connection、创建statement、手动设置参数、结果集检索等jdbc繁杂的过程代码。
Mybatis通过xml或注解的方式将要执行的各种statement(statement、preparedStatemnt、CallableStatement)配置起来,并通过java对象和statement中的sql进行映射生成最终执行的sql语句,最后由mybatis框架执行sql并将结果映射成java对象并返回。

二 Mybatis架构

01 Mybatis入门 - 图1
● mybatis配置
SqlMapConfig.xml,此文件作为mybatis的全局配置文件,配置了mybatis的运行环境等信息。
mapper.xml文件即sql映射文件,文件中配置了操作数据库的sql语句。此文件需要在SqlMapConfig.xml中加载。
● 通过mybatis环境等配置信息构造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编程中对结果的解析处理过程。

三 JDBC问题总结如下

● 数据库连接创建、释放频繁造成系统资源浪费,从而影响系统性能。如果使用数据库连接池可解决此问题。
● Sql语句在代码中硬编码,造成代码不易维护,实际应用中sql变化的可能较大,sql变动需要改变java代码。
● 使用preparedStatement向占有位符号传参数存在硬编码,因为sql语句的where条件不一定,可能多也可能少,修改sql还要修改代码,系统不易维护。
● 对结果集解析存在硬编码(查询列名),sql变化导致解析代码变化,系统不易维护,如果能将数据库记录封装成pojo对象解析比较方便。

四 环境配置

1 导入jar包(包括核心jar包、依赖包、数据库驱动包)

mybatis的代码由github.com管理,下载网址:https://github.com/mybatis/mybatis-3/releases
下载完成解压后文件目录如下:
01 Mybatis入门 - 图2
mybatis-3.2.7.jar mybatis的核心包
lib文件夹 mybatis的依赖包所在
mybatis-3.2.7.pdf mybatis使用手册

2 创建SqlMapConfig.xml配置文件

SqlMapConfig.xml是mybatis的核心配置文件,配置文件内容为数据源、事务管理

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE configuration
  3. PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  4. "http://mybatis.org/dtd/mybatis-3-config.dtd">
  5. <configuration>
  6. <properties resource="log4j.properties"/>
  7. <!-- 起别名 包以及包下所有的子包 -->
  8. <typeAliases>
  9. <!-- <typeAlias type="com.kevin.entity.User" alias="User"/> -->
  10. <package name="com.kevin.entity"/>
  11. </typeAliases>
  12. <!-- 和spring整合后 environments配置将废除 -->
  13. <environments default="development">
  14. <environment id="development">
  15. <!-- 使用jdbc事务管理 -->
  16. <transactionManager type="JDBC" />
  17. <!-- 数据库连接池 -->
  18. <dataSource type="POOLED">
  19. <property name="driver" value="com.mysql.jdbc.Driver" />
  20. <property name="url"
  21. value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8" />
  22. <property name="username" value="root" />
  23. <property name="password" value="admin" />
  24. </dataSource>
  25. </environment>
  26. </environments>
  27. </configuration>

2 创建sql映射文件User.xml (此处省略Javabean类User)

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <!-- namespace:命名空间,用于隔离sql -->
  4. <mapper namespace="user">
  5. </mapper>

3 在SqlMapConfig.xml中加载映射文件

  1. <mappers>
  2. <!-- <mapper resource="sqlmap/User.xml"/> -->
  3. <!-- <mapper class="com.kevin.mapper.UserMapper"/> -->
  4. <package name="com.kevin.mapper"/>
  5. </mappers>

五 在Mybatis中实现CRUD操作

【根据id查询用户】
在User.xml中添加select标签,编写sql:

  1. <!-- 通过id查询一个用户 -->
  2. <select id="findUserById" parameterType="Integer" resultType="User">
  3. select * from user where id = #{v}
  4. </select>

创建一个测试类编写测试代码:

  1. /**
  2. * 根据用户id查询
  3. * @throws Exception
  4. */
  5. @Test
  6. public void test() throws Exception{
  7. //加载核心配置文件
  8. String resource = "SqlMapConfig.xml";
  9. InputStream in = Resources.getResourceAsStream(resource);
  10. //创建SqlSessionFactory
  11. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  12. //创建SqlSession
  13. SqlSession sqlSession = sqlSessionFactory.openSession();
  14. //执行sql语句
  15. User user = sqlSession.selectOne("user.findUserById", 10);
  16. System.out.println(user);
  17. }

【根据用户名称进行模糊查询】
在User.xml中添加select标签,编写sql:
select from user where username like “%”#{va}”%”
或者
select
from user where username like ‘%${value}%’
编写测试代码:

  1. /**
  2. * 根据用户名称模糊查询
  3. * @throws IOException
  4. */
  5. @Test
  6. public void test2() throws Exception{
  7. //加载核心配置文件
  8. String resource = "SqlMapConfig.xml";
  9. InputStream in = Resources.getResourceAsStream(resource);
  10. //创建sqlsessionfactory
  11. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  12. //创建sqlsession
  13. SqlSession sqlSession = sqlSessionFactory.openSession();
  14. //执行sql语句
  15. List<User> users = sqlSession.selectList("user.findUserByName","五");
  16. for (User user : users) {
  17. System.out.println(user);
  18. }
  19. }

【添加用户】
在User.xml中添加insert标签,编写sql:

  1. <!-- 添加用户 -->
  2. <insert id="insertUser" parameterType="com.kevin.entity.User">
  3. <selectKey keyProperty="id" resultType="Integer" order="AFTER">
  4. select LAST_INSERT_ID()
  5. </selectKey>
  6. insert into user(username,birthday,address,sex)
  7. values(#{username},#{birthday},#{address},#{sex})
  8. </insert>

其中,LAST_INSERT_ID( )是mysql的函数,返回auto_increment自增列新记录id值。
如果自增主键形式为uuid,可使用如下配置:

  1. <selectKey keyColumn="id" keyProperty="id" order="BEFORE"
  2. resultType="string">
  3. SELECT LAST_INSERT_ID()
  4. </selectKey>

编写测试代码:

  1. /**
  2. * 保存用户
  3. */
  4. @Test
  5. public void test3() throws Exception{
  6. String resource = "SqlMapConfig.xml";
  7. InputStream in = Resources.getResourceAsStream(resource);
  8. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  9. SqlSession sqlSession = sqlSessionFactory.openSession();
  10. User user = new User();
  11. user.setUsername("Michael");
  12. user.setBirthday(new Date());
  13. user.setAddress("China");
  14. user.setSex("Male");
  15. sqlSession.insert("user.insertUser",user);
  16. sqlSession.commit();
  17. //获取最新保存用户的id
  18. System.out.println(user.getId());
  19. }

【更新用户】
在User.xml中添加update标签,编写sql:

  1. <!-- 更新用户 -->
  2. <update id="updateUserById" parameterType="com.kevin.entity.User">
  3. update user
  4. set username = #{username},sex = #{sex},birthday = #{birthday},address = #{address}
  5. where id = #{id}
  6. </update>

编写测试代码:
/*
更新用户
_@_throws Exception
/
_@_Test
public void test4() throws Exception{
String resource = “SqlMapConfig.xml”;
InputStream in = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
SqlSession sqlSession = sqlSessionFactory.openSession();

  1. User user = new User();
  2. user.setId(24);
  3. user.setUsername("Michel");
  4. user.setBirthday(new Date());
  5. user.setAddress("America");
  6. user.setSex("Female");
  7. sqlSession.update("user.updateUserById", user);
  8. sqlSession.commit();
  9. }

【删除用户】
在User.xml中添加delete标签,编写sql:

  1. <!-- 删除用户 -->
  2. <delete id="deleteUserById" parameterType="Integer">
  3. delete from user where id = #{id}
  4. </delete>

编写测试代码:

  1. /**
  2. * 删除用户
  3. * @throws Exception
  4. */
  5. @Test
  6. public void test5() throws Exception{
  7. String resource = "SqlMapConfig.xml";
  8. InputStream in = Resources.getResourceAsStream(resource);
  9. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  10. SqlSession sqlSession = sqlSessionFactory.openSession();
  11. sqlSession.delete("user.deleteUserById", 27);
  12. sqlSession.commit();
  13. }

六 小结

区分#{ }和01 Mybatis入门 - 图3{}表示拼接sql串,通过${}可以将parameterType 传入的内容拼接在sql中且不进行jdbc类型转换, 01 Mybatis入门 - 图4{}括号中只能是value。
parameterType和resultType
parameterType:指定输入参数类型,mybatis通过ognl从输入对象中获取参数值拼接在sql中。
resultType:指定输出结果类型,mybatis将sql查询结果的一行记录数据映射为resultType指定类型的对象。如果有多条数据,则分别进行映射,并把对象放到容器List中
selectOne和selectList
selectOne查询一条记录,如果使用selectOne查询多条记录则抛出异常:
selectList可以查询一条或多条记录。
selectOne和selectList
动态代理对象调用sqlSession.selectOne()和sqlSession.selectList()是根据mapper接口方法的返回值决定,如果返回list则调用selectList方法,如果返回单个对象则调用selectOne方法。
namespace
mybatis官方推荐使用mapper代理方法开发mapper接口,程序员不用编写mapper接口实现类,使用mapper代理方法时,输入参数可以使用pojo包装对象或map对象,保证dao的通用性。

七 Mybatis框架优势(面试常考)

1 Mybatis解决了使用JDBC编程产生的问题

● 数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能,如果使用数据库连接池可解决此问题。
解决:在SqlMapConfig.xml中配置数据连接池,使用连接池管理数据库链接。
● Sql语句写在代码中造成代码不易维护,实际应用sql变化的可能较大,sql变动需要改变java代码。
解决:将Sql语句配置在XXXXmapper.xml文件中与java代码分离。
● 向sql语句传参数麻烦,因为sql语句的where条件不一定,可能多也可能少,占位符需要和参数一一对应。
解决:Mybatis自动将java对象映射至sql语句,通过statement中的parameterType定义输入参数的类型。
● 对结果集解析麻烦,sql变化导致解析代码变化,且解析前需要遍历,如果能将数据库记录封装成pojo对象解析比较方便。
解决:Mybatis自动将sql执行结果映射至java对象,通过statement中的resultType定义输出结果的类型。

2 Mybatis与Hibernate有哪些不同

● Mybatis和hibernate不同,它不完全是一个ORM框架,因为MyBatis需要程序员自己编写Sql语句。mybatis可以通过XML或注解方式灵活配置要运行的sql语句,并将java对象和sql语句映射生成最终执行的sql,最后将sql执行的结果再映射生成java对象。
● Mybatis学习门槛低,简单易学,程序员直接编写原生态sql,可严格控制sql执行性能,灵活度高,非常适合对关系数据模型要求不高的软件开发,例如互联网软件、企业运营类软件等,因为这类软件需求变化频繁,一但需求变化要求成果输出迅速。但是灵活的前提是mybatis无法做到数据库无关性,如果需要实现支持多种数据库的软件则需要自定义多套sql映射文件,工作量大。
● Hibernate对象/关系映射能力强,数据库无关性好,对于关系模型要求高的软件(例如需求固定的定制化软件)如果用hibernate开发可以节省很多代码,提高效率。但是Hibernate的学习门槛高,要精通门槛更高,而且怎么设计O/R映射,在性能和对象模型之间如何权衡,以及怎样用好Hibernate需要具有很强的经验和能力才行。
总之,按照用户的需求在有限的资源环境下只要能做出维护性、扩展性良好的软件架构都是好架构,所以框架只有适合才是最好。

八 Mapper动态代理方式

1 开发规范

Mapper接口开发方法只需要程序员编写Mapper接口(相当于Dao接口),由Mybatis框架根据接口定义创建接口的动态代理对象,代理对象的方法体同上边Dao接口实现类方法。
Mapper接口开发需要遵循以下规范:
● Mapper.xml文件中的namespace与mapper接口的类路径相同。
● Mapper接口方法名和Mapper.xml中定义的每个statement的id相同
● Mapper接口方法的输入参数类型和mapper.xml中定义的每个sql 的parameterType的类型相同
● Mapper接口方法的输出参数类型和mapper.xml中定义的每个sql的resultType的类型相同

2 创建UserMapper.xml映射文件

select * from user where id = #{v}

  1. <!-- 根据用户名称模糊查询
  2. #{} 占位符 ? == ''
  3. ${} 字符串拼接 '% %'
  4. -->
  5. <select id="findUserByName" parameterType="String" resultType="User">
  6. select * from user where username like "%"#{va}"%"
  7. </select>
  8. <!-- 添加用户 -->
  9. <insert id="insertUser" parameterType="User">
  10. <selectKey keyProperty="id" resultType="Integer" order="AFTER">
  11. select LAST_INSERT_ID()
  12. </selectKey>
  13. insert into user(username,birthday,address,sex)
  14. values(#{username},#{birthday},#{address},#{sex})
  15. </insert>
  16. <!-- 更新用户 -->
  17. <update id="updateUserById" parameterType="User">
  18. update user
  19. set username = #{username},sex = #{sex},birthday = #{birthday},address = #{address}
  20. where id = #{id}
  21. </update>
  22. <!-- 删除用户 -->
  23. <delete id="deleteUserById" parameterType="Integer">
  24. delete from user where id = #{id}
  25. </delete>

3 创建UserMapper接口文件

  1. package com.kevin.mapper;
  2. import java.util.List;
  3. import com.kevin.entity.User;
  4. public interface UserMapper {
  5. /**
  6. * 遵循四个原则
  7. * 接口方法名和user.xml文件id值相同
  8. * 接口返回值和user.xml文件返回值相同
  9. * 接口入参类型和user.xml文件入参类型相同
  10. * 命名空间进行绑定
  11. */
  12. public User findUserById(Integer id);
  13. public List<User> findUserByName(String username);
  14. public void insertUser(User user);
  15. public void updateUserById(User user);
  16. public void deleteUserById(Integer id);
  17. }

4 加载UserMapper配置文件

在SqlMapConfig.xml文件中进行如下配置:

  1. <mappers>
  2. <!-- <mapper resource="sqlmap/User.xml"/> -->
  3. <!-- <mapper class="com.kevin.mapper.UserMapper"/> -->
  4. <package name="com.kevin.mapper"/>
  5. </mappers>

5 编写测试类

package com.kevin.junit;
import java.io.InputStream;
import java.util.Date;
import java.util.List;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Test;
import com.kevin.entity.User;
import com.kevin.mapper.UserMapper;
public class MybatisMapper {

  1. /**
  2. * 测试mapper接口方式
  3. * @throws Exception
  4. */
  5. //根据用户id查询
  6. @Test
  7. public void findUserById() throws Exception{
  8. String resource = "SqlMapConfig.xml";
  9. InputStream in = Resources.getResourceAsStream(resource);
  10. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  11. SqlSession sqlSession = sqlSessionFactory.openSession();
  12. UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  13. User user = userMapper.findUserById(30);
  14. System.out.println(user);
  15. }
  16. //根据用户名称查询
  17. @Test
  18. public void findUserByName() throws Exception{
  19. String resource = "SqlMapConfig.xml";
  20. InputStream in = Resources.getResourceAsStream(resource);
  21. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  22. SqlSession sqlSession = sqlSessionFactory.openSession();
  23. UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  24. List<User> users = userMapper.findUserByName("王");
  25. for (User user : users) {
  26. System.out.println(user);
  27. }
  28. }
  29. //添加用户
  30. @Test
  31. public void insertUser() throws Exception{
  32. String resource = "SqlMapConfig.xml";
  33. InputStream in = Resources.getResourceAsStream(resource);
  34. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  35. SqlSession sqlSession = sqlSessionFactory.openSession();
  36. User user = new User();
  37. user.setUsername("Kevin");
  38. user.setAddress("China");
  39. user.setBirthday(new Date());
  40. user.setSex("Male");
  41. UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  42. userMapper.insertUser(user);
  43. sqlSession.commit();
  44. }
  45. //更新用户
  46. @Test
  47. public void updateUserById() throws Exception {
  48. String resource = "SqlMapConfig.xml";
  49. InputStream in = Resources.getResourceAsStream(resource);
  50. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  51. SqlSession sqlSession = sqlSessionFactory.openSession();
  52. UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  53. User user = new User();
  54. user.setId(25);
  55. user.setUsername("Jackson");
  56. user.setAddress("British");
  57. user.setBirthday(new Date());
  58. user.setSex("Male");
  59. userMapper.updateUserById(user);
  60. sqlSession.commit();
  61. }
  62. //删除用户
  63. @Test
  64. public void deleteUserById() throws Exception {
  65. String resource = "SqlMapConfig.xml";
  66. InputStream in = Resources.getResourceAsStream(resource);
  67. SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
  68. SqlSession sqlSession = sqlSessionFactory.openSession();
  69. UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
  70. userMapper.deleteUserById(32);
  71. sqlSession.commit();
  72. }

}

九 SqlMapConfig.xml配置文件详解

1 配置内容

SqlMapConfig.xml中配置的内容和顺序如下:(其中黑体部分是需要重点掌握,其余已经废弃不用或不常用)
properties(属性)
settings(全局配置参数)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境集合属性对象)
environment(环境子属性对象)
transactionManager(事务管理)
dataSource(数据源)
mappers(映射器)

2 typeAliases(类型别名)

别名 映射的类型
_byte byte
_long long
_short short
_int int
_integer int
_double double
_float float
_boolean boolean
string String
byte Byte
long Long
short Short
int Integer
integer Integer
double Double
float Float
boolean Boolean
date Date
decimal BigDecimal
bigdecimal BigDecimal
map Map

3 自定义别名

  1. <typeAliases>
  2. <!-- <typeAlias type="com.kevin.entity.User" alias="User"/> -->
  3. <package name="com.kevin.entity"/>
  4. </typeAliases>

4 mappers映射器

Mapper配置的几种方法:

  1. <mappers>
  2. <!-- <mapper resource="sqlmap/User.xml"/> -->
  3. <!-- <mapper class="com.kevin.mapper.UserMapper"/> -->
  4. <package name="com.kevin.mapper"/>
  5. </mappers>


使用相对于类路径的资源(现在的使用方式)
如:

使用mapper接口类路径
如:
注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。

注册指定包下的所有mapper接口
如:
注意:此种方法要求mapper接口名称和mapper映射文件名称相同,且放在同一个目录中。