基于MyBatis XML配置方法(全面了解)
MyBatis的配置文件包含了影响MyBatis行为甚深的设置(settings)和属性(properties)信息。
文档的顶层结构如下:
configuration配置
properties属性
settings设置
typeAliases类型命名
typeHandlers类型处理器
objectFactory对象工厂
plugins插件
environments环境
environment环境变量
transactionManager事务管理器
dataSource数据源
databaseIdProvider数据库厂商标识
mappers映射器
properties属性
这些属性都是可外部配置且可动态替换的,既可以在典型的Java属性文件中配置,亦可通过properties元素的子元素来传递,配置示例:
配置properties后,可以在其他配置中使用property,示例如下:
这个例子中的username和password将会由properties元素中设置的相应值来替换。
如果属性在不只一个地方进行了配置,那么MyBatis将按照下面的顺序来加载:
在properties元素体内指定的属性首先被读取。
然后根据properties元素中的resource属性读取类路径下属性文件或根据url属性指定的路径读取属性文件,并覆盖已读取的同名属性。
最后读取作为方法参数传递的属性,并覆盖已读取的同名属性。
因此,通过方法参数传递的属性具有最高优先级,resource/url属性中指定的配置文件次之,最低优先级的是properties属性中指定的属性
MyBatis3.4.2增加了默认值,可以通过${username:ut_user}来设置默认值,可以通过配置property来启用默认值,或者设置默认值的分隔符,如下配置:
settings属性
这是MyBatis中极为重要的调整设置,它们会改变MyBatis的运行时行为,完整属性及说明表可以参考链接。一个配置完整的示例如下:
typeAliases属性
类型别名是为Java类型设置一个短的名字。它只和XML配置有关,存在的意义仅在于用来减少类完全限定名的冗余。指定别名配置如下:
也可以指定一个包名,MyBatis会搜索包名下面的需要的JavaBean,比如:
每一个在包domain.blog中的JavaBean,在没有注解的情况下,会使用Bean的首字母小写的非限定类名来作为它的别名。比如domain.blog.Author的别名为author;若有注解,则别名为其注解值。看下面的例子:
@Alias("author") publicclassAuthor{ ... }
已经为许多常见的Java类型内建了相应的类型别名。它们都是大小写不敏感的,需要注意的是由基本类型名称重复导致的特殊处理,内建相应的类型表参见链接。
typeHandlers属性
无论是MyBatis在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时,都会用类型处理器将获取的值以合适的方式转换成Java类型,默认的类型处理器参考链接。可以重写类型处理器或创建自己的类型处理器来处理不支持的或非标准的类型。具体做法为:实现org.apache.ibatis.type.TypeHandler接口,或继承一个很便利的类org.apache.ibatis.type.BaseTypeHandler,然后可以选择性地将它映射到一个JDBC类型,示例代码:
自定义TypeHandler代码
packageorg.mybatisExamples.simple; importjava.sql.*; importorg.apache.ibatis.type.BaseTypeHandler; importorg.apache.ibatis.type.JdbcType; //继承基类重写方法,通过类型处理器的泛型,MyBatis可以得知该类型处理器处理的Java类型 publicclassStringTypeHandlerextendsBaseTypeHandler{ @Override publicStringgetNullableResult(ResultSetarg0,Stringarg1)throwsSQLException{ System.out.printf("getNullableResultarg1=%s%n",arg1); returnarg0.getString(arg1); } @Override publicStringgetNullableResult(ResultSetarg0,intarg1)throwsSQLException{ System.out.printf("getNullableResultarg1=%d%n",arg1); returnarg0.getString(arg1); } @Override publicStringgetNullableResult(CallableStatementarg0,intarg1)throwsSQLException{ System.out.printf("getNullableResultarg1=%d%n",arg1); returnarg0.getString(arg1); } @Override publicvoidsetNonNullParameter(PreparedStatementarg0,intarg1,Stringarg2,JdbcTypearg3)throwsSQLException{ System.out.printf("Index=%dValue=%sJdbcType=%s%n",arg1,arg2,arg3); arg0.setString(arg1,arg2); } }
配置文件代码:
通过类型处理器的泛型,MyBatis可以得知该类型处理器处理的Java类型,不过这种行为可以通过两种方法改变:
在类型处理器的配置元素(typeHandlerelement)上增加一个javaType属性(比如:javaType="String");
在类型处理器的类上(TypeHandlerclass)增加一个@MappedTypes注解来指定与其关联的Java类型列表。如果在javaType属性中也同时指定,则注解方式将被忽略。
可以通过两种方式来指定被关联的JDBC类型:
在类型处理器的配置元素上增加一个jdbcType属性(比如:jdbcType="VARCHAR");
在类型处理器的类上(TypeHandlerclass)增加一个@MappedJdbcTypes注解来指定与其关联的JDBC类型列表。如果在jdbcType属性中也同时指定,则注解方式将被忽略。
当决定在
typeHandlers属性处理枚举类型
若想映射枚举类型Enum,则需要从org.apache.ibatis.type.EnumTypeHandler或者org.apache.ibatis.type.EnumOrdinalTypeHandler中选一个来使用。比如说我们想存储取近似值时用到的舍入模式。默认情况下,MyBatis会利用EnumTypeHandler来把Enum值转换成对应的名字。
注意EnumTypeHandler在某种意义上来说是比较特别的,其他的处理器只针对某个特定的类,而它不同,它会处理任意继承了Enum的类。
不过,我们可能不想存储名字,相反我们的DBA会坚持使用整形值代码。那也一样轻而易举:在配置文件中把EnumOrdinalTypeHandler加到typeHandlers中即可,这样每个RoundingMode将通过他们的序数值来映射成对应的整形,配置示例:
自动映射器(auto-mapper)会自动地选用EnumOrdinalTypeHandler来处理,所以如果我们想用普通的EnumTypeHandler,就非要为那些SQL语句显式地设置要用到的类型处理器不可。
objectFactory(对象工厂)
MyBatis每次创建结果对象的新实例时,它都会使用一个对象工厂(ObjectFactory)实例来完成。默认的对象工厂需要做的仅仅是实例化目标类,要么通过默认构造方法,要么在参数映射存在的时候通过参数构造方法来实例化。如果想覆盖对象工厂的默认行为,则可以通过创建自己的对象工厂来实现,示例代码:
packageorg.mybatisExamples.simple; importjava.util.List; importjava.util.Properties; importorg.apache.ibatis.reflection.factory.DefaultObjectFactory; @SuppressWarnings("serial") publicclassExampleObjectFactoryextendsDefaultObjectFactory{ @Override publicTcreate(Class type){ System.out.println("createistype="+type.getName()); returnsuper.create(type); } @Override public Tcreate(Class type,List >constructorArgTypes,List
配置文件:
插件(plugins)
MyBatis允许你在已映射语句执行过程中的某一点进行拦截调用。默认情况下,MyBatis允许使用插件来拦截的方法调用包括:
Executor接口的方法update,query,flushStatements,commit,rollback,getTransaction,close,isClosed
ParameterHandler接口的方法getParameterObject,setParameters
ResultSetHandler接口的方法handleResultSets,handleOutputParameters
StatementHandler接口的方法prepare,parameterize,batch,update,query
这些类中方法的细节可以通过查看每个方法的签名来发现,或者直接查看MyBatis的发行包中的源代码。假设你想做的不仅仅是监控方法的调用,那么你应该很好的了解正在重写的方法的行为。因为如果在试图修改或重写已有方法的行为的时候,你很可能在破坏MyBatis的核心模块。这些都是更低层的类和方法,所以使用插件的时候要特别当心。通过MyBatis提供的强大机制,使用插件是非常简单的,只需实现Interceptor接口,并指定了想要拦截的方法签名即可,示例代码:
@Intercepts({@Signature( //type:表示需要拦截的上面列出的接口 type=Executor.class, //method:表示拦截接口的方法 method="update", //args:表示拦截方法的参数 args={MappedStatement.class,Object.class})}) publicclassExamplePluginimplementsInterceptor{ //执行拦截对象的方法invocation.proceed表示执行原始方法 publicObjectintercept(Invocationinvocation)throwsThrowable{ returninvocation.proceed(); } //将目标对象增加拦截器 publicObjectplugin(Objecttarget){ returnPlugin.wrap(target,this); } //设置拦截器的属性 publicvoidsetProperties(Propertiesproperties){ } }
配置文件:
配置环境(environments)
MyBatis可以配置成适应多种环境,这种机制有助于将SQL映射应用于多种数据库之中,现实情况下有多种理由需要这么做。例如,开发、测试和生产环境需要有不同的配置;或者共享相同Schema的多个生产数据库,想使用相同的SQL映射。许多类似的用例。
不过要记住:尽管可以配置多个环境,每个SqlSessionFactory实例只能选择其一。
所以,如果你想连接两个数据库,就需要创建两个SqlSessionFactory实例,每个数据库对应一个。而如果是三个数据库,就需要三个实例,依此类推,记起来很简单:
每个数据库对应一个SqlSessionFactory实例
为了指定创建哪种环境,只要将它作为可选的参数传递给SqlSessionFactoryBuilder即可。可以接受环境配置的两个方法签名是:
SqlSessionFactoryfactory=newSqlSessionFactoryBuilder().build(reader,environment); SqlSessionFactoryfactory=newSqlSessionFactoryBuilder().build(reader,environment,properties);
如果忽略了环境参数,那么默认环境将会被加载,如下所示:
SqlSessionFactoryfactory=newSqlSessionFactoryBuilder().build(reader); SqlSessionFactoryfactory=newSqlSessionFactoryBuilder().build(reader,properties);
环境元素定义了如何配置环境,配置示例如下:
注意这里的关键点:
默认的环境ID(比如:default="development")。
每个environment元素定义的环境ID(比如:id="development")。
事务管理器的配置(比如:type="JDBC")。
数据源的配置(比如:type="POOLED")。
默认的环境和环境ID是一目了然的。随你怎么命名,只要保证默认环境要匹配其中一个环境ID
事务管理器(transactionManager)
在MyBatis中有两种类型的事务管理器(也就是type="[JDBC|MANAGED]"):
JDBC–这个配置就是直接使用了JDBC的提交和回滚设置,它依赖于从数据源得到的连接来管理事务作用域。
MANAGED–这个配置几乎没做什么。它从来不提交或回滚一个连接,而是让容器来管理事务的整个生命周期(比如JEE应用服务器的上下文)。默认情况下它会关闭连接,然而一些容器并不希望这样,因此需要将closeConnection属性设置为false来阻止它默认的关闭行为。例如:
这两种事务管理器类型都不需要任何属性。它们不过是类型别名,换句话说,你可以使用TransactionFactory接口的实现类的完全限定名或类型别名代替它们。
publicinterfaceTransactionFactory{ voidsetProperties(Propertiesprops); TransactionnewTransaction(Connectionconn); TransactionnewTransaction(DataSourcedataSource,TransactionIsolationLevellevel,booleanautoCommit); }
任何在XML中配置的属性在实例化之后将会被传递给setProperties()方法。你也需要创建一个Transaction接口的实现类,这个接口也很简单:
publicinterfaceTransaction{ ConnectiongetConnection()throwsSQLException; voidcommit()throwsSQLException; voidrollback()throwsSQLException; voidclose()throwsSQLException; IntegergetTimeout()throwsSQLException; }
使用这两个接口,你可以完全自定义MyBatis对事务的处理。
数据源(dataSource)
dataSource元素使用标准的JDBC数据源接口来配置JDBC连接对象的资源。
许多MyBatis的应用程序将会按示例中的例子来配置数据源。然而它并不是必须的。要知道为了方便使用延迟加载,数据源才是必须的。
有三种内建的数据源类型(也就是type="[UNPOOLED|POOLED|JNDI]"):
UNPOOLED–这个数据源的实现只是每次被请求时打开和关闭连接。虽然一点慢,它对在及时可用连接方面没有性能要求的简单应用程序是一个很好的选择。不同的数据库在这方面表现也是不一样的,所以对某些数据库来说使用连接池并不重要,这个配置也是理想的。UNPOOLED类型的数据源仅仅需要配置以下5种属性:
driver–这是JDBC驱动的Java类的完全限定名(并不是JDBC驱动中可能包含的数据源类)。
url–这是数据库的JDBCURL地址。
username–登录数据库的用户名。
password–登录数据库的密码。
defaultTransactionIsolationLevel–默认的连接事务隔离级别。
作为可选项,你也可以传递属性给数据库驱动。要这样做,属性的前缀为"driver.",例如:
driver.encoding=UTF8
这将通过DriverManager.getConnection(url,driverProperties)方法传递值为UTF8的encoding属性给数据库驱动。
POOLED–这种数据源的实现利用"池"的概念将JDBC连接对象组织起来,避免了创建新的连接实例时所必需的初始化和认证时间。这是一种使得并发Web应用快速响应请求的流行处理方式。除了上述提到UNPOOLED下的属性外,会有更多属性用来配置POOLED的数据源:
poolMaximumActiveConnections–在任意时间可以存在的活动(也就是正在使用)连接数量,默认值:10
poolMaximumIdleConnections–任意时间可能存在的空闲连接数。
poolMaximumCheckoutTime–在被强制返回之前,池中连接被检出(checkedout)时间,默认值:20000毫秒(即20秒)
poolTimeToWait–这是一个底层设置,如果获取连接花费的相当长的时间,它会给连接池打印状态日志并重新尝试获取一个连接(避免在误配置的情况下一直安静的失败),默认值:20000毫秒(即20秒)。
poolPingQuery–发送到数据库的侦测查询,用来检验连接是否处在正常工作秩序中并准备接受请求。默认是"NOPINGQUERYSET",这会导致多数数据库驱动失败时带有一个恰当的错误消息。
poolPingEnabled–是否启用侦测查询。若开启,也必须使用一个可执行的SQL语句设置poolPingQuery属性(最好是一个非常快的SQL),默认值:false。
poolPingConnectionsNotUsedFor–配置poolPingQuery的使用频度。这可以被设置成匹配具体的数据库连接超时时间,来避免不必要的侦测,默认值:0(即所有连接每一时刻都被侦测—当然仅当poolPingEnabled为true时适用)。
通过需要实现接口org.apache.ibatis.datasource.DataSourceFactory,也可使用任何第三方数据源:
publicinterfaceDataSourceFactory{ voidsetProperties(Propertiesprops); DataSourcegetDataSource(); }
org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory可被用作父类来构建新的数据源适配器,比如下面这段插入C3P0数据源所必需的代码:
importorg.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory; importcom.mchange.v2.c3p0.ComboPooledDataSource; publicclassC3P0DataSourceFactoryextendsUnpooledDataSourceFactory{ publicC3P0DataSourceFactory(){ this.dataSource=newComboPooledDataSource(); } }
为了令其工作,为每个需要MyBatis调用的setter方法中增加一个属性。下面是一个可以连接至MySQL数据库的例子:
映射器(mappers)
既然MyBatis的行为已经由上述元素配置完了,我们现在就要定义SQL映射语句了。但是首先我们需要告诉MyBatis到哪里去找到这些语句。Java在自动查找这方面没有提供一个很好的方法,所以最佳的方式是告诉MyBatis到哪里去找映射文件。你可以使用相对于类路径的资源引用,或完全限定资源定位符(包括file:///的URL),或类名和包名等。例如:
以上这篇基于MyBatisXML配置方法(全面了解)就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持毛票票。