Mybatis框架常用配置解析
配置解析
一、核心配置文件
有些属性可以不写,但是如果要写就必须按照下图的顺序
进行配置!
属性(properties)
可以通过xxx.properties属性来实现引用配置文件
这些属性可以在外部进行配置,并可以进行动态替换,如:
编写一个.properties文件,配置需要的属性值内容为
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
jdbc.username=root
jdbc.password=123456
设置好的属性可以在核心配置文件中用来替换需要动态配置的属性值。比如:
<?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="xxx.properties"></properties>
<!-- 配置数据库连接和环境配置 -->
<environments default="development">
<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>
</environments>
</configuration>
设置(settings)
这是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。 下面几个是在开发时常用到的
-
开启驼峰命名
-
日志
-
重要了解
-
想要查看详细的setting设置请看Mybatis中文官方文档
日志输出
- SLF4J
- LOG4J【掌握】
- LOG4J2
- JDK_LOGGING
- COMMONS_LOGGING
- STDOUT_LOGGING 【掌握】
- NO_LOGGING
在Mybatis中具体使用哪一个日志实现,在设置中设定
- STDOUT_LOGGING标准日志输出
<settings>
<!--标准的日志工厂实现-->
<setting name="logImpl" value="STDOUT_LOGGING"/>
</settings>
- LOG4J日志输出
- Log4j是Apache的一个开源项目,通过使用Log4j,我们可以控制日志信息输送的目的地是控制台、文件、GUI组件
- 我们也可以控制每一条日志的输出格式
- 通过定义每一条日志信息的级别,我们能够更加细致地控制日志的生成过程
- 通过一个配置文件来灵活地进行配置,而不需要修改应用的代码
2.1 导入log4j的包(依赖)
<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
2.2 在resources下创建一个log4j.properties文件,内容如下【注意名字必须为log4.properties】
#将等级为DEBUG的日志信息输出到console和file这两个目的地,console和file的定义在下面的代码
log4j.rootLogger=DEBUG,console,file
#控制台输出的相关设置
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Target=System.out
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%c]-%m%n
#文件输出的相关设置
log4j.appender.file=org.apache.log4j.FileAppender
log4j.appender.file.File=./log/log4j.log
log4j.appender.file.MaxFileSize=10mb
log4j.appender.file.Threshold=DEBUG
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=[%p][%d{yy-MM-dd}][%c]%m%n
#日志输出级别
log4j.logger.org.mybatis=DEBUG
log4j.logger.java.sql=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.ResultSet=DEBUG
log4j.logger.java.sql.PrepareStatement=DEBUG
2.3 配置log4j为日志的实现【注意===>value的值必须严格规范,不能有空格,建议复制不要手敲】
<settings>
<!--Log4j的日志工厂实现-->
<setting name="logImpl" value="LOG4J"/>
</settings>
2.4 Log4j的使用,直接测试运行的查询
虽然两种方式都差不多,但是在很多框架中都在使用Log4j,还是要学一学的
类型别名(typeAliases)
类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。例如:
- 具体到某个类
<typeAliases>
<typeAlias alias="User" type="com.xxx.User"/>
</typeAliases>
在我们编写每个对象接口的XXXmapper.xml文件的时候就可以不用把我们具体包下的类名写全
<!-- 原本不配置别名的话
<select id="getUserList" resultType="com.xxx.User" parameterType="com.xxx.User">
select * from mybatis.user
</select>
-->
<!--select查询语句-->
<select id="getUserList" resultType="User" parameterType="User">
select * from mybatis.user
</select>
也可以指定一个包名,MyBatis 会在包名下面搜索需要的 Java Bean,比如:
- 具体到某个类的包下(推荐使用)
<!--
具体到com/xxx/*.class 所有放实体类的包下
-->
<typeAliases>
<package name="com.xxx"/>
</typeAliases>
- 在每个实体类中加入一个注解
@Alias("user")
public class User{
...
}
下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的,注意,为了应对原始类型的命名重复,采取了特殊的命名风格。
类型处理器(typeHandlers)
你可以重写已有的类型处理器或创建你自己的类型处理器来处理不支持的或非标准的类型。 具体做法为:实现 org.apache.ibatis.type.TypeHandler
接口, 或继承一个很便利的类 org.apache.ibatis.type.BaseTypeHandler
比如在数据库中使用 ‘0’表示女 ‘1’表示男 存储性别,而在项目实体类中用的类型是String,就可以写一个MyTypeHandler 实现接口或继承,将读取或存入时进行类型转换处理,
<!-- mybatis-config.xml -->
<typeHandlers>
<typeHandler handler="com.xxx.handler.MyTypeHandler"/>
</typeHandlers>
如果自己写了很多这种类型处理器,可以使用包package标签
<!-- mybatis-config.xml -->
<typeHandlers>
<package name="com.xxx.handler"/>
</typeHandlers>
plugins插件(认识)
<plugins>
Mybatis 允许在已映射语句执行过程中的某一点进行拦截调用,这种拦截调用是通过插件来实现的。<plugins>
元素的作用就是配置用户所开发的插件
拓展
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
我个人觉得是挺方便的,但是也有局限性,大家可以了解一下
映射器(mappers)
MapperRegistry:注册Mapper.xml文件
- 方式一:使用xml文件绑定注册【推荐使用】
<!-- 使用相对于类路径的资源引用 -->
<mappers>
<mapper resource=" com/xxx/mapper/xml/UserMapper.xml"/>
</mappers>
- 方式二:使用class文件绑定注册【注意,这是一个接口】
<!-- 使用映射器接口实现类的完全限定类名 -->
<mappers>
<mapper class=" com.xxx.mapper.UserMapper"/>
</mappers>
- 方式三:使用扫描包进行注入绑定
<!-- 将包内的映射器接口实现全部注册为映射器 -->
<mappers>
<package name=" com.xxx.mapper"/>
</mappers>
生命周期和作用域
生命周期类别是至关重要的,因为错误的使用会导致非常严重的并发问题
SqlSessionFactoryBuilder
- 一旦创建了SqlSessionFactory,就不需要它了
- 因此 SqlSessionFactoryBuilder 实例的最佳作用域是方法作用域(也就是局部方法变量)
- 可以重用 SqlSessionFactoryBuilder 来创建多个 SqlSessionFactory 实例,但最好还是不要一直保留着它,以保证所有的 XML 解析资源可以被释放给更重要的事情
SqlSessionFactory
- 可以想象为数据库连接池
- SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例
- 因此 SqlSessionFactory 的最佳作用域是应用作用域
- 有很多方法可以做到,最简单的就是使用
单例模式
或者静态单例模式
SqlSession
- 连接到连接池的一个请求
- SqlSession 的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域
- 用完之后需要关闭,否则资源被占用
// 确保 SqlSession 关闭的标准模式
SqlSession session = sqlSessionFactory.openSession();
sqlSession.close()
try {
// 你的业务逻辑代码
}catch (Exception e){
// 回滚处理
sqlSession.rollback();
}finally {
// 关闭session会话
sqlSession.close();
}
这里面的每一个Mapper就代表一个具体的业务