- 来源:官方文档-XML配置
- 配置文件的内容有一定顺序,可以缺省,但不可以“插队”,顺序依照以下的来:
configuration
properties(属性)
settings(设置)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境配置)
environment(环境变量)
transactionManager(事务管理器)
dataSource(数据源)
databaseIdProvider(数据库厂商标识)
mappers(映射器)
一、属性(properties)
- 这些属性可以在外部进行配置,并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性,也可以在 properties 元素的子元素中设置
- 首先在
resources
文件夹中新建文件config.properties
,并写入需要被配置的属性
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8
username=root
password=root
- 在
mybatis-config.xml
文件的configuration
中加入properties
结构。若无需要添加的内容,properties
部分添加一个单行结构即可。通过${}
使用properties
的内容
<configuration>
<!-- 读入外部配置文件-->
<properties resource="config.properties"/>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- sql驱动,需要根据实际情况修改 -->
<property name="driver" value="${driver}"/>
<!-- sql的url -->
<property name="url" value="${url}"/>
<!-- 用户名及密码 -->
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!-- 设置需要被扫描的mapper,路径通过`/`分隔!-->
<mappers>
<mapper resource="com/du/mybatis/dao/UserMapper.xml"/>
</mappers>
</configuration>
也可以在properties
中加入额外的property
<properties resource="config.properties">
<property name="username" value="root"/>
<property name="password" value="root"/>
</properties>
- 注意:当外部配置文件和property内容冲突时,以外部配置文件为准
- 也可以在 SqlSessionFactoryBuilder.build() 方法中传入属性值
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, props); // props为读入的properties文件
// ... 或者 ...
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment, props);
二、类型别名(typeAliases)
- 类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写
<!-- 设置别名 -->
<!-- type是原全限定类名 alias是之后的别名,会使用 Bean 的首字母小写的非限定类名来作为它的别名 -->
<typeAliases>
<typeAlias type="com.du.mybatis.pojo.User" alias="user"/>
</typeAliases>
type是原全限定类名 alias是之后的别名,会使用 Bean 的首字母小写的非限定类名来作为它的别名
<!-- 设置别名 -->
<typeAliases>
<!-- 扫描包内所有bean,并将所有类名取别名为,字母小写的非限定类名 -->
<package name="com.du.mybatis.pojo"/>
</typeAliases>
扫描包内所有bean,并将所有类名取别名为,字母小写的非限定类名。即
com.du.mybatis.pojo.User
的别名为user
- 可以在bean上面加一个注解,表示它的别名。在扫描包的时候,以注解的别名为准(但我试过好像不行...)
@Alias("author")
public class Author {
...
}
- 常见的 Java 类型内建的类型别名
三、环境配置(environments)
- 可以配置多种环境,并在default中选择一种作为默认的环境。
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- sql驱动,需要根据实际情况修改-->
<property name="driver" value="${driver}"/>
<!-- sql的url-->
<property name="url" value="${url}"/>
<!-- 用户名及密码-->
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<!-- sql驱动,需要根据实际情况修改-->
<property name="driver" value="${driver}"/>
<!-- sql的url-->
<property name="url" value="${url}"/>
<!-- 用户名及密码-->
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
可选development和test两种环境,目前选择的是development
3.1 事务管理器(transactionManager)
- 在 MyBatis 中有两种类型的事务管理器(也就是 type="[JDBC|MANAGED]"),一般选默认的JDBC即可
- 如果你正在使用 Spring + MyBatis,则没有必要配置事务管理器,因为 Spring 模块会使用自带的管理器来覆盖前面的配置。这两种事务管理器类型都不需要设置任何属性。它们其实是类型别名,换句话说,你可以用 TransactionFactory 接口实现类的全限定名或类型别名代替它们
3.2 数据源(dataSource)
- 有三种内建的数据源类型(也就是 type="[UNPOOLED|POOLED|JNDI]")
- UNPOOLED:这个数据源的实现会每次请求时打开和关闭连接
- POOLED:这种数据源的实现利用“池”的概念将 JDBC 连接对象组织起来,避免了创建新的连接实例时所必需的初始化和认证时间。 这种处理方式很流行,能使并发 Web 应用快速响应请求
- JNDI:这个数据源实现是为了能在如 EJB 或应用服务器这类容器中使用,容器可以集中或在外部配置数据源,然后放置一个 JNDI 上下文的数据源引用
四、映射器(mappers)
- 定义 SQL 映射语句,一共有几种方法
- 使用文件路径
<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
<mapper resource="org/mybatis/builder/BlogMapper.xml"/>
<mapper resource="org/mybatis/builder/PostMapper.xml"/>
</mappers>
- 通过接口的类名查找包内与类名相同的文件
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class="org.mybatis.builder.AuthorMapper"/>
<mapper class="org.mybatis.builder.BlogMapper"/>
<mapper class="org.mybatis.builder.PostMapper"/>
</mappers>
xml文件必须与接口文件放在同一个文件夹下,且名字要一样
- 扫描指定包内所有mapper
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
<package name="org.mybatis.builder"/>
</mappers>
条件与上方相同