Mybatis---详解Mybatis-config.xml配置文件

本文详细解析MyBatis核心配置文件mybatis-config.xml的各项元素及其作用,包括typeAliases、environments、transactionManager、dataSource等关键配置。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  经过前面的两篇博文,我觉得对Mybatis的正题理解已经足够了,但是对Mybatis的使用,我觉得还是会有一点的模糊,就我个人而言,我觉得掌握好Mybatis框架,主要要明白三个文件,第一个就是等下要谈论的Mybatis-comfig.xml文件,还有就是**Mapper.xml,以及我们所定义的Mapper类,理解了这三个东西,然后有sql的基础,还有java的基础的话,后面不论是使用基于xml的方法,还是基于java-based Configuration的方法,都会简单的多。

  废话不多说,现在就一起来理解一下第一个重要的文件:Mybatis-config.xml文件。  
  首先我们来看一下,一个空白的完整的Mybatis-config.xml文件(这个名字可以自由操作,必须要记住这个是Mybatis配置文件就行)  
可以直接创建一个空白的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>

</configuration

上面这个就是基本的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>
<typeAliases>
<typeAlias alias="Student" type="com.mybatis3.domain.Student" />
</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/test" />
<property name="username" value="root" />
<property name="password" value="admin" />
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="com/mybatis3/mappers/StudentMapper.xml" />
</mappers>
</configuration>
从上面的内容里面我们可以看见的标签有下面这些,但是这些是什么意思呢?

<configuration>:声明在标签里面的信息是配置信息

<typeAliases>:声明在该标签里面的信息是一个个的别名

<typealias>:声明要使用别名的对象(全路径)用java注解的话可以使用@Alias注解声明
<environments>:声明在该标签内的环境变量,default表示默认的环境变量,一个environment表示一个jdbc连接数据库,如果有很多数据库的话我们要用到不同的环境变量

<environment>:声明环境变量

<transactionManager>:声明事务管理器      它的类型(type)有:JDBC(基于jdbc的事务) 还有 MANAGED(托管的事务)

<dataSource>:声明数据源,数据源的类型有NOPOOLED ,POOLED ,还有JIDN在数据量少的话用ONPOOLED,测试和开发过程一般用POOLED,实际运行使用JIDN

<property>:jdbc连接的一些属性

<mappers>:声明我们定义的一个个Mapper类,或者说是关联

<mapper>:声明Mapper的路径

上面说到的都是在使用Mybatis要使用到的基本标签,必须要掌握,可能不明白上面那个environments的使用,怎么去获取一个environment,下面看看一个例子来:

InputStream in = Resource.getResourceAsInputSteam("mybatis.config");
	//定义默认environment
	defaultSqlSessionFactory = new SqlSessionFactoryBuilder().build(in);
	//其他的environment
    otherSqlSessionFactory = new SqlSessionFactoryBuilder().build(in, "environment的ID");
上面的defaultSqlSessionFactory要自己声明(注意)

那么除了上面的标签之外还有哪些标签呢?下面在一个看看比较常用的其他标签

<Settings>:声明一些全局变量的

<properties>:声明属性文件的key和value,但是如果使用了.properties文件将会被覆盖。

<typeHandlers>:自定义我们的传入参数类型处理器,需要extends BaseTypeHandler<自定义响应的类型>

最后再来看看Mybatis默认的setting配置:

<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="defaultExecutorType" value="SIMPLE" />
<setting name="defaultStatementTimeout" value="25000" />
<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" />
上面的配置一般使用默认的就好,如果业务中需要的话再修改I,这就不多说了。下一篇我将会介绍下一个重要的文件**Mapper.xml.




<think>我们正在讨论MyBatis的核心配置文件mybatis-config.xml。根据引用[1][2][3],这个文件是MyBatis的全局配置文件,用于配置数据库连接信息、类型处理器、别名、插件等。下面我将详细解释mybatis-config.xml的配置内容。 ###1.配置文件结构概览根据引用[2],mybatis-config.xml的顶层结构是`<configuration>`,包含以下元素(按顺序): ```xml<configuration><!--属性配置 --><properties .../><!--设置 --><settings .../><!--类型别名--><typeAliases... /><!--类型处理器 --><typeHandlers .../><!--对象工厂--><objectFactory .../><!--插件 --><plugins .../><!--环境配置--><environments ...><!--环境变量 --><environment ...><!--事务管理器 --><transactionManager... /><!--数据源 --><dataSource... /></environment></environments><!--数据库厂商标识--><databaseIdProvider... /><!--映射器 --><mappers... /></configuration> ```**注意**:这些元素的顺序是固定的,如果顺序不对会导致解析错误。 ###2.各配置详解####2.1 properties(属性) 用于配置外部属性文件或直接定义属性,便于动态替换。例如数据库连接参数可放在`jdbc.properties`文件中: ```xml<propertiesresource="jdbc.properties"><!--也可以内嵌属性--><propertyname="jdbc.username"value="root"/></properties> ```在配置中通过`${key}`引用:```xml<dataSourcetype="POOLED"><propertyname="driver"value="${jdbc.driver}"/><property name="url" value="${jdbc.url}"/></dataSource> ```####2.2 settings(设置) 调整MyBatis运行时行为。例如开启日志、开启二级缓存等。引用[3]给出了日志配置示例: ```xml<settings><!--输出日志到控制台 --><setting name="logImpl"value="STDOUT_LOGGING"/><!--开启二级缓存--><settingname="cacheEnabled" value="true"/><!--驼峰命名转换--><settingname="mapUnderscoreToCamelCase" value="true"/> </settings>``` [MyBatis设置选项完整列表](https://mybatis.org/mybatis-3/configuration.html#settings)包含数十项配置。####2.3 typeAliases(类型别名)为Java类型设置短名称,避免在MapperXML中写冗长的全限定名。例如:```xml<typeAliases><!--单个类配置别名--><typeAliasalias="User"type="com.example.entity.User"/><!--扫描整个包,默认别名为类名(首字母小写) --><package name="com.example.entity"/> </typeAliases>``` MyBatis已内置常见类型的别名(如`String`->`string`,`Map`->`map`)。####2.4 typeHandlers(类型处理器)用于Java类型与JDBC类型之间的转换。例如:```xml<typeHandlers><!--注册单个处理器--><typeHandler handler="com.example.MyTypeHandler"/><!--扫描包下所有处理器--><packagename="com.example.handler"/> </typeHandlers>``` MyBatis已内置常用处理器(如字符串、日期等),自定义处理器需实现`TypeHandler`接口。####2.5 plugins(插件) 通过拦截器实现功能扩展。例如分页插件:```xml<plugins><plugin interceptor="com.github.pagehelper.PageInterceptor"><property name="helperDialect" value="mysql"/></plugin> </plugins>``` ####2.6environments(环境配置) 配置多套环境(开发、测试、生产),每个环境包含事务管理器和数据源。```xml<environmentsdefault="development"><environment id="development"><!--使用JDBC事务管理--><transactionManager type="JDBC"/><!--连接池数据源 --><dataSourcetype="POOLED"><propertyname="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`(容器管理)。 -**dataSource**:可选`UNPOOLED`(无连接池)、`POOLED`(内置池)、`JNDI`(容器提供)。 ####2.7mappers(映射器)注册Mapper接口或XML文件的位置。```xml<mappers><!--注册单个XML映射文件--><mapperresource="mapper/UserMapper.xml"/><!--注册单个Mapper接口 --><mapper class="com.example.mapper.UserMapper"/><!--扫描包下所有Mapper接口 --><package name="com.example.mapper"/></mappers>``` ###3.完整配置示例结合以上内容,一个典型的`mybatis-config.xml`如下: ```xml<?xmlversion="1.0"encoding="UTF-8"?> <!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration><!--加载外部属性文件--><propertiesresource="jdbc.properties"/><settings><!--开启二级缓存 --><settingname="cacheEnabled" value="true"/><!--开启驼峰命名转换 --><setting name="mapUnderscoreToCamelCase"value="true"/><!--日志输出 --><setting name="logImpl"value="STDOUT_LOGGING"/></settings><typeAliases><package name="com.example.entity"/></typeAliases><typeHandlers><package name="com.example.handler"/></typeHandlers><environments default="development"><environmentid="development"><transactionManagertype="JDBC"/><dataSource type="POOLED"><property name="driver" value="${jdbc.driver}"/><propertyname="url"value="${jdbc.url}"/><propertyname="username"value="${jdbc.username}"/><propertyname="password"value="${jdbc.password}"/></dataSource></environment></environments><mappers><packagename="com.example.mapper"/></mappers></configuration> ```###4.注意事项1. **XML顺序**:子元素必须按标准顺序排列,否则会报错。2.**外部化配置**:推荐将数据库连接信息放在`jdbc.properties`中,便于不同环境切换。 3. **与Spring整合**:在SpringBoot中,大部分配置可通过`application.yml`完成,无需单独配置`mybatis-config.xml`[^1]。---###相关问题1.如何在MyBatis中配置多数据源?2.MyBatis二级缓存的实现原理是什么? 3.如何自定义MyBatis的类型处理器(TypeHandler)?4.MyBatis插件(拦截器)的开发流程是怎样的?[^1]:MyBatis官方文档配置章节[^2]: mybatis-config.xml核心结构说明[^3]:日志配置示例</think>### MyBatis `mybatis-config.xml` 配置文件详解 `mybatis-config.xml` 是 MyBatis 的**核心全局配置文件**,用于设置数据库连接、类型处理器、别名等运行时行为。以下是完整配置结构和详解(基于引用[1][2][3]): --- ### 一、配置文件基础结构 ```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> <!-- 配置项按固定顺序排列 --> </configuration> ``` --- ### 二、核心配置项详解 #### 1. `properties`:外部属性配置 **作用**:加载外部属性文件(如数据库连接信息) ```xml <properties resource="jdbc.properties"> <!-- 引用外部文件 --> <property name="jdbc.username" value="root"/> <!-- 内联属性 --> </properties> ``` - 优先级:内联属性 > 外部文件属性 - 使用方式:`${jdbc.driver}` 动态替换 #### 2. `settings`:运行时行为调整 **作用**:控制 MyBatis 底层机制(缓存、日志等) ```xml <settings> <!-- 启用日志输出(引用[3]) --> <setting name="logImpl" value="STDOUT_LOGGING"/> <!-- 开启二级缓存 --> <setting name="cacheEnabled" value="true"/> <!-- 自动驼峰命名转换 --> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> ``` [完整设置列表](https://mybatis.org/mybatis-3/configuration.html#settings) #### 3. `typeAliases`:类型别名 **作用**:为 Java 类型定义短名称 ```xml <typeAliases> <!-- 单个别名 --> <typeAlias alias="User" type="com.example.entity.User"/> <!-- 扫描包下所有类(默认别名=类名首字母小写) --> <package name="com.example.entity"/> </typeAliases> ``` #### 4. `typeHandlers`:类型处理器 **作用**:处理 Java 类型与 JDBC 类型转换 ```xml <typeHandlers> <!-- 注册单个处理器 --> <typeHandler handler="com.example.JsonTypeHandler"/> <!-- 扫描整个包 --> <package name="com.example.handler"/> </typeHandlers> ``` #### 5. `environments`:环境配置(核心) **作用**:配置数据库连接和事务 ```xml <environments default="development"> <environment id="development"> <!-- 事务管理器(JDBC 或 MANAGED) --> <transactionManager type="JDBC"/> <!-- 数据源(UNPOOLED/POOLED/JNDI) --> <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> ``` #### 6. `mappers`:映射器注册 **作用**:加载 SQL 映射文件或接口 ```xml <mappers> <!-- 加载 XML 映射文件 --> <mapper resource="mapper/UserMapper.xml"/> <!-- 注册 Mapper 接口 --> <mapper class="com.example.mapper.UserMapper"/> <!-- 扫描包下所有接口 --> <package name="com.example.mapper"/> </mappers> ``` --- ### 三、完整配置示例 ```xml <configuration> <properties resource="db.properties"/> <settings> <setting name="logImpl" value="STDOUT_LOGGING"/> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> <typeAliases> <package name="com.example.entity"/> </typeAliases> <typeHandlers> <package name="com.example.handler"/> </typeHandlers> <environments default="dev"> <environment id="dev"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="${db.driver}"/> <property name="url" value="${db.url}"/> <property name="username" value="${db.user}"/> <property name="password" value="${db.pass}"/> </dataSource> </environment> </environments> <mappers> <package name="com.example.mapper"/> </mappers> </configuration> ``` --- ### 四、注意事项 1. **配置顺序强制要求**: ```mermaid graph LR A[properties] --> B[settings] B --> C[typeAliases] C --> D[typeHandlers] D --> E[environments] E --> F[mappers] ``` 顺序错误会导致启动失败[^2]。 2. **与 Spring Boot 整合**: 在 Spring Boot 中,大部分配置可通过 `application.yml` 实现,无需单独配置 `mybatis-config.xml`[^1]。 3. **XML 与注解混合使用**: - XML 配置优先级高于注解 - 复杂 SQL 建议使用 XML,简单查询可用注解 --- ### 五、配置验证方法 1. **日志检查**: 启用 `logImpl: STDOUT_LOGGING` 查看初始化日志[^3]: ``` DEBUG [main] - Loaded Configuration: ... ``` 2. **单元测试**: ```java @Test void testConfig() throws IOException { String resource = "mybatis-config.xml"; InputStream is = Resources.getResourceAsStream(resource); SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(is); assertNotNull(factory); // 验证配置可加载 } ``` --- ### 相关问题 1. 如何在 Spring Boot 中替代 `mybatis-config.xml` 的配置? 2. MyBatis 类型处理器(TypeHandler)的开发流程是什么? 3. 如何配置 MyBatis 的多数据源环境? 4. MyBatis 二级缓存的启用和优化策略有哪些? [^1]: MyBatis 核心配置文件结构说明 [^2]: 配置元素顺序强制性要求 [^3]: 日志配置与应用实例
评论 9
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值