mybatis（一）

Mybatis

一、MyBatis简介

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

1.1 什么是MyBatis？

• mybatis 是一个优秀的基于java的持久层框架，它内部封装了jdbc，使开发者只需要关注sql语句本身，而不需要花费精力去处理加载驱动、创建连接、创建statement等繁杂的过程。
• mybatis通过xml或注解的方式将要执行的各种 statement配置起来，并通过java对象和statement中sql的动态参数进行映射生成最终执行的sql语句。
• 最后mybatis框架执行sql并将结果映射为java对象并返回。采用ORM思想解决了实体和数据库映射的问题，对jdbc 进行了封装，屏蔽了jdbc api 底层访问细节，使我们不用与jdbc api打交道，就可以完成对数据库的持久化操作。

1.2 MyBatis历史

• 原是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation 迁移到了Google Code，随着开发团队转投Google Code旗下， iBatis3.x正式更名为MyBatis ，代码于2013年11月迁移到Github（下载地址见后）。
• iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。 iBatis提供的持久层框架包括SQL Maps和Data Access Objects（DAO）

1.3 为什么要使用MyBatis？

• MyBatis是一个半自动化的持久化层框架。
• JDBC
– SQL夹在Java代码块里，耦合度高导致硬编码内伤
– 维护不易且实际开发需求中sql是有变化，频繁修改的情况多见
• Hibernate和JPA
– 长难复杂SQL，对于Hibernate而言处理也不容易
– 内部自动生产的SQL，不容易做特殊优化。
– 基于全映射的全自动框架，大量字段的POJO进行部分映射时比较困难。导致数据库性能下降。
• 对开发人员而言，核心sql还是需要自己优化
• sql和java编码分开，功能边界清晰，一个专注业务、一个专注数据。

1.4 MyBatis文档

• https://github.com/mybatis/mybatis-3/ github上的资源

• http://www.mybatis.org/mybatis-3/ mybatis官网

下面有download lasted 点击它可以下载文档

1.5 原始jdbc操作的分析

原始jdbc开发存在的问题如下：
① 数据库连接创建、释放频繁造成系统资源浪费从而影响系统性能
② sql 语句在代码中硬编码，造成代码不易维护，实际应用 sql 变化的可能较大，sql 变动需要改变java代码。
③ 查询操作时，需要手动将结果集中的数据手动封装到实体中。插入操作时，需要手动将实体的数据设置到sql语句的占位
符位置

应对上述问题给出的解决方案：
① 使用数据库连接池初始化连接资源
② 将sql语句抽取到xml配置文件中
③ 使用反射、内省等底层技术，自动将实体与表进行属性与字段的自动映射

二、MyBatis的快速入门

2.1MyBatis开发步骤：

① 添加MyBatis的坐标
② 创建user数据表
③ 编写User实体类
④ 编写映射文件UserMapper.xml
⑤ 编写核心文件SqlMapConfig.xml
⑥ 编写测试类

2.1.1 导入MyBatis的坐标和其他相关坐标

<!--mybatis坐标-->
<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.4.5</version>
</dependency>
<!--mysql驱动坐标-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.6</version>
    <scope>runtime</scope>
</dependency>
<!--单元测试坐标-->
<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.12</version>
    <scope>test</scope>
</dependency>
<!--日志坐标-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.12</version>
</dependency>

2.1.2 创建user数据库表

2.1.3 编写User实体

public class User {
    private int id;
    private String username;
    private String password;
    //省略get个set方法
}

2.1.4 编写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="userMapper">
    <select id="findAll" resultType="com.itheima.domain.User">
        select * from User
    </select>
</mapper>

注意: 一般创建在resources下 如果用多个文件夹 需要使用 com/itheima/dao/UserMapper.xml 要不然会找不到这个文件

2.1.5 编写UserMapper核心配置文件

<!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">
            <transactionManagertype="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.jdbc.Driver"/><property name="url" value="jdbc:mysql:///test"/>
                <property name="username" value="root"/><property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    #将UserMapper.xml映射sql进行注册
    <mappers> <mapper resource="com/itheima/mapper/UserMapper.xml"/> </mappers>
</configuration>

2.1.6 编写测试代码

//加载核心配置文件
InputStream resourceAsStream = Resources.getResourceAsStream("SqlMapConfig.xml");
//获得sqlSession工厂对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(resourceAsStream);
//获得sqlSession对象
SqlSession sqlSession = sqlSessionFactory.openSession();
//执行sql语句
List<User> userList = sqlSession.selectList("userMapper.findAll");
//打印结果
System.out.println(userList);
//释放资源
sqlSession.close();

三、MyBatis的核心配置文件

映射文件指导着MyBatis如何进行数据库增删改查，
有着非常重要的意义；
•cache –命名空间的二级缓存配置
•cache-ref – 其他命名空间缓存配置的引用。
•resultMap – 自定义结果集映射
•parameterMap – 已废弃！老式风格的参数映射
•sql –抽取可重用语句块。
•insert – 映射插入语句
•update – 映射更新语句
•delete – 映射删除语句
•select – 映射查询语句

insert、update、delete元素中拥有的

主键生成方式

若数据库支持自动生成主键的字段（比如 MySQL 和 SQL Server），则可以设置useGeneratedKeys=”true”，然后再把keyProperty 设置到目标属性上。

四、MyBatis核心配置文件概述

也称为MyBatis-全局配置文件

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

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

4.1 MyBatis常用配置解析

4.1.1 environments标签

实例

<environments default="development">    # 指定默认的环境名称
    <environment id="development">      # 指定当前环境的名称
        <transactionManager type="JDBC"/>  # 指定事务管理类型是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>

事务管理器（transactionManager）类型有两种：

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

数据源（dataSource）类型有三种：

• UNPOOLED：这个数据源的实现只是每次被请求时打开和关闭连接，不使用连接池
• POOLED：这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来，PooledDataSourceFactory。
• JNDI：这个数据源的实现是为了能在如 EJB 或应用服务器这类容器中使用，容器可以集中或在外部配置数据源，然后放置一个 JNDI 上下文的引用。
– 自定义：实现DataSourceFactory接口，定义数据源的获取方式。

扩展实例

<environments default="dev_mysql">
		<environment id="dev_mysql">
			<transactionManager type="JDBC"></transactionManager>
			<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="dev_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>

4.12 databaseIdProvider环境

MyBatis 可以根据不同的数据库厂商执行不同的语句。

基本实例

Mybatis全局配置文件

<!-- databaseIdProvider：支持多数据库厂商的；
type="DB_VENDOR"：VendorDatabaseIdProvider
作用就是得到数据库厂商的标识(驱动getDatabaseProductName())，mybatis就能根据数据库厂商标识来执行不同的sql;
MySQL，Oracle，SQL Server,xxxx
-->
<databaseIdProvider type="DB_VENDOR">
    <!-- 为不同的数据库厂商起别名 -->
    <property name="MySQL" value="mysql"/>
    <property name="Oracle" value="oracle"/>
    <property name="SQL Server" value="sqlserver"/>
</databaseIdProvider>

映射文件

	<select id="getAll" resultType="user" databaseId="mysql">  # databaseId对应上方配置文件中values值
		select * from ds_user
	</select>

属性

• Type： DB_VENDOR
	– 使用MyBatis提供的VendorDatabaseIdProvider解析数据库厂商标识。也可以实现DatabaseIdProvider接口来自定义。
• Property-name：数据库厂商标识
• Property-value：为标识起一个别名，方便SQL语句使用databaseId属性引用

• DB_VENDOR
	– 会通过 DatabaseMetaData#getDatabaseProductName() 返回的字符串进行设置。由于通常情况下这个字符串都非常长而且相同产品的不同版本会返回不同的值，所以最好通过设置属性别名来使其变短
	
• MyBatis匹配规则如下：
– 1、如果没有配置databaseIdProvider标签，那么databaseId=null
– 2、如果配置了databaseIdProvider标签，使用标签配置的name去匹配数据库信息，匹配上设置databaseId=配置指定的值，否则依旧为null
– 3、如果databaseId不为null，他只会找到配置databaseId的sql语句
– 4、MyBatis 会加载不带 databaseId 属性和带有匹配当前数据库databaseId 属性的所有语句。如果同时找到带有 databaseId 和不带
databaseId 的相同语句，则后者会被舍弃。

说明

如果databaseId的值跟数据厂商不一样，会报找不到这个语句

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.itheima.dao.UserMapper.insert_one

4.1.3 mapper标签

该标签的作用是加载映射的，将mapper映射文件进行映射，加载方式有如下几种：

• 使用相对于类路径的资源引用，例如：<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
• 使用完全限定资源定位符（URL），例如：<mapper url="file:///var/mappers/AuthorMapper.xml"/>
• 使用映射器接口实现类的完全限定类名，例如：<mapper class="org.mybatis.builder.AuthorMapper"/>
• 将包内的映射器接口实现全部注册为映射器，例如：<package name="com.itheima.mapper"/>

4.1.4 Properties标签

实际开发中，习惯将数据源的配置信息单独抽取成一个properties文件，该标签可以加载额外配置的properties文件

<!--
  1、mybatis可以使用properties来引入外部properties配置文件的内容；
  resource：引入类路径下的资源
  url：引入网络路径或者磁盘路径下的资源
   -->
<properties resource="jdbc.properties"></properties>

注意

如果属性在不只一个地方进行了配置，那么 MyBatis 将按照下面的顺序来加载：
– 在 properties 元素体内指定的属性首先被读取。
– 然后根据 properties 元素中的 resource 属性读取类路径下属性文件或根据 url 属性指定的路径读取属性文件，并覆盖已读取的同名属性。
– 最后读取作为方法参数传递的属性，并覆盖已读取的同名属性。

4.1.5 typeAliases标签

类型别名是为Java 类型设置一个短的名字。原来的类型名称配置如下

在映射文件中 resultType

<select id="findAll" resultType="com.itheima.domain.User">
	select * from User
</select>

MyBatis全局配置文件

1）使用配置文件进行别名设置

配置typeAliases，为com.itheima.domain.User定义别名为user
<typeAliases>
	<typeAlias type="com.itheima.domain.User“ alias="user"></typeAlias>
</typeAliases>

2）使用@Alias注解为其指定一个别名

@Alias("user")
public class User{}

映射文件

# resultType中的user为别名
<select id="findAll" resultType=“user">  
	select * from User
</select>

4.1.6 Setting设置

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

4.2 MyBatis核心配置文件深入

4.2.1 typeHandlers标签

无论是 MyBatis 在预处理语句（PreparedStatement）中设置一个参数时，还是从结果集中取出一个值时， 都会用
类型处理器将获取的值以合适的方式转换成 Java 类型。下表描述了一些默认的类型处理器（截取部分）。

你可以重写类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。具体做法为：实现
org.apache.ibatis.type.TypeHandler 接口， 或继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler， 然
后可以选择性地将它映射到一个JDBC类型。例如需求：一个Java中的Date数据类型，我想将之存到数据库的时候存成一
个1970年至今的毫秒数，取出来时转换成java的Date，即java的Date与数据库的varchar毫秒值之间转换。
开发步骤：
① 定义转换类继承类BaseTypeHandler
② 覆盖4个未实现的方法，其中setNonNullParameter为java程序设置数据到数据库的回调方法，getNullableResult
为查询时 mysql的字符串类型转换成 java的Type类型的方法
③ 在MyBatis核心配置文件中进行注册
④ 测试转换是否正确

实例

public class MyDateTypeHandler extends BaseTypeHandler<Date> {
   //将java类型 转换成 数据库需要的类型
    public void setNonNullParameter(PreparedStatement preparedStatement, int i, Date date, JdbcType jdbcType) throws SQLException {
        long time = date.getTime();
        preparedStatement.setLong(i,time);
    }

    //将数据库中类型 转换成java类型
    //String参数  要转换的字段名称
    //ResultSet 查询出的结果集
    public Date getNullableResult(ResultSet resultSet, String s) throws SQLException {
        //获得结果集中需要的数据(long) 转换成Date类型 返回
        long aLong = resultSet.getLong(s);
        Date date = new Date(aLong);
        return date;
    }

    //将数据库中类型 转换成java类型
    public Date getNullableResult(ResultSet resultSet, int i) throws SQLException {
        long aLong = resultSet.getLong(i);
        Date date = new Date(aLong);
        return date;
    }

    //将数据库中类型 转换成java类型
    public Date getNullableResult(CallableStatement callableStatement, int i) throws SQLException {
        long aLong = callableStatement.getLong(i);
        Date date = new Date(aLong);
        return date;
    }
}

<!--注册类型自定义转换器-->
<typeHandlers>
    <typeHandler handler="com.itheima.typeHandlers.MyDateTypeHandler"></typeHandler>
</typeHandlers>

user.setBirthday(new Date());
userMapper.add2(user);

4.2.2 plugins标签

MyBatis可以使用第三方的插件来对功能进行扩展，分页助手PageHelper是将分页的复杂操作进行封装，使用简单的方式即
可获得分页的相关数据
开发步骤：
① 导入通用PageHelper的坐标
② 在mybatis核心配置文件中配置PageHelper插件
③ 测试分页数据获取

1）

<!-- 分页助手 -->
<dependency>
    <groupId>com.github.pagehelper</groupId>
    <artifactId>pagehelper</artifactId>
    <version>3.7.5</version>
</dependency>
<dependency>
    <groupId>com.github.jsqlparser</groupId>
    <artifactId>jsqlparser</artifactId>
    <version>0.9.1</version>
</dependency>

2）在mybatis核心配置文件中配置PageHelper插件

<!-- 注意：分页助手的插件 配置在通用馆mapper之前 -->
<plugin interceptor="com.github.pagehelper.PageHelper">
    <!-- 指定方言 -->
    <property name="dialect" value="mysql"/>
</plugin>

3 ）测试

@Test
public void testPageHelper(){
    //设置分页参数
    PageHelper.startPage(1,2);
    
    List<User> select = userMapper2.select(null);
    for(User user : select){
        System.out.println(user);
    }
}

扩展

获得分页相关的其他参数

//其他分页的数据
PageInfo<User> pageInfo = new PageInfo<User>(select);
System.out.println("总条数："+pageInfo.getTotal());
System.out.println("总页数："+pageInfo.getPages());
System.out.println("当前页："+pageInfo.getPageNum());
System.out.println("每页显示长度："+pageInfo.getPageSize());
System.out.println("是否第一页："+pageInfo.isIsFirstPage());
System.out.println("是否最后一页："+pageInfo.isIsLastPage());

五、MyBatis的DAO层开发

采用 Mybatis 的代理开发方式实现 DAO 层的开发，这种方式是我们后面进入企业的主流。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的类型相同

dao层

public interface UserDao {
	User findById(int id);
}

mapper映射文件

<mapper namespace="com.itheima.mapper.UserDao">   # namespace 对应 UserDao接口
    #id对应dao层 方法名 parameterType对应dao层参数  resultType对应dao层返回结果
    <select id="findById" parameterType="int" resultType="user">       
        select * from User where id=#{id}                  
    </select>  
</mapper>

六、 MyBatis映射文件深入 动态SQL

• 动态 SQL是MyBatis强大特性之一。极大的简化我们拼装SQL的操作。
• 动态 SQL 元素和使用 JSTL 或其他类似基于 XML 的文本处理器相似。
• MyBatis 采用功能强大的基于 OGNL 的表达式来简化操作。

– if
– choose (when, otherwise)
– trim (where, set)
– foreach

6.1 if

<select id="findByCondition" parameterType="user" resultType="user">
    select * from User
    <where>
        <if test="id!=0">
            and id=#{id}
        </if>
        <if test="username!=null">
            and username=#{username}
        </if>
    </where>
</select>

6.2 foreach

当迭代列表、集合等可迭代对象或者数组时
– index是当前迭代的次数，item的值是本次迭代获取的元素
• 当使用字典（或者Map.Entry对象的集合）时
– index是键，item是值

循环执行sql的拼接操作

<select id="findByIds" parameterType="list" resultType="user">
    select * from User
    <where>
        <foreach collection="array" open="id in(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </where>
</select>

执行sql语句为  select * from user where id in （?,?)

参数

foreach标签的属性含义如下：
标签用于遍历集合，它的属性：
• collection：代表要遍历的集合元素，注意编写时不要写#{} 必填， 集合/数组/Map的名称
• open：代表语句的开始部分
• close：代表结束部分
• item：代表遍历集合的每个元素，生成的变量名
• sperator：代表分隔符

扩展 collection的选择

跟接口方法中的参数相关。

1. 只有一个数组参数或集合参数
默认情况：集合collection=list， 数组是collection=array

推荐：使用 @Param 来指定参数的名称， 如我们在参数前@Param(“ids”)， 则就填写 collection=ids

2. 多参数
多参数请使用 @Param 来指定， 否则SQL中会很不方便

3. 参数是Map
指定为 Map 中的对应的 Key 即可。其实上面的 @Param 最后也是转化为 Map 的。

4. 参数是对象
使用属性.属性即可。

6.3 choose、when、otherwise

这三个标签需要组合在一起使用，类似于 Java 中的 switch、case、default。只有一个条件生效，也就是只执行满足的条件 when，没有满足的条件就执行 otherwise，表示默认条件。

实例

/**
     * - 当 studen_id 有值时， 使用 studen_id 进行查询；
     * - 当 studen_id 没有值时， 使用 name 进行查询；
     * - 否则返回空
     */
    Student selectByIdOrName(Student record);

  <select id="selectByIdOrName" resultMap="BaseResultMap"parameterType="com.homejim.mybatis.entity.Student">
    select
    <include refid="Base_Column_List" />
    from student
    where 1=1
    <choose>
      <when test="studentId != null">
        and student_id=#{studentId}
      </when>
      <when test="name != null and name != ''">
        and name=#{name}
      </when>
      <otherwise>
        and 1=2
      </otherwise>
    </choose>
  </select>

6.4 SQL片段抽取

Sql 中可将重复的 sql 提取出来，使用时用 include 引用即可，最终达到 sql 重用的目的

<!--抽取sql片段简化编写-->
<sql id="selectUser" select * from User</sql>

<select id="findById" parameterType="int" resultType="user">
    <include refid="selectUser"></include> where id=#{id}
</select>
<select id="findByIds" parameterType="list" resultType="user">
    <include refid="selectUser"></include>
    <where>
        <foreach collection="array" open="id in(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </where>
</select>

me != null and name != ‘’">
and name=#{name}


and 1=2

### 6.4 SQL片段抽取

Sql 中可将重复的 sql 提取出来，使用时用 include 引用即可，最终达到 sql 重用的目的

```xml
<!--抽取sql片段简化编写-->
<sql id="selectUser" select * from User</sql>

<select id="findById" parameterType="int" resultType="user">
    <include refid="selectUser"></include> where id=#{id}
</select>
<select id="findByIds" parameterType="list" resultType="user">
    <include refid="selectUser"></include>
    <where>
        <foreach collection="array" open="id in(" close=")" item="id" separator=",">
            #{id}
        </foreach>
    </where>
</select>