您当前的位置:首页 > 电脑百科 > 程序开发 > 框架

一文带你掌握mybatis的所有全局配置

时间:2021-03-12 10:18:49  来源:  作者:
一文带你掌握mybatis的所有全局配置

 

MyBatis全局配置文件

配置properties

可以在全局配置文件中配置properties标签来进行外部配置

设置属性的方式有三种

  • 在properties的属性节点resource或url所指定的资源文件中配置
  • 在properties的子节点property中配置
  • 在构建SqlSessionFactory时通过方法传入参数

外部配置文件引入

jdbc.driver=com.MySQL.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=123456
<!-- 使用 properties来引入外部配置文件内容-->
<!-- resource  引入类路径下的资源
     url  引入网路或磁盘路径下的资源
 -->
<properties resource="jdbc.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>

property子节点配置

<!-- 也可以使用property子节点来进行配置 -->
<properties resource="jdbc.properties">
    <property name="jdbc.password" value="123456"/>
    <!-- 启用默认值特性 -->
    <property name="org.Apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
    <!-- 修改默认值的分隔符 -->
    <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
</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="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
             如果开启该特性,默认使用:分隔
             可以使用         <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
             来修改默认分隔符
             -->
            <property name="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>
</environments>

实例化时方法传参

public static SqlSessionFactory createFactory(){
    // 获取到mybatis-config.xml配置文件,进而构建SqlSessionFactory
    InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream("mybatis-config.xml");
    Properties props = new Properties();
    props.put("jdbc.password","123456");
    return new SqlSessionFactoryBuilder().build(is,props);
}

三种方式的顺序

  • 首先读取property子节点中指定的属性
  • 再读取使用resources或url引入的外部配置文件中属性,并覆盖之前的同名属性
  • 最后读取作为方法传递的参数,并覆盖之前的同名属性

配置settings

进行mybatis的自定义设置

设置名

描述

有效值

默认值

cacheEnabled

全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。

true | false

true

lazyLoadingEnabled

延迟加载的全局开关。当开启时,所有关联对象都会延迟加载。 特定关联关系中可通过设置 fetchType 属性来覆盖该项的开关状态。

true | false

false

aggressiveLazyLoading

开启时,任一方法的调用都会加载该对象的所有延迟加载属性。 否则,每个延迟加载属性会按需加载(参考 lazyLoadTriggerMethods)。

true | false

false (在 3.4.1 及之前的版本中默认为 true)

multipleResultSetsEnabled

是否允许单个语句返回多结果集(需要数据库驱动支持)。

true | false

true

useColumnLabel

使用列标签代替列名。实际表现依赖于数据库驱动,具体可参考数据库驱动的相关文档,或通过对比测试来观察。

true | false

true

useGeneratedKeys

允许 JDBC 支持自动生成主键,需要数据库驱动支持。如果设置为 true,将强制使用自动生成主键。尽管一些数据库驱动不支持此特性,但仍可正常工作(如 Derby)。

true | false

False

autoMAppingBehavior

指定 MyBatis 应如何自动映射列到字段或属性。 NONE 表示关闭自动映射;PARTIAL 只会自动映射没有定义嵌套结果映射的字段。 FULL 会自动映射任何复杂的结果集(无论是否嵌套)。

NONE, PARTIAL, FULL

PARTIAL

autoMappingUnknownColumnBehavior

指定发现自动映射目标未知列(或未知属性类型)的行为。NONE: 不做任何反应WARNING: 输出警告日志('
org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等级必须设置为 WARN)FAILING: 映射失败 (抛出 SqlSessionException)

NONE, WARNING, FAILING

NONE

defaultExecutorType

配置默认的执行器。SIMPLE 就是普通的执行器;REUSE 执行器会重用预处理语句(PreparedStatement); BATCH 执行器不仅重用语句还会执行批量更新。

SIMPLE REUSE BATCH

SIMPLE

defaultStatementTimeout

设置超时时间,它决定数据库驱动等待数据库响应的秒数。

任意正整数

未设置 (null)

defaultFetchSize

为驱动的结果集获取数量(fetchSize)设置一个建议值。此参数只可以在查询设置中被覆盖。

任意正整数

未设置 (null)

defaultResultSetType

指定语句默认的滚动策略。(新增于 3.5.2)

FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT(等同于未设置)

未设置 (null)

safeRowBoundsEnabled

是否允许在嵌套语句中使用分页(RowBounds)。如果允许使用则设置为 false。

true | false

False

safeResultHandlerEnabled

是否允许在嵌套语句中使用结果处理器(ResultHandler)。如果允许使用则设置为 false。

true | false

True

mapUnderscoreToCamelCase

是否开启驼峰命名自动映射,即从经典数据库列名 A_COLUMN 映射到经典 JAVA 属性名 aColumn。

true | false

False

localCacheScope

MyBatis 利用本地缓存机制(Local Cache)防止循环引用和加速重复的嵌套查询。 默认值为 SESSION,会缓存一个会话中执行的所有查询。 若设置值为 STATEMENT,本地缓存将仅用于执行语句,对相同 SqlSession 的不同查询将不会进行缓存。

SESSION | STATEMENT

SESSION

jdbcTypeForNull

当没有为参数指定特定的 JDBC 类型时,空值的默认 JDBC 类型。 某些数据库驱动需要指定列的 JDBC 类型,多数情况直接用一般类型即可,比如 NULL、VARCHAR 或 OTHER。

JdbcType 常量,常用值:NULL、VARCHAR 或 OTHER。

OTHER

lazyLoadTriggerMethods

指定对象的哪些方法触发一次延迟加载。

用逗号分隔的方法列表。

equals,clone,hashCode,toString

defaultScriptingLanguage

指定动态 SQL 生成使用的默认脚本语言。

一个类型别名或全限定类名。

org.apache.ibatis.scripting.xmltags.XMLLanguageDriver

defaultEnumTypeHandler

指定 Enum 使用的默认 TypeHandler 。(新增于 3.4.5)

一个类型别名或全限定类名。

org.apache.ibatis.type.EnumTypeHandler

callSettersOnNulls

指定当结果集中值为 null 的时候是否调用映射对象的 setter(map 对象时为 put)方法,这在依赖于 Map.keySet() 或 null 值进行初始化时比较有用。注意基本类型(int、boolean 等)是不能设置成 null 的。

true | false

false

returnInstanceForEmptyRow

当返回行的所有列都是空时,MyBatis默认返回 null。 当开启这个设置时,MyBatis会返回一个空实例。 请注意,它也适用于嵌套的结果集(如集合或关联)。(新增于 3.4.2)

true | false

false

logPrefix

指定 MyBatis 增加到日志名称的前缀。

任何字符串

未设置

logImpl

指定 MyBatis 所用日志的具体实现,未指定时将自动查找。

SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING

未设置

proxyFactory

指定 Mybatis 创建可延迟加载对象所用到的代理工具。

CGLIB | JAVASSIST

JAVASSIST (MyBatis 3.3 以上)

vfsImpl

指定 VFS 的实现

自定义 VFS 的实现的类全限定名,以逗号分隔。

未设置

useActualParamName

允许使用方法签名中的名称作为语句参数名称。 为了使用该特性,你的项目必须采用 Java 8 编译,并且加上 -parameters 选项。(新增于 3.4.1)

true | false

true

configurationFactory

指定一个提供 Configuration 实例的类。 这个被返回的 Configuration 实例用来加载被反序列化对象的延迟加载属性值。 这个类必须包含一个签名为static Configuration getConfiguration() 的方法。(新增于 3.2.3)

一个类型别名或完全限定类名。

未设置

shrinkWhitespacesInSql

从SQL中删除多余的空格字符。请注意,这也会影响SQL中的文字字符串。 (新增于 3.5.5)

true | false

false

defaultSqlProviderType

Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted.

 

 

配置typeAliases类型别名

类型别名可以为java类型设置别名,之后使用全类名时可以使用别名

<typeAliases>
    <!-- typeAlias为某个类起别名 -->
    <typeAlias type="com.zhanghe.study.mybatis.model.User" alias="User"/>

    <!-- 为某个包下所有类批量起别名
        默认值为类名首字母小写
     -->
    <package name="com.zhanghe.study.mybatis.model"/>
</typeAliases>

也可以在类上使用@Alias注解来设置该类的别名

配置类型处理器typeHandlers

数据库类型和java类型进行转换

实现 org.apache.ibatis.type.TypeHandler 接口, 或继承 org.apache.ibatis.type.BaseTypeHandler, 并且可以将它映射到一个 JDBC 类型

@MappedJdbcTypes(JdbcType.VARCHAR)
public class ExampleTypeHandler extends BaseTypeHandler<String> {

  @Override
  public void setNonNullParameter(PreparedStatement ps, int i, String parameter, JdbcType jdbcType) throws SQLException {
    ps.setString(i, parameter);
  }

  @Override
  public String getNullableResult(ResultSet rs, String columnName) throws SQLException {
    return rs.getString(columnName);
  }

  @Override
  public String getNullableResult(ResultSet rs, int columnIndex) throws SQLException {
    return rs.getString(columnIndex);
  }

  @Override
  public String getNullableResult(CallableStatement cs, int columnIndex) throws SQLException {
    return cs.getString(columnIndex);
  }
}
<typeHandlers>
  <typeHandler handler="org.mybatis.example.ExampleTypeHandler"/>
</typeHandlers>

配置插件plugins

mybatis可以使用插件来在映射语句执行过程中的某一点进行拦截调用,包括

  • Executor (update、query、flushStatements、commit、rollback、getTransaction、close、isClose)
  • ParameterHandler (getParameterObject、setParameters)
  • ResultSetHandler (handleResultSets、handleOutputParameters)
  • StatementHandler (prepare、parameterize、batch、update、query)

需要实现Interceptor接口,并指定想要拦截的方法签名来使用插件

Intercepts({@Signature(
  type= Executor.class,
  method = "update",
  args = {MappedStatement.class,Object.class})})
public class ExamplePlugin implements Interceptor {
  private Properties properties = new Properties();
  public Object intercept(Invocation invocation) throws Throwable {
    // implement pre processing if need
    Object returnObject = invocation.proceed();
    // implement post processing if need
    return returnObject;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
}
<plugins>
  <plugin interceptor="org.mybatis.example.ExamplePlugin">
    <property name="someProperty" value="100"/>
  </plugin>
</plugins>

注意:如果有多个插件拦截相同方法的时候,会按照配置的先后顺序来进行包装代理,在执行时会执行最外层的插件,也就是逆向执行

配置环境environments

mybatis可以配置多个环境,可以连接多个数据库,但是每个SqlSessionFactory实例只可以选择一种环境

在构建sqlSessionFactory的时候可以指定选择创建哪个环境

SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environment);
<!-- 环境 default表示默认使用环境  -->
<environments default="development">
    <environment id="development">
        <!-- 事务管理器有两种类型
            1、JDBC  该配置直接使用了JDBC的提交和回滚,依赖从数据源获得的连接来管理事务作用域
            2、MANAGED 使用容器来管理事务的整个生命周期(spring会使用自带的管理器,不需要配置mybatis的事务管理器)
         -->
        <transactionManager type="JDBC"/>
        <!-- 数据源有三种类型
            1、UNPOOLED  每次请求时打开和关闭连接
                额外属性  - defaultTransactionIsolationLevel  默认的连接事务隔离级别
                         - defaultNetworkTimeout  等待数据库操作完成的默认网络超时时间
            2、POOLED  利用连接池的概念将JDBC连接对象组织起来,避免了创建新的连接实例
                额外属性
                    - poolMaximumactiveConnections 在任意时间可存在的活动连接数,默认10
                    - poolMaximumIdleConnections  任意时间可能存在的空闲连接数
                    - poolMaximumCheckoutTime  在被强制返回之前,池中连接被检出时间,默认20000毫秒
                    - poolTimeToWait  如果获取连接花费了很长的时间,连接池会打印状态日志并重新尝试获取一个连接,默认20000毫秒
                    - poolMaximumLocalBadConnectionTolerance  如果一个线程获取到一个坏的连接,数据源允许这个线程尝试重新获取一个新的连接,
                                                              尝试次数不应该超过poolMaximumIdleConnections与poolMaximumLocalBadConnectionTolerance之和,默认为3
                    - poolPingQuery  发送到数据库的侦测查询,用来检验连接是否正常工作   默认 NO PING QUERY SET
                    - poolPingEnabled  是否启用侦测查询  默认false
                    - poolPingConnectionsNotUsedFor  配置poolPingQuery的频率(可以设置为和数据库连接超时时间一样,避免不必要的侦测)  默认0
            3、JNDI  在外部配置数据源,然后一个JNDI上下文数据源引用
                额外属性
                    - initial_context  用来在InitialContext中寻找上下文
                    - data_source  引用数据源实例的上下文路径
         -->
        <dataSource type="POOLED">
            <property name="driver" value="${jdbc.driver}"/>
            <property name="url" value="${jdbc.url}"/>
            <property name="username" value="${jdbc.username}"/>
            <!-- 可以使用:来为占位符设置默认值,如果没有读取到该属性的值,会使用该默认值
             该特性默认关闭,需要配置        <property name="org.apache.ibatis.parsing.PropertyParser.enable-default-value" value="true"/>
             如果开启该特性,默认使用:分隔
             可以使用         <property name="org.apache.ibatis.parsing.PropertyParser.default-value-separator" value="?:"/>
             来修改默认分隔符
             -->
            <property name="password" value="${jdbc.password?:123456}"/>
        </dataSource>
    </environment>

也可以实现
org.apache.ibatis.datasource.DataSourceFactory接口来自定义数据源实现,然后进行配置

配置数据库厂商标识 databaseIdProvider

mybatis可以根据不同的数据库厂商执行不同的语句,基于映射语句中的databaseId属性。mybatis会加载带有匹配当前数据库databaseId属性个所有不带databaseId属性的语句。如果同时找到带有databaseId的不带databaseId的相同语句,后者会被舍弃

<!-- 数据库厂商标识 -->
<databaseIdProvider type="DB_VENDOR">
  <!-- name为使用DatabaseMetaData#getDatabaseProductName()返回的厂商名称
             value为所设置的别名,使用databaseId时使用别名即可 -->
  <property name="MySQL" value="mysql"/>
  <property name="Oracle" value="oracle"/>
</databaseIdProvider>

在mapper.xml中可以配置不同数据库的sql语句

<!-- 查询数据的方法 -->
<!-- mysql -->
<select id="selectUser" resultType="User" databaseId="mysql">
    select * from users where id = #{id}
</select>
<!-- oracle -->
<select id="selectUser" resultType="User" databaseId="oracle">
    select * from users where id = #{id}
</select>

可以实现
org.apache.ibatis.mapping.DatabaseIdProvider接口自定义DatabaseIdProvider

配置映射器mappers

将写好的sql映射文件(mapper.xml)注册到全局配置文件中

<!-- mapper配置 -->
<mappers>
    <!-- resource  引入类路径下的资源  -->
    <mapper resource="mapper/UserMapper.xml"/>
    <!-- url  引入网络或者磁盘路径下的sql映射文件 -->
    <mapper url=""/>
    <!-- class  基于注解的方式,注册类文件 -->
    <mapper class="com.zhanghe.study.mybatis.mapper.UserMapper"/>
    <!-- 批量注册 注册整个包下的-->
    <package name="com.zhanghe.study.mybatis.mapper"/>
</mappers>


Tags:mybatis   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
本篇文章主要介绍了使用MyBatis框架完成数据库的增、删、改、查操作。准备工作运行schema.sql和data.sql脚本文件中的 SQL 语句创建t_user表并添加部分测试数据。schema.sql...【详细内容】
2022-07-15  Tags: mybatis  点击:(0)  评论:(0)  加入收藏
简介MetaObject 是 MyBatis 中的反射工具类,用于获取和设置对象的属性值。示例List<Order> orders = new ArrayList<>(2);orders.add(new Order("1", "001", "美的电压力锅")...【详细内容】
2022-07-06  Tags: mybatis  点击:(18)  评论:(0)  加入收藏
简介SqlRunner,一个非常实用的、用于操作数据库的工具类。该类对JDBC进行了很好的封装,结合SQL工具类,能够很方便地通过Java代码执行SQL语句并检索SQL执行结果。SqlRunner提供...【详细内容】
2022-07-05  Tags: mybatis  点击:(19)  评论:(0)  加入收藏
1. If 语句需求:根据作者名字和博客名字来查询博客!如果作者名字为空,那么只根据博客名字查询,反之,则根据作者名字来查询<!--需求1:根据作者名字和博客名字来查询博客!如果作者名...【详细内容】
2022-06-30  Tags: mybatis  点击:(25)  评论:(0)  加入收藏
在进行持久层数据维护(新增或修改)的时候,我们通常需要记录一些非业务字段,比如:create_time、update_time、update_by、create_by等用来维护数据记录的创建时间、修改时间、修改...【详细内容】
2022-06-20  Tags: mybatis  点击:(23)  评论:(0)  加入收藏
Mybatis 是 Java 中一个非常好用的数据库框架,这儿记录一下在使用过程中遇到的坑。官方中文文档地址:http://www.mybatis.org/mybatis-3/zh/getting-started.html1、在Mybatis...【详细内容】
2022-06-20  Tags: mybatis  点击:(34)  评论:(0)  加入收藏
今天介绍一个 MyBatis - Plus 官方发布的神器:mybatis-mate 为 mp 企业级模块,支持分库分表,数据审计、数据敏感词过滤(AC算法),字段加密,字典回写(数据绑定),数据权限,表结构自动生成...【详细内容】
2022-06-17  Tags: mybatis  点击:(43)  评论:(0)  加入收藏
1. Mybatis 存在的痛点我们知道 MyBatis 是一个基于 java 的持久层框架,它内部封装了 jdbc,极大提高了我们的开发效率。但是使用 Mybatis 开发也有很多痛点: 每个 Dao 接口都需...【详细内容】
2022-06-14  Tags: mybatis  点击:(37)  评论:(0)  加入收藏
MybatisPlus是国产的第三方插件, 它封装了许多常用的CURDapi,免去了我们写mapper.xml的重复劳动,这里介绍了基本的整合SpringBoot和基础用法。2|0引入依赖在项目中pom文件引入m...【详细内容】
2022-05-05  Tags: mybatis  点击:(52)  评论:(0)  加入收藏
一、前言我们在日常开发中经常使用ORM框架,比如Mybatis、tk.Mybatis、Mybatis-Plus。不过最广泛的还是Mybatis-Plus,我们的一些表,都会有创建时间、更新时间、创建人、更新人。...【详细内容】
2022-04-24  Tags: mybatis  点击:(172)  评论:(0)  加入收藏
▌简易百科推荐
本篇文章主要介绍了使用MyBatis框架完成数据库的增、删、改、查操作。准备工作运行schema.sql和data.sql脚本文件中的 SQL 语句创建t_user表并添加部分测试数据。schema.sql...【详细内容】
2022-07-15  嗨皮汪小成    Tags:MyBatis   点击:(0)  评论:(0)  加入收藏
1 Hive基本概念Hive是一个构建在Hadoop上的数据仓库框架。最初,Hive是由Facebook开发,后来移交由Apache软件基金会开发,并作为一个Apache开源项目。Hive是基于Hadoop的一个数据...【详细内容】
2022-07-15  秃头Java人    Tags:Hive   点击:(2)  评论:(0)  加入收藏
今天给大家讲讲 SpringBoot 框架 整合 Elasticsearch 实现海量级数据搜索。一、简介在上篇ElasticSearch 文章中,我们详细的介绍了 ElasticSearch 的各种 api 使用。实际的项...【详细内容】
2022-07-15  java小悠    Tags: Elasticsearch   点击:(3)  评论:(0)  加入收藏
SpringBoot开发Restful接口,有什么API规范吗?如何快速生成API文档呢?Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲,Swagger 就是将项目中所有(想要...【详细内容】
2022-07-14  Java全栈知识体系    Tags:Swagger   点击:(2)  评论:(0)  加入收藏
一、部署准备安装数据库、jdk、nginx、域名证书1、下载 nginx,官方网址如下:http://nginx.org/en/download.html2、解压安装包到任意目录 如:G:\nginx二、前端部署1、打开前端...【详细内容】
2022-07-14  智慧魔法豆浆    Tags:vue   点击:(2)  评论:(0)  加入收藏
SpringBoot 内置支持的 Web 容器有 Tomcat、Undertow、Jetty 和 Netty。默认情况下,这些 Web 服务的 AccessLog 日志是不开启的,而 AccessLog 日志对于做接口统计尤为重要。如...【详细内容】
2022-07-13  BUG弄潮儿    Tags:AccessLog 日志   点击:(10)  评论:(0)  加入收藏
什么是Starterstarter 是springboot 的核心,每个starter负责实现特定的功能,使用者只需引入starter即可自动配置,无需关心框架整合带来的问题。Starter 项目结构src |- main...【详细内容】
2022-07-12  IT食者    Tags:SpringBoot   点击:(9)  评论:(0)  加入收藏
mybaits非必填项处理数据库表字段khzjyxqx为日期型,非必填, 前台页面如下: 后台mybaits处理如下: 如果不处理,当为空时khzjyxqx=&#39;&#39;时会报错。<update id="updatesave" pa...【详细内容】
2022-07-11  在水一方357159258    Tags:mybaits   点击:(10)  评论:(0)  加入收藏
关于过气网红编程语言 Ruby,我们此前曾发过一篇文章去回顾其大受追捧的过往,并讨论了它每况愈下的生存状态。不过人气并不能直接说明语言质量差,一方面 Ruby on Rails(用 Ruby...【详细内容】
2022-07-08  InfoQ    Tags: Web 框架   点击:(9)  评论:(0)  加入收藏
1、JWT的构成- 头部(header):描述该JWT的最基本的信息,如类型以及签名所用的算法。- 负载(payload):存放有效信息的地方。- 签证(signature):base64加密后的header、base64加...【详细内容】
2022-07-08  dream19    Tags:SpringBoot   点击:(10)  评论:(0)  加入收藏
站内最新
站内热门
站内头条