Mybatis常用配置
V哥官网:http://www.vgxit.com
本文对应视频教程:http://www.vgxit.com/course/22
1,概述
Mybatis的配置文件并不复杂,它所有的元素可以归纳为如下:
<!--配置-->
<configuration>
<!--属性-->
<properties/>
<!--设置-->
<settings/>
<!--类型命名-->
<typeAliases/>
<!--类型处理器-->
<typeHandlers/>
<!--对象工厂-->
<objectFactory/>
<!--插件-->
<plugins/>
<!--配置环境-->
<environments>
<!--环境变量-->
<environment>
<!--事务管理器-->
<transactionManager/>
<!--数据源-->
<dataSource/>
</environment>
</environments>
<!--数据库厂商标识-->
<databaseIdProvider/>
<!--映射器-->
<mappers/>
注意:Mybatis的配置项顺序是不能颠倒的。必须按照老师在上面列出来的顺序从上往下编写。如果顺序颠倒了,mybaits就会报错。
2,properties属性
properties属性相当于就是我们java代码里面的定义的常量。我们可以定义好了这些常量,然后再配置文件中使用。
比如在mybatis中,们通过properties属性定义数据库链接的参数:
<properties>
<property name="database.driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="database.url" value="jdbc:mysql://localhost:3306/mybatis.ktdm?serverTimezone=Asia/Shanghai"/>
<property name="database.username" value="root"/>
<property name="database.password" value="Abc@123456"/>
</properties>
我们使用的时候,可以通过如下方式:
<dataSource type="POOLED">
<property name="driver" value="${database.driver}"/>
<property name="url" value="${database.url}"/>
<property name="username" value="${database.username}"/>
<property name="password" value="${database.password}"/>
</dataSource>
我们把这个properties定义运行参数类比我们Java中定义一些常量,然后引用常量。所有的常量都应以在properties中,每一个常量用property来定义。
但是我们使用properties文件的方式来定义属性更加常用。具体操作:
1,我们定义一个jdbc.properties的文件,然后再文件中定义对应的常量:
database.driver=com.mysql.cj.jdbc.Driver
database.url=jdbc:mysql://localhost:3306/mybatis.ktdm?serverTimezone=Asia/Shanghai
database.username=root
database.password=Abc@123456
2,为了让jdbc.properties文件生效,我们需要在mybatis-config.xml中引入一下:
<properties resource="jdbc.properties"/>
3,使用的时候,方式和我们用property来定义的方式一样
3,settings
settings代表的就是Mybatis的一些设置。它是属于Mybatis中最为复杂的配置,它能深刻的影响Mybatis的底层运行,但是大部分情况下我们直接使用默认值就可以了,所以我们几乎是不需要去改变的,基本上只需要修改一些常用的配置就可以了。
settings之前我们也讲过,比如我们要把Mybatis的sql打印在控制台的时候,我们就用到了。
这里具体我们要使用的设置是非常多的,但是大部分情况下不使用。这里我们就给大家引出一下我们有setting配置就好了,具体的使用我们后面降到了要用我们再说。
4,typeAliases
typeAliases是用来设定别名的,由于很多类的全限定名称很长,需要大量使用的时候,总写那么长的名称不方便。在Mybatis中允许定义一个简写来代表这个类,就是别名。
在Mybatis里面已经自带的给我们定义好了很多别名了
因为使用别名一般情况下都是在使用xml文件定义sql的时候才会用到,使用注解是不会用到的。但是老师告诉大家,在实际的开发中,使用xml的方式来定义sql还是主流。
那么接下来,我们看看怎么使用。
1,通过xml的方式来定义别名
我们直接在mybatis-config.xml中定义别名:
<typeAliases>
<typeAlias type="com.vgxit.learn.vgmybatis.ktdm.po.User" alias="vguser"/>
</typeAliases>
然后再Mapper中具体使用:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//rnybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.vgxit.learn.vgmybatis.ktdm.mapper.UserMapper">
<insert id="addUser" parameterType="vguser">
insert into user values (null, #{name}, #{gender}, #{age});
</insert>
<update id="updateUser" parameterType="vguser">
update user set name=#{name}, gender=#{gender}, age=#{age} where id=#{id}
</update>
<delete id="deleteUser" parameterType="int">
delete from user where id=#{id}
</delete>
<select id="getUserById" parameterType="int" resultType="vguser">
select * from user where id=#{id}
</select>
</mapper>
2,通过xml的方式来定义一个包下面所有类的别名:
<!--定义别名-->
<typeAliases>
<package name="com.vgxit.learn.vgmybatis.ktdm.po"/>
</typeAliases>
这种方式会把这个包下面的所有的类全部扫描,然后定义别名,这种定义别名的方式,就是把类的首字母编程小写就可以了。比如我们的类叫User,那么自动定义别别名就叫user
3,通过注解的方式定义别名:
我们使用xml的方式扫描包可以大大的简化我们对别名的定义,但是又产生了一个新的问题。比如我们自动生成的别名不是我们想要的怎么办?
这个时候,我们可以使用注解的方式来定义(使用Alias注解):
package com.vgxit.learn.vgmybatis.ktdm.po;
import lombok.Builder;
import lombok.Data;
import org.apache.ibatis.type.Alias;
@Data
@Builder
@Alias("vguser")
public class User {
/**
* 自增Id
*/
private Integer id;
/**
* 用户姓名
*/
private String name;
/**
* 用户性别,1表示男,2表示女
*/
private Short gender;
/**
* 年龄
*/
private Integer age;
}
5,运行环境配置
在MyBatis中,运行环境主要的作用是配置数据库信息,它可以配置多个数据库,但是一般而言只需要配置其中的一个就可以了。它下面又分为两个可配置的元素:
- 事务管理器(transactionManager)
- 数据源(dataSource)
在以后实际的开发中,我们多半使用的是采用Spring来对数据源和数据库事务进行管理。但是目前我们给大家介绍Mybatis自己怎么实现:
我们再mybatis-config.xml中配置运行环境的代码如下:
<!--配置运行环境,默认是develop-->
<environments default="develop">
<environment id="develop">
<!--配置使用Mybatis的Jdbc事务管理器-->
<transactionManager type="JDBC"></transactionManager>
<dataSource type="POOLED">
<property name="driver" value="${database.driver}"/>
<property name="url" value="${database.url}"/>
<property name="username" value="${database.username}"/>
<property name="password" value="${database.password}"/>
</dataSource>
</environment>
</environments>
从上面配置中,我们可以看出来,配置环境,主要就是用到了两个元素,一个是transactionManager(事务管理器),一个是dataSource(数据源)。
1,事务管理器:
这里老师给大家说一下,Mybatis提供了两个事务管理器,这两个事物关联企都实现了Transaction是接口.这个接口,我们通过源代码可以发现,事物管理器主要做的事情就是事物的提交或回滚,以及关闭数据库连接。我们继续跟踪代码可以发现Transaction接口有两个实现类,一个叫做JdbcTransaction,还有一个叫做ManagedTransaction。这两哥实现类分别是通过两个不同的工厂来创建的。这两个工厂分别就是JdbcTransactionFactory和ManagedTransactionFacotry。那么要配置对应的事物管理器的时候应该怎么办呢?
<!--配置Mybatis要使用的JDBC事务管理器-->
<transactionManager type="JDBC"/>
<!--配置Mybatis使用Managed管理器-->
<transactionManager type="MANAGED"/>
JDBC和MANAGED事务管理器的区别是什么?
- JDBC使用JdbcTransactionFactory生成的JdbcTransaction来实现。它是以JDBC的方式对数据库进行提交或者回滚操作。如果我们是把程序发布到Tomcat服务器上的时候,我们需要自己管理事物,这个时候就应该使用JDBC。
- MANAGED使用ManagedTransactionFacotry生成的ManagedTransaction来实现的,它的提交和回滚不做任何的操作,而是把事务交给Servlet容器来处理。比如我们把JavaEE程序发布到类似于JBoss,WebLogic,GlassFish等服务器上的时候,他们会使用EJB进行服务器的事物管理能力。在这些环境中,你可以使用MANAGED。
2,数据源环境
在Mybatis中,我们可以通过三个工厂类来给我们创建数据源,这三个工厂类分别是PooledDataSourceFacotry, UnpooledDataSourceFacotry和JndiDataSourceFacotry。我们在使用的时候配置如下:
<dataSource type="POOLED">
<dataSource type="UNPOOLED">
<dataSource type="JNDI">
但是JNDI一般情况我们在比如EJB的这类容器中使用。但是我们课程不适用EJB,我们使用Tomcat,所以这个数据源不讲。
UNPOOLED:
UNPOOLED采用的是非数据库连接池的方式,每次请求都会打开一个新的数据库连接,所以创建会比较慢。在一些对性能没有要求的情况下,如果你的服务器配置又实在是太可怜了。这个时候我们可以使用。这个数据源又如下几个属性可以配置:
- driver:数据库驱动的名称
- url:数据库连接地址
- username:用户名
- password:密码
- defaultTransactionIsolationLevel:数据库事务隔离级别(这个很少使用)
POOLED:
这个数据源使用的数据库连接池的方式,它启动起来的时候,可能一开始的时候有一些连接的闲置。并且已经连接好了数据库。所以我们在请求的时候无需再建立连接。这个性能就非常高。这个就类似于我们之前学JDBC的时候用过Druid。
POOLED可以配置UNPOOLED的所有属性。但是除此之外还提供了一些其他的属性(了解):
- poolMaximumActiveConnections:是在任意时间都存在的活动( 也就是正在使用)连接数量,也就是最大连接数量,默认值为10。
- poolMaximumIdleConnections 是任意时间可能存在的空闲连接数。也就是最大空闲连接数量。
- poolMaximumCheckoutTime 最大可回收时间,即当达到最大活动链接数时,此时如果有程序获取连接,则检查最先使用的连接,看其是否超出了该时间,如果超出了该时间,则可以回收该连接。默认是20秒
- poolTimeToWait 如果获取连接花费时间太长,它会给连接池打印状态日志,并重新尝试获取一个连接,它可以避免在误配置的情况下一直失败,默认是20秒
- poolPingQuery 为发送到数据库的侦查询,用来检验连接是否处于正常工作只需中,并准备接受请求。默认是"NO PING QUERY SET",这回导致多数据库驱动失败时带有一个恰当的错误信息
- poolPingConnectionsNotUsedFor 为配置poolPingQuery使用频度。这可以被设置成匹配具体的数据库连接超时时间,来避免不必要的侦测,默认值为0(即所有连接每一时刻都被侦测,仅当poolPingEnabled为true的时候适用)。
注意:我们一般情况下,不用去重新设置上面的参数,因为真正的做开发的时候,我们肯定是使用Spring来做开发,我们根本不会使用mybatis自带的连接池。
6,数据库厂商标识(了解)
databaseIdProvider这个数据库厂商标识,基本上在项目开发中不会用,但是同学们还是需要了解一下。
比如我们开发了一个系统,这个系统我们要提供给多个客户使用,客户一说他们希望这个系统能够在Mysql上使用。而客户二说他们希望这个系统可以在Oracle上使用。这个时候怎么办?
这个时候我们可以使用如下方法:
1,首先在mybatis-config.xml中定义databaseIdProvider:
<databaseidProvider type="DB_VENDOR">
<property name= "Oracle" value="oracle"/>
<property name= "MySQL" value ="mysql"/>
<property name= "DB2 " value="db2"/>
</databaseidProvider>
2,然后我们再xml中编写sql的时候编写如下两个代码:
<select id="getUser" parameterType="long" resultType="user" databaseId="oracle">
select * from user where id=#{id}
</select>
<select id="getUser" parameterType="long" resultType="user" databaseId="mysql">
select * from user where 1=1 and id=#{id}
</select>
7,Mapper引入的方法
1,引入对应的xml,这个方法必须要存在对应的xml映射文件的时候,我们才能使用。如果使用这种方式,xml文件方在任何地方都没有问题:
<mappers>
<mapper resource="mapper/UserMapper.xml"/>
</mappers>
2,引入Mapper接口,这种方式注解和xml映射文件的方式都可以。这里我们需要xml文件和Mapper应该方在同一个包下面:
<mappers>
<mapper class="com.vgxit.learn.vgmybatis.ktdm.mapper.UserMapper"/>
<mapper class="com.vgxit.learn.vgmybatis.ktdm.mapper.UserAnnMapper"/>
</mappers>
3,通过扫描包的方式(推荐使用),如果使用这种方式,这里我们需要xml文件和Mapper应该方在同一个包下面:
<mappers>
<package name="com.vgxit.learn.vgmybatis.ktdm.mapper"/>
</mappers>