06.配置解析
1.核心配置文件 (mybatis-config.xml)
MyBatis 的配置文件包含了影响 MyBatis 行为的设置和属性信息
xml
configuration(配置)
properties(属性)
settings(设置)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境配置)
environment(环境变量)
transactionManager(事务管理器)
dataSource(数据源)
databaseIdProvider(数据库厂商标识)
mappers(映射器)
2.环境配置(environments)
MyBatis 可以配置成适应多种环境
不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
学会使用配置多套运行环境
MyBatis 默认的事务管理器就是 JDBC,连接池:POOLED
xml
<!-- default: 表示使用哪种环境 -->
<environments default="test">
<!-- MySql环境 -->
<environment id="mysql">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?userSSL=true&useUnicode=true&characterEncoding=UTF-8"/>
<property name="username" value="root"/>
<property name="password" value="1234"/>
</dataSource>
</environment>
<!-- Oracle环境 -->
<environment id="oracle环境">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="Driver: com.ibm.db2.jdbc.app.DB2Driver"/>
<property name="url" value="jdbc:db2://localhost:5000/orcl"/>
<property name="username" value="scott"/>
<property name="password" value="ccat"/>
</dataSource>
</environment>
</environments>
3.属性(properties)
我们可以通过 properties 属性来实现引用配置文件
这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置。(db.properties)
编写一个 properties 配置文件
bash
driver=com.mysql.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?userSSL=true&useUnicode=true&characterEncoding=UTF-8
username=root
password=1234
在核心配置文件中引入
xml
<!--
引入外部配置文件
首先读取在 properties 元素体内指定的属性。
然后根据 properties 元素中的 resource 属性读取类路径下属性文件,或根据 url 属性指定的路径读取属性文件,并覆盖之前读取过的同名属性。
-->
<properties resource="db.properties">
<property name="username" value="root"/>
</properties>
使用
xml
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<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>
4.类型别名(typeAliases)
- 类型别名可为 Java 类型设置一个缩写名字。存在的意义仅在于用来降低冗余的全限定类名书写
- MyBatis 中的别名是不区分大小写的
xml
<!-- 可以给实体类起别名 -->
<typeAliases>
<typeAlias type="pojo.User" alias="User"/>
</typeAliases>
- 也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean 每一个在包
org.hong.pojo
中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名,比如org.hong.pojo.User
的别名为user
xml
<typeAliases>
<package name="org.hong.pojo"/>
</typeAliases>
- 若有注解,则别名为其注解值。通常用来解决不同包中相同类名的别名冲突
java
@Alias("author")
public class Author {
...
}
下面是一些为常见的 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 |
5.设置(settings)
设置名 | 描述 | 有效值 | 默认值 |
---|---|---|---|
cacheEnabled | 全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。 | true | false | true |
lazyLoadingEnabled | 延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType | ||
属性来覆盖该项的开关状态。 | true | false | false | |
aggressiveLazyLoading | 开启时,任一方法的调用都会加载该对象的所有延迟加载属性。 否则,每个延迟加载属性会按需加载(参考 lazyLoadTriggerMethods | ||
)。 | true | false | false (在 3.4.1 及之前的版本中默认为 true) | |
mapUnderscoreToCamelCase | 是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 Java 属性名 aColumn。 | true | false | false |
logImpl | 指定 MyBatis 所用日志的具体实现,未指定时将自动查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未设置 |
xml
<settings>
<!-- 开启驼峰命名 -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
6.映射器(mappers)
方式一
xml
<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource="org/hong/mapper/UserMapper.xml"/>
</mappers>
方式二
xml
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="org.hong.mapper.UserMapper"/>
</mappers>
方式三
xml
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
<package name="org.hong.mapper"/>
</mappers>
方式二&方式三的注意点:
- 接口和对应的 Mapper 配置文件必须同名
- 接口和对应的 Mapper 配置文件编译后必须在同一个文件夹下
- 可以把接口和对应的 Mapper创建在同一个包下
- 可以在resources 文件加中创建和接口相同层数并且名称相同的包,然后创建接口对应的 Mapper
7.生命周期和作用域
生命周期和作用域,是至关重要的,因为错误的使用会导致非常严重的并发问题
7.1 SqlSessionFactoryBuilder
- 一旦创建了 SqlSessionFactory,就不再需要它了。 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(局部变量)。
7.2 SqlSessionFactory
- 可以想象为数据库连接池
- SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
- 因此 SqlSessionFactory 的最佳作用域是应用作用域(Application)。
- 最简单的就是使用单例模式或者静态单例模式。
7.3 SqlSession
- 想象为连接到连接池的一个请求
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域
- 用完之后需要马上关闭,否则会导致资源被占用