mybatis知识

mybatis+maven项目搭建

• 搭建一个简单的maven+mybatis项目

• 在pom.xml加上mybatis和数据库的配置，我这里用mysql示例

  <?xml version="1.0" encoding="UTF-8"?>
  <project xmlns="http://maven.apache.org/POM/4.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
  
      <groupId>org.example</groupId>
      <artifactId>mybatis</artifactId>
      <version>1.0-SNAPSHOT</version>
  
      <dependencies>
  
          <!-- 添加mybatis依赖 -->
          <dependency>
              <groupId>org.mybatis</groupId>
              <artifactId>mybatis</artifactId>
              <version>3.5.6</version>
          </dependency>
  
          <!-- mysql数据连接驱动 -->
          <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <version>8.0.22</version>
          </dependency>
  
          <!-- lombok工具 -->
          <dependency>
              <groupId>org.projectlombok</groupId>
              <artifactId>lombok</artifactId>
              <version>1.18.16</version>
              <scope>provided</scope>
          </dependency>
  
          <!-- junit单元测试 -->
          <dependency>
              <groupId>junit</groupId>
              <artifactId>junit</artifactId>
              <version>4.13.1</version>
              <scope>test</scope>
          </dependency>
  
      </dependencies>
  
  
  </project>
  

• 创建实体类和dao接口

  • 实体类

    package org.example.entity;
    
    import lombok.Data;
    
    @Data
    public class Student {
        private String name;
        private Integer age;
        private Integer teacherId;
        private Teacher teacher;
    }
    
    

  • dao接口

    package org.example.dao;
    
    import org.example.entity.Student;
    
    import java.util.List;
    
    public interface StudentDao {
    
        List<Student> selectStudent();
    }
    

• 在resource/mapper目录下创建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="org.example.dao.StudentDao">
  
      <sql id="all_columns">
          id, name, age, teacher_id
      </sql>
  
      <select id="selectStudent" resultType="student">
          select <include refid="all_columns"></include> from student
      </select>
  
  </mapper>
  
  

• 在resource目录创建config.properties、mybatis-config.xml

  • config.properties文件

    driver=com.mysql.cj.jdbc.Driver
    url=jdbc:mysql://115.159.208.22/ry_vue?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
    username=ry_vue
    password=*********
    

  • 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="config.properties"/>
    
        <settings>
            <!-- 打印查询语句 -->
            <setting name="logImpl" value="STDOUT_LOGGING" />
            <setting name="mapUnderscoreToCamelCase" value="true"/>
        </settings>
    
        <!--起别名-->
        <typeAliases>
            <typeAlias type="org.example.entity.Student" alias="student"/>
            <typeAlias type="org.example.entity.Teacher" alias="teacher"/>
        </typeAliases>
        <environments default="defauleEnvironment">
            <environment id="defauleEnvironment">
                <transactionManager type="JDBC"></transactionManager>
                <dataSource type="POOLED">
                    <!--从配置文件读取参数-->
                    <property name="driver" value="${driver}"/>
                    <property name="url" value="${url}"/>
                    <property name="username" value="${username}"/>
                    <property name="password" value="${password}"/>
                </dataSource>
            </environment>
        </environments>
    
    
        <mappers>
            <mapper resource="mapper/StudentMapper.xml"/>
        </mappers>
    
    </configuration>
    
    

• 单元测试类

  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.example.entity.Student;
  import org.junit.BeforeClass;
  import org.junit.Test;
  
  import java.io.IOException;
  import java.io.Reader;
  import java.util.List;
  
  public class StudentMapperTest {
  
      private static SqlSessionFactory sqlSessionFactory;
  
      @BeforeClass
      public static void init() {
          try {
              Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
              sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
          } catch (IOException e) {
              e.printStackTrace();
          }
      }
  
      @Test
      public void testSelectList() {
          SqlSession sqlSession = null;
          try {
              sqlSession = sqlSessionFactory.openSession();
  
              List<Student> students = sqlSession.selectList("selectStudent");
              for (int i = 0; i < students.size(); i++) {
                  System.out.println(students.get(i));
              }
          } catch (Exception e) {
              e.printStackTrace();
          } finally {
              if (sqlSession != null) {
                  sqlSession.close();
              }
          }
      }
  }
  
  

Mybatis配置文件详解(位置不能颠倒)

Mybatis九大类全局配置节点按照如下顺序排序，位置不能颠倒。

​ properties=>settings=>typeAliases=>typeHandlers=>objectFactory=>plugins=>environment=>databaseIdProvider=>mappers

需要注意的是，MyBatis 配置项的顺序不能颠倒。如果颠倒了它们的顺序，那么在 MyBatis 启动阶段就会发生异常，导致程序无法运行。

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 /><!-- 属性 -->
    <settings /><!-- 设置 -->
    <typeAliases /><!-- 类型命名 -->
    <typeHandlers /><!-- 类型处理器 -->
    <objectFactory /><!-- 对象工厂 -->
    <plugins /><!-- 插件 -->
    <environments><!-- 配置环境 -->
        <environment><!-- 环境变量 -->
            <transactionManager /><!-- 事务管理器 -->
            <dataSource /><!-- 数据源 -->
        </environment>
    </environments>
    <databaseIdProvider /><!-- 数据库厂商标识 -->
    <mappers /><!-- 映射器 -->
</configuration>

properties元素

properties 属性可以给系统配置一些运行参数，可以放在 XML 文件或者 properties 文件中，而不是放在 Java编码中，这样的好处在于方便参数修改，而不会引起代码的重新编译。一般而言，MyBatis 提供了 3 种方式让我们使用 properties，它们是：

property 子元素。

properties 文件。

程序代码传递

• property 子元素

  <?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>
          <property name="driver" value="com.mysql.jdbc.Driver" />
          <property name="url" value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8" />
          <property name="username" value="root" />
          <property name="password" value="1128" />
      </properties>
      <typeAliases>
          <typeAlias alias="role" type="com.mybatis.po.Role"/>
      </typeAliases>
      <!--数据库环境-->
      <environments default="development">
          <environment id="development">
              <transactionManager type="JDBC" />
              <dataSource type="POOLED">
                  <property name="driver" value="com.mysql.jdbc.Driver" />
                  <property name="url"    value="jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8" />
                  <property name="username" value="root" />
                  <property name="password" value="1128" />
              </dataSource>
          </environment>
      </environments>
      <!-- 映射文件 -->
      <mappers>
          <mapper resource="com/mybatis/mapper/RoleMapper.xml" />
      </mappers>
  </configuration>
  

  这里使用了元素 下的子元素 定义，用字符串 database.username 定义数据库用户名，然后就可以在数据库定义中引入这个已经定义好的属性参数，如 ${database.username}，这样定义一次就可以到处引用了。但是如果属性参数有成百上千个，显然使用这样的方式不是一个很好的选择，这个时候可以使用 properties 文件。

• 使用 properties 文件

  使用 properties 文件是比较普遍的方法，一方面这个文件十分简单，其逻辑就是键值对应，我们可以配置多个键值放在一个 properties 文件中，也可以把多个键值放到多个 properties 文件中，这些都是允许的，它方便日后维护和修改。

  我们创建一个文件 jdbc.properties 放到 classpath 的路径下，如下所示。

  database.driver=com.mysql.jdbc.Driver
  database.url=jdbc:mysql://localhost:3306/mybatis
  database.username=root
  database.password=1128
  

  在 MyBatis 中通过 的属性 resource 来引入 properties 文件。

  也可以按 ${database.username} 的方法引入 properties 文件的属性参数到 MyBatis 配置文件中。这个时候通过维护 properties 文件就可以维护我们的配置内容了。

settings属性配置详解

在 MyBatis 中 settings 是最复杂的配置，它能深刻影响 MyBatis 底层的运行，但是在大部分情况下使用默认值便可以运行，所以在大部分情况下不需要大量配置它，只需要修改一些常用的规则即可，比如自动映射、驼峰命名映射、级联规则、是否启动缓存、执行器（Executor）类型等。settings 配置项说明，如表 1 所示。

配置项	作用	配置选项	默认值
cacheEnabled	该配置影响所有映射器中配置缓存的全局开关	true|false	true
lazyLoadingEnabled	延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。在特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态	true|false	false
aggressiveLazyLoading	当启用时，对任意延迟属性的调用会使带有延迟加载属性的对象完整加载；反之，每种属性将会按需加载	true|felse	版本3.4.1 （不包含） 之前 true，之后 false
multipleResultSetsEnabled	是否允许单一语句返回多结果集（需要兼容驱动）	true|false	true
useColumnLabel	使用列标签代替列名。不同的驱动会有不同的表现，具体可参考相关驱动文档或通过测试这两种不同的模式来观察所用驱动的结果	true|false	true
useGeneratedKeys	允许JDBC 支持自动生成主键，需要驱动兼容。如果设置为 true，则这个设置强制使用自动生成主键，尽管一些驱动不能兼容但仍可正常工作（比如 Derby）	true|false	false
autoMappingBehavior	指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示取消自动映射。 PARTIAL 表示只会自动映射，没有定义嵌套结果集和映射结果集。 FULL 会自动映射任意复杂的结果集（无论是否嵌套）	NONE、PARTIAL、FULL	PARTIAL
autoMappingUnkno wnColumnBehavior	指定自动映射当中未知列（或未知属性类型）时的行为。 默认是不处理，只有当日志级别达到 WARN 级别或者以下，才会显示相关日志，如果处理失败会抛出 SqlSessionException 异常	NONE、WARNING、FAILING	NONE
defaultExecutorType	配置默认的执行器。SIMPLE 是普通的执行器；REUSE 会重用预处理语句（prepared statements）；BATCH 执行器将重用语句并执行批量更新	SIMPLE、REUSE、BATCH	SIMPLE
defaultStatementTimeout	设置超时时间，它决定驱动等待数据库响应的秒数	任何正整数	Not Set (null)
defaultFetchSize	设置数据库驱动程序默认返回的条数限制，此参数可以重新设置	任何正整数	Not Set (null)
safeRowBoundsEnabled	允许在嵌套语句中使用分页（RowBounds）。如果允许，设置 false	true|false	false
safeResultHandlerEnabled	允许在嵌套语句中使用分页（ResultHandler）。如果允许，设置false	true|false	true
mapUnderscoreToCamelCase	是否开启自动驼峰命名规则映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射	true|false	false
localCacheScope	MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速联复嵌套査询。 默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlScssion 的不同调用将不会共享数据	SESSION|STATEMENT	SESSION
jdbcTypeForNull	当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如 NULL、VARCHAR 或 OTHER	NULL、VARCHAR、OTHER	OTHER
lazyLoadTriggerMethods	指定哪个对象的方法触发一次延迟加载	—	equals、clone、hashCode、toString
defaultScriptingLanguage	指定动态 SQL 生成的默认语言	—	org.apache.ibatis .script.ing.xmltags .XMLDynamicLanguageDriver
callSettersOnNulls	指定当结果集中值为 null 时，是否调用映射对象的 setter（map 对象时为 put）方法，这对于 Map.kcySet() 依赖或 null 值初始化时是有用的。注意，基本类型（int、boolean 等）不能设置成 null	true|false	false
logPrefix	指定 MyBatis 增加到日志名称的前缀	任何字符串	Not set
loglmpl	指定 MyBatis 所用日志的具体实现，未指定时将自动査找	SLF4J|LOG4J|LOG4J2|JDK_LOGGING |COMMONS_LOGGING |ST DOUT_LOGGING|NO_LOGGING	Not set
proxyFactory	指定 MyBatis 创建具有延迟加栽能力的对象所用到的代理工具	CGLIB|JAVASSIST	JAVASSIST （MyBatis 版本为 3.3 及以上的）
vfsImpl	指定 VFS 的实现类	提供 VFS 类的全限定名，如果存在多个，可以使用逗号分隔	Not set
useActualParamName	允许用方法参数中声明的实际名称引用参数。要使用此功能，项目必须被编译为 Java 8 参数的选择。（从版本 3.4.1 开始可以使用）	true|false	true

settings 的配置项很多，但是真正用到的不会太多，我们把常用的配置项研究清楚就可以了，比如关于缓存的 cacheEnabled，关于级联的 lazyLoadingEnabled 和 aggressiveLazy Loading，关于自动映射的 autoMappingBehavior 和 mapUnderscoreToCamelCase，关于执行器类型的 defaultExecutorType 等。

这里给出一个全量的配置样例，如下所示。

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

typeAliases（别名）详解

由于类的全限定名称很长，需要大量使用的时候，总写那么长的名称不方便。在 MyBatis 中允许定义一个简写来代表这个类，这就是别名，别名分为系统定义别名和自定义别名。

在 MyBatis 中别名由类 TypeAliasRegistry（org.apache.ibatis.type.TypeAliasRegistry）去定义。注意，在 MyBatis 中别名不区分大小写

• 系统定义别名

在 MyBatis 的初始化过程中，系统自动初始化了一些别名，如下表所示。

别名	Java 类型	是否支持数组
_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	是
object	Object	是
map	Map	否
hashmap	HashMap	否
list	List	否
arraylist	ArrayList	否
collection	Collection	否
iterator	Iterator	否
ResultSet	ResultSet	否

如果需要使用对应类型的数组型，要看其是否能支持数据，如果支持只需要使用别名加[]即可，比如 _int 数组的别名就是 _int[]。而类似 list 这样不支持数组的别名，则不能那么写。

• 自定义别名

由于现实中，特别是大型互联网系统中存在许多对象，比如用户（User）这个对象有时候需要大量重复地使用，因此 MyBatis 也提供了用户自定义别名的规则。我们可以通过 TypeAliasRegistry 类的 registerAlias 方法注册，也可以采用配置文件或者扫描方式来自定义它。

使用配置文件定义很简单：

<typeAliases><!--别名-->
    <typeAlias alias="role" type="com.mybatis.po.Role"/>
    <typeAlias alias="role" type="com.mybatis.po.User"/>
</typeAliases>

这样就可以定义一个别名了。如果有很多类需要定义别名，那么用这样的方式进行配置可就不那么轻松了。MyBatis 还支持扫描别名。比如上面的两个类都在包 com.mybatis.po 之下，那么就可以定义为：

<typeAliases><!--别名-->
    <package name="com.mybatis.po"/>
</typeAliases>

这样 MyBatis 将扫描这个包里面的类，将其第一个字母变为小写作为其别名，比如类 Role 的别名会变为 role，而 User 的别名会变为 user。使用这样的规则，有时候会出现重名。

比如 com.mybatis.po.User 这个类，MyBatis 还增加了对包 com.mybatis.po 的扫描，那么就会出现异常，这个时候可以使用 MyBatis 提供的注解 @Alias（“user3”）进行区分，如下所示。

package com.mybatis.po;
@Alias("user3")
public Class User {    ......}

这样就能够避免因为别名重名导致的扫描失败的问题。

typeHandlers详解

将参数传给预处理语句时，需要将数据从javaType（java类型）转换为jdbcType（jdbc类型）；

将结果集中的数据转换为指定类型时，需要将数据从jdbcType转换为javaType。

这2个过程都要用到typeHandler（类型转换器）。一般我们使用mybatis自带的类型转换器即可，也可以在中引用自定义的类型转换器。

ObjectFactory详解

ObjectFactory负责创建结果实例。

将查询结果映射为指定对象时，默认的ObjectFactory先调用无参的构造器创建pojo类的实例，再调用setter方法注入值。

一般我们使用默认的ObjectFactory即可，也可以在中引用自定义的ObjectFactory类。

plugins详解

mybatis允许在将查询结果映射为指定类型的过程中，以插件形式执行自定义的代码。

environments详解

环境配置，mybatis是持久层框架，它的环境自然是数据库，即数据库的配置。

<environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"></transactionManager>
            <dataSource type="POOLED">
                <property name="driver" value="${mysql_driver}"/>
                <property name="url" value="${mysql_url}"/>
                <property name="username" value="${mysql_username}"/>
                <property name="password" value="${mysql_password}"/>
            </dataSource>
        </environment>
</environments>

一般要配置多个环境，开发一个环境，正式使用一个环境。default指定要使用哪个。

一个即一个环境（数据库配置）。

指定使用哪种事务管理，通常使用JDBC的事务管理。如果搭配Spring使用，一般使用Spring的事务管理（在spring中配置事务管理），不在mybatis中配置事务。

配置数据源，mybatis提供了三种数据源：

• UNPOOLED 不使用连接池
• POOLED 使用连接池
• JNDI 适合在在EJB或应用服务器等容器中使用

type指定使用哪种数据源，子元素设置具体选项

UNPOOLED

不使用连接池，适合对性能没有要求的、简单的应用程序。

常用属性：

• driver、url、username、password
• defaultTransactionlsolationLevel 设置默认的事务隔离级别

POOLED

操作数据库速度更快，适合高并发的程序，很常用。

常用属性：

• driver、url、username、password
• defaultTransactionlsolationLevel 设置默认的事务隔离级别
• poolMaximumActiveConnections 最大活跃连接数
• poolMaximumIdleConnections 最大闲置连接数

mapper详解

用于引入映射文件。写法很多，常用的有3种：

• 通过映射文件的路径引入

<mappers>
        <mapper resource="com/chy/mapper/StudentMapper.xml"/>
        <mapper resource="com/chy/mapper/TeacherMapper.xml"/>
</mappers>

• 通过mapper接口类引入

<mappers>
        <mapper class="com.chy.mapper.StudentMapper"/>
</mappers>

• 通过包名引入

<mappers>
        <package name="com.chy.mapper"/>
</mappers>

这种最常用，可以一次性引入mapper包下所有的映射文件。

https://mybatis.org/mybatis-3/zh/dynamic-sql.html