基于MyBatis XML配置方法(全面了解)

2024-02-18 11:52:03 60

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属性中也同时指定，则注解方式将被忽略。

当决定在中使用某一TypeHandler时，此时java类型是已知的（从结果类型中获得），但是JDBC类型是未知的。因此Mybatis使用javaType=[TheJavaType],jdbcType=null的组合来选择一个TypeHandler。这意味着使用@MappedJdbcTypes注解可以限制TypeHandler的范围，同时除非显示的设置，否则TypeHandler在ResultMap中将是无效的。如果希望在ResultMap中使用TypeHandler，那么设置@MappedJdbcTypes注解的includeNullJdbcType=true即可。然而从Mybatis3.4.0开始，如果只有一个注册的TypeHandler来处理Java类型，那么它将是ResultMap使用Java类型时的默认值（即使没有includeNullJdbcType=true）。

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(Classtype){

System.out.println("createistype="+type.getName());

returnsuper.create(type);

}



@Override

publicTcreate(Classtype,List>constructorArgTypes,List

基于MyBatis XML配置方法(全面了解)

热门推荐

随机推荐