配置文件
- mybatis框架的核心包括java接口，mapper映射文件mapper.xml，和mybatis自身的核心配置文件mybatis.xml，
核心配置文件中会给mybatis框架自身提供很多信息，比如数据库相关地址，包扫描路径，插件配置等，同时很多
配置会影响mybatis框架的运行行为，比如缓存配置，插件配置等，本文就是围绕核心配置文件中的重点配置展开。
一、properties
- 引入属性文件,配置一些常见变量,一般可以用来引入数据库配置。
<properties resource="db.properties"/>
- db.properties
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://x.x.x.x:3306/demo?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true
jdbc_username=root
jdbc_password=123456
二、settings
- setting用于MyBatis的一些全局属性配置，非常重要，可能会改变mybatis的行为
<!-- 参数设置-重要,setting用于MyBatis的一些全局属性配置，非常重要，可能会改变mybatis的行为-->
<settings>
<!-- 这个配置使全局的映射器启用或禁用缓存-重要 -->
<setting name="cacheEnabled" value="true" />
<!-- 全局启用或禁用延迟加载。当禁用时，所有关联对象都会即时加载-重要 -->
<setting name="lazyLoadingEnabled" value="true" />
<!-- 当启用时，有延迟加载属性的对象在被调用时将会完全加载任意属性。否则，每种属性将会按需要加载 -->
<setting name="aggressiveLazyLoading" value="true" />
<!-- 允许或不允许多种结果集从一个单独的语句中返回（需要适合的驱动） -->
<setting name="multipleResultSetsEnabled" value="true" />
<!-- 使用列标签代替列名。不同的驱动在这方便表现不同。参考驱动文档或充分测试两种方法来决定所使用的驱动 -->
<setting name="useColumnLabel" value="true" />
<!-- 允许JDBC支持生成的键。需要适合的驱动。如果设置为true则这个设置强制生成的键被使用，尽管一些驱动拒绝兼容但仍然有效（比如Derby） -->
<setting name="useGeneratedKeys" value="true" />
<!-- 指定MyBatis如何自动映射列到字段/属性。PARTIAL只会自动映射简单，没有嵌套的结果。FULL会自动映射任意复杂的结果（嵌套的或其他情况） -->
<setting name="autoMappingBehavior" value="PARTIAL" />
<!--当检测出未知列（或未知属性）时，如何处理，默认情况下没有任何提示，这在测试的时候很不方便，不容易找到错误。 NONE : 不做任何处理
(默认值) WARNING : 警告日志形式的详细信息 FAILING : 映射失败，抛出异常和详细信息 -->
<setting name="autoMappingUnknownColumnBehavior" value="WARNING" />
<!-- 配置默认的执行器。SIMPLE执行器没有什么特别之处。REUSE执行器重用预处理语句。BATCH执行器重用语句和批量更新 -->
<setting name="defaultExecutorType" value="SIMPLE" />
<!-- 设置超时时间，它决定驱动等待一个数据库响应的时间 -->
<setting name="defaultStatementTimeout" value="25000" />
<!--设置查询返回值数量，可以被查询数值覆盖 -->
<setting name="defaultFetchSize" value="100" />
<!-- 允许在嵌套语句中使用分页 -->
<setting name="safeRowBoundsEnabled" value="false" />
<!--是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn
的类似映射。 -->
<setting name="mapUnderscoreToCamelCase" value="false" />
<!--MyBatis 利用本地缓存机制（Local Cache）防止循环引用（circular references）和加速重复嵌套查询。
默认值为 SESSION，这种情况下会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT，本地会话仅用在语句执行上，对相同 SqlSession
的不同调用将不会共享数据。 -->
<setting name="localCacheScope" value="SESSION" />
<!-- 当没有为参数提供特定的 JDBC 类型时，为空值指定 JDBC 类型。 某些驱动需要指定列的 JDBC 类型，多数情况直接用一般类型即可，比如
NULL、VARCHAR OTHER。 -->
<setting name="jdbcTypeForNull" value="OTHER" />
<!-- 指定哪个对象的方法触发一次延迟加载。 -->
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString" />
</settings>
三、typeAlias
- 类型别名是为Java类型设置一个短的名字。它只和XML配置有关，存在的意义仅在于用来减少类完全限定名的冗余，如下所示：
<typeAliases>
<package name="com.intellif.mozping.entity"/>
<typeAlias type="com.intellif.mozping.entity.User" alias="user"/>
</typeAliases>
- 既可以配置一个包，也可以配置一个自己指定的别名映射，如果配置了包的话，可以批量扫描，自动生成别名，自动生成的别名是类型或者类名首字母小写 ，比如com.intellif.mozping.entity下面的Player类就可以使用别名Player代替，如果单独指定一个映射的话，就可以自定义别名。
- 上面的自定义别名，其实mybatis中默认提供了很多别名，便于在parameterType(sql入参)和resultType(sql结果映射)中使用，可以参考https://blog.csdn.net/qq_38526573/article/details/86565558#properties_17。
四、typeHandlers
- typeHandlers称做类型处理器。就是实现Java类型和数据库类型之间转换的。 除了系统提供的类型转换器之外，开发者也可以自定义类型转换，比如：
List<—>VARCHAR之间的类型转换，当然这给用的频率不多，大部分情况下系统提供的已经足够使用了。注意在主配置文件中，typeHandlers的配置位置还不能随意放，要放在environments的前面；
4.1 转换器
@MappedJdbcTypes(JdbcType.VARCHAR)//映射器对应的数据库类型
@MappedTypes(List.class)//映射器对应的java类型
public class MyTypeHandler extends BaseTypeHandler<List<String>> {
/**
* 设置非空参数，执行SQL语句时对占位符进行设置
* 比如:sql = "insert into t_menber (name,age,skills)values(?,?,?)"
*/
@Override
public void setNonNullParameter(PreparedStatement ps, int i, List<String> parameter, JdbcType jdbcType) throws SQLException {
System.out.println("setNonNullParameter#setNonNullParameter execute..."+jdbcType);
StringBuilder sb = new StringBuilder();
for (String str : parameter) {
sb.append(str).append(";");
}
//将list拼装成的String设置进去
ps.setString(i, sb.toString());
}
/**
* 下面三个方法都是从数据库中获取记录，我们将获取到的记录从VARCHAR转换为List类型
*
* */
@Override
public List<String> getNullableResult(ResultSet rs, String columnName) throws SQLException {
String[] StrArr = rs.getString(columnName).split(";");
return Arrays.asList(StrArr);
}
@Override
public List<String> getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
String[] StrArr = rs.getString(columnIndex).split(";");
return Arrays.asList(StrArr);
}
@Override
public List<String> getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
String[] StrArr = cs.getString(columnIndex).split(";");
return Arrays.asList(StrArr);
}
}
4.2 配置文件
- 添加typeHandlers的配置
<typeHandlers>
<typeHandler handler="com.intellif.mozping.typehandler.MyTypeHandler" />
</typeHandlers>
4.3 Java接口类
public interface MemberMapper {
int addMember(Member member);
List<Member> findMemberById(int id);
}
4.4 mapper映射文件
<?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="com.intellif.mozping.dao.MemberMapper">
<insert id="addMember" parameterType="com.intellif.mozping.entity.Member">
insert into tb_member(id,name,skills)values(#{id},#{name},#{skills})
</insert>
<select id="findMemberById" resultType="com.intellif.mozping.entity.Member" parameterType="java.lang.Integer">
SELECT * FROM tb_member where id = #{id};
</select>
</mapper>
4.5 测试
public void add() {
SqlSession sqlSession = SqlSessionFactoryUtil.getSqlSessionFactoryInstaceByConfig(CONFIG_FILE_PATH).openSession();
ArrayList<String> arr = new ArrayList<>();
arr.add("computer");
arr.add("Java");
arr.add("Python");
Member member = new Member();
member.setId(1);
member.setName("No 1");
member.setSkills(arr);
MemberMapper mapper = sqlSession.getMapper(MemberMapper.class);
int rowAffected = mapper.addMember(member);
System.out.println("The rows be affected :" + rowAffected);
//显示提交事务
sqlSession.commit();
sqlSession.close();
}
@Test
public void query() {
SqlSession sqlSession = SqlSessionFactoryUtil.getSqlSessionFactoryInstaceByConfig(CONFIG_FILE_PATH).openSession();
MemberMapper mapper = sqlSession.getMapper(MemberMapper.class);
List<Member> members = mapper.findMemberById(1);
for (Member m : members) {
System.out.println(m);
}
}
- 打印：我们看到可以按照我们的需要将字符串转换为List
新增：
:22:12.801 [main] DEBUG c.i.m.dao.MemberMapper.addMember - ==> Preparing: insert into tb_member(id,name,skills)values(?,?,?)
setNonNullParameter#setNonNullParameter execute...null
16:22:12.827 [main] DEBUG c.i.m.dao.MemberMapper.addMember - ==> Parameters: 1(Integer), No 1(String), computer;Java;Python;(String)
16:22:12.830 [main] DEBUG c.i.m.dao.MemberMapper.addMember - <== Updates: 1
The rows be affected :1
查询：
16:22:35.344 [main] DEBUG c.i.m.d.MemberMapper.findMemberById - ==> Preparing: SELECT * FROM tb_member where id = ?;
16:22:35.373 [main] DEBUG c.i.m.d.MemberMapper.findMemberById - ==> Parameters: 1(Integer)
16:22:35.388 [main] DEBUG c.i.m.d.MemberMapper.findMemberById - <== Total: 1
Member(id=1, name=No 1, skills=[computer, Java, Python])
五、plugins
- 用于开发插件，比如分页插件，这里就不代码演示了，后面专门分析下插件和mybatis的分页插件
<plugins>
<plugin interceptor="com.xhm.util.PageInterceptor"></plugin>
</plugins>
六、environments
- 配置多个环境，可以配置多个数据源，根据不同需要选择不同的环境配置，示例如下：
<!--配置environment环境-重要，多数据源下使用,指定默认环境 -->
<environments default="development">
<!-- 环境配置1，每个SqlSessionFactory对应一个环境 -->
<environment id="development1">
<!-- 事务配置 type= JDBC、MANAGED 1.JDBC:这个配置直接简单使用了JDBC的提交和回滚设置。它依赖于从数据源得到的连接来管理事务范围。
2.MANAGED:这个配置几乎没做什么。它从来不提交或回滚一个连接。而它会让容器来管理事务的整个生命周期（比如Spring或JEE应用服务器的上下文）。
默认情况下它会关闭连接。然而一些容器并不希望这样，因此如果你需要从连接中停止它，将closeConnection属性设置为false -->
<transactionManager type="JDBC" />
<!-- <transactionManager type="MANAGED"> <property name="closeConnection"
value="false"/> </transactionManager> -->
<!-- 数据源类型：type = UNPOOLED、POOLED、JNDI 1.UNPOOLED：这个数据源的实现是每次被请求时简单打开和关闭连接。它有一点慢，这是对简单应用程序的一个很好的选择，因为它不需要及时的可用连接。
不同的数据库对这个的表现也是不一样的，所以对某些数据库来说配置数据源并不重要，这个配置也是闲置的 2.POOLED：这是JDBC连接对象的数据源连接池的实现，用来避免创建新的连接实例时必要的初始连接和认证时间。
这是一种当前Web应用程序用来快速响应请求很流行的方法。 3.JNDI：这个数据源的实现是为了使用如Spring或应用服务器这类的容器，容器可以集中或在外部配置数据源，然后放置一个JNDI上下文的引用 -->
<dataSource type="UNPOOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/xhm" />
<property name="username" value="root" />
<property name="password" value="root" />
<!-- 默认连接事务隔离级别 <property name="defaultTransactionIsolationLevel" value=""
/> -->
</dataSource>
</environment>
<!-- 环境配置2 -->
<environment id="development2">
<transactionManager type="JDBC" />
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver" />
<property name="url" value="jdbc:mysql://localhost:3306/xhm" />
<property name="username" value="root" />
<property name="password" value="root" />
<!-- 在任意时间存在的活动（也就是正在使用）连接的数量 -->
<property name="poolMaximumActiveConnections" value="10" />
<!-- 任意时间存在的空闲连接数 -->
<property name="poolMaximumIdleConnections" value="5" />
<!-- 在被强制返回之前，池中连接被检查的时间 -->
<property name="poolMaximumCheckoutTime" value="20000" />
<!-- 这是给连接池一个打印日志状态机会的低层次设置，还有重新尝试获得连接，这些情况下往往需要很长时间（为了避免连接池没有配置时静默失败） -->
<property name="poolTimeToWait" value="20000" />
<!-- 发送到数据的侦测查询，用来验证连接是否正常工作，并且准备接受请求。 -->
<property name="poolPingQuery" value="NO PING QUERY SET" />
<!-- 这是开启或禁用侦测查询。如果开启，你必须用一个合法的SQL语句（最好是很快速的）设置poolPingQuery属性 -->
<property name="poolPingEnabled" value="false" />
<!-- 这是用来配置poolPingQuery多次时间被用一次。这可以被设置匹配标准的数据库连接超时时间，来避免不必要的侦测 -->
<property name="poolPingConnectionsNotUsedFor" value="0" />
</dataSource>
</environment>
<!-- 环境配置3 -->
<environment id="development3">
<transactionManager type="JDBC" />
<dataSource type="JNDI">
<property name="data_source" value="java:comp/env/jndi/mybatis" />
<property name="env.encoding" value="UTF8" />
</dataSource>
</environment>
</environments>
6.1 案例
db.properties属性文件：
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://192.168.11.27:3306/demo?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true
jdbc_username=root
jdbc_password=introcks1234
jdbc_driver_other=com.mysql.jdbc.Driver
jdbc_url_other=jdbc:mysql://192.168.11.11:32000/demo?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true
jdbc_username_other=root
jdbc_password_other=introcks1234
配置文件:
<?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="db.properties"/>
<!--配置environment环境 -->
<environments default="development">
<!-- 环境配置1，每个SqlSessionFactory对应一个环境 -->
<environment id="development">
<transactionManager type="JDBC"/>
<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>
<environment id="other">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${jdbc_driver_other}"/>
<property name="url" value="${jdbc_url_other}"/>
<property name="username" value="${jdbc_username_other}"/>
<property name="password" value="${jdbc_password_other}"/>
</dataSource>
</environment>
</environments>
<!-- 映射文件，mapper的配置文件 -->
<mappers>
<!--直接映射到相应的mapper文件 -->
<!--<mapper resource="mybatis/mapper/PlayerMapper.xml"/>-->
<mapper resource="mybatis/mapper/ItemMapper.xml"/>
</mappers>
</configuration>
6.2 测试
public class Test03 {
private static final String CONFIG_FILE_PATH = "mybatis/mybatis-config-03.xml";
@Test
public void add() throws IOException {
InputStream in = Resources.getResourceAsStream(CONFIG_FILE_PATH);
//保存到第一个环境的数据库
//SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
//保存到第二个环境的数据库
SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in,"other");
SqlSession sqlSession = factory.openSession();
Item item = new Item();
item.setId(1);
item.setDescription("No 1");
int rowAffected = sqlSession.insert("com.intellif.mozping.dao.ItemMapper.addItem", item);
System.out.println("The rows be affected :" + rowAffected);
//显示提交事务
sqlSession.commit();
sqlSession.close();
}
}
- 通过代码我们看到，其实获取某一个数据源，只需要在获取sqlsessionFactory的时候，传一个字符串形式的环境参数就行了，我们完
全可以把这个做成一个配置，根据配置来连接不同环境的数据库。
七、mappers
- mapper可以配置指定的映射文件，也可以通过扫包的方式
<mappers>
<!--直接映射到相应的mapper文件,这种方式，映射文件的名字是自定义的，没有限制 -->
<!--<mapper resource="mybatis/mapper/PlayerMapper.xml"/>-->
<!--扫描包路径下所有xxMapper.xml文件,这种方式更简单,通过包扫描去加载mapper文件，此时候对mapper文件名有要求，要求mapper文件名和mapper接口必须一致(约定大于配置) -->
<package name="com.intellif.mozping.mapper" />
</mappers>
- 如果在mybatis的配置文件中没有配置映射文件，或者没有将相应的映射文件加到mapper中，sqlsession加载一个接口，会报如下错，如下：
<!-- 比如如下配置：-->
<mappers>
<!--直接映射到相应的mapper文件 -->
<!--<mapper resource="mybatis/mapper/MemberMapper.xml"/>-->
</mappers>
//执行代码就会报错：
MemberMapper mapper = sqlSession.getMapper(MemberMapper.class);
org.apache.ibatis.binding.BindingException: Type interface com.intellif.mozping.dao.MemberMapper is not known to the MapperRegistry.
八、参考
Java 面试宝典是大明哥全力打造的 Java 精品面试题，它是一份靠谱、强大、详细、经典的 Java 后端面试宝典。它不仅仅只是一道道面试题，而是一套完整的 Java 知识体系，一套你 Java 知识点的扫盲贴。
它的内容包括：
- 大厂真题：Java 面试宝典里面的题目都是最近几年的高频的大厂面试真题。
- 原创内容：Java 面试宝典内容全部都是大明哥原创，内容全面且通俗易懂，回答部分可以直接作为面试回答内容。
- 持续更新：一次购买，永久有效。大明哥会持续更新 3+ 年，累计更新 1000+，宝典会不断迭代更新，保证最新、最全面。
- 覆盖全面：本宝典累计更新 1000+，从 Java 入门到 Java 架构的高频面试题，实现 360° 全覆盖。
- 不止面试：内容包含面试题解析、内容详解、知识扩展，它不仅仅只是一份面试题，更是一套完整的 Java 知识体系。
- 宝典详情：https://www.yuque.com/chenssy/sike-java/xvlo920axlp7sf4k
- 宝典总览：https://www.yuque.com/chenssy/sike-java/yogsehzntzgp4ly1
- 宝典进展：https://www.yuque.com/chenssy/sike-java/en9ned7loo47z5aw
目前 Java 面试宝典累计更新 400+ 道，总字数 42w+。大明哥还在持续更新中，下图是大明哥在 2024-12 月份的更新情况：
想了解详情的小伙伴，扫描下面二维码加大明哥微信【daming091】咨询
同时，大明哥也整理一套目前市面最常见的热点面试题。微信搜[大明哥聊 Java]或扫描下方二维码关注大明哥的原创公众号[大明哥聊 Java] ，回复【面试题】 即可免费领取。
