上篇文章《深入浅出mybatis系列(三)---配置详解之properties与environments(mybatis源码篇)》 介绍了properties与environments,
本篇继续讲剩下的配置节点之一:typealiases。 typealiases节点主要用来设置别名,其实这是挺好用的一个功能, 通过配置别名,我们不用再指定完整的包名,并且还能取别名。
例如: 我们在使用 com.demo.entity. userentity 的时候,我们可以直接配置一个别名user, 这样以后在配置文件中要使用到com.demo.entity. userentity的时候,直接使用user即可。
就以上例为例,我们来实现一下,看看typealiases的配置方法:
f9d9f4a8f32d97f3ef0c10742ed31240
9542a02f6b273f92cc32f0b46d9d2305
3df7f1f46f0bd67017d6469f29c23351 -->
c92c5e08046f7d03d8ae9b718ab53ca7
c9ec9bdd3e96496d6fb40ca4d76d0dbe
......
4b1b9d85fe86862ae3eab7e2045cf8a0
再写一段测试代码,看看有没生效:(我只写一段伪代码)
configuration con = sqlsessionfactory.getconfiguration();
map4b270fece8554c56e0c546fb287379f6> typemap = con.gettypealiasregistry().gettypealiases();
for(entry4b270fece8554c56e0c546fb287379f6> entry: typemap.entryset()) {
system.out.println(entry.getkey() + ================> + entry.getvalue().getsimplename());
}
=======================================我是源码分割线==============================================
上面给大家简单介绍了typealiases的用法, 接下来就看看mybatis中的源码了:
老规矩,先从对xml的解析讲起:
1 /**
2 * 解析typealiases节点
3 */
4 private void typealiaseselement(xnode parent) {
5 if (parent != null) {
6 for (xnode child : parent.getchildren()) {
7 //如果子节点是package, 那么就获取package节点的name属性, mybatis会扫描指定的package
8 if (package.equals(child.getname())) {
9 string typealiaspackage = child.getstringattribute(name);
10 //typealiasregistry 负责管理别名, 这儿就是通过typealiasregistry 进行别名注册, 下面就会看看typealiasregistry源码
11 configuration.gettypealiasregistry().registeraliases(typealiaspackage);
12 } else {
13 //如果子节点是typealias节点,那么就获取alias属性和type的属性值
14 string alias = child.getstringattribute(alias);
15 string type = child.getstringattribute(type);
16 try {
17 class6b3d0130bba23ae47fe2b8e8cddf0195 clazz = resources.classforname(type);
18 if (alias == null) {
19 typealiasregistry.registeralias(clazz);
20 } else {
21 typealiasregistry.registeralias(alias, clazz);
22 }
23 } catch (classnotfoundexception e) {
24 throw new builderexception(error registering typealias for ' + alias + '. cause: + e, e);
25 }
26 }
27 }
28 }
29 }
重要的源码在这儿:
typealiasregistry:
public class typealiasregistry {
//这就是核心所在啊, 原来别名就仅仅通过一个hashmap来实现, key为别名, value就是别名对应的类型(class对象)
private final map<string, class<?>> type_aliases = new hashmap<string, class<?>>(); /**
* 以下就是mybatis默认为我们注册的别名 */
public typealiasregistry() {
registeralias("string", string.class);
registeralias("byte", byte.class);
registeralias("long", long.class);
registeralias("short", short.class);
registeralias("int", integer.class);
registeralias("integer", integer.class);
registeralias("double", double.class);
registeralias("float", float.class);
registeralias("boolean", boolean.class);
registeralias("byte[]", byte[].class);
registeralias("long[]", long[].class);
registeralias("short[]", short[].class);
registeralias("int[]", integer[].class);
registeralias("integer[]", integer[].class);
registeralias("double[]", double[].class);
registeralias("float[]", float[].class);
registeralias("boolean[]", boolean[].class);
registeralias("_byte", byte.class);
registeralias("_long", long.class);
registeralias("_short", short.class);
registeralias("_int", int.class);
registeralias("_integer", int.class);
registeralias("_double", double.class);
registeralias("_float", float.class);
registeralias("_boolean", boolean.class);
registeralias("_byte[]", byte[].class);
registeralias("_long[]", long[].class);
registeralias("_short[]", short[].class);
registeralias("_int[]", int[].class);
registeralias("_integer[]", int[].class);
registeralias("_double[]", double[].class);
registeralias("_float[]", float[].class);
registeralias("_boolean[]", boolean[].class);
registeralias("date", date.class);
registeralias("decimal", bigdecimal.class);
registeralias("bigdecimal", bigdecimal.class);
registeralias("biginteger", biginteger.class);
registeralias("object", object.class);
registeralias("date[]", date[].class);
registeralias("decimal[]", bigdecimal[].class);
registeralias("bigdecimal[]", bigdecimal[].class);
registeralias("biginteger[]", biginteger[].class);
registeralias("object[]", object[].class);
registeralias("map", map.class);
registeralias("hashmap", hashmap.class);
registeralias("list", list.class);
registeralias("arraylist", arraylist.class);
registeralias("collection", collection.class);
registeralias("iterator", iterator.class);
registeralias("resultset", resultset.class);
}
/**
* 处理别名, 直接从保存有别名的hashmap中取出即可 */
@suppresswarnings("unchecked") public <t> class<t> resolvealias(string string) {
try {
if (string == null) return null;
string key = string.tolowercase(locale.english); // issue #748
class<t> value; if (type_aliases.containskey(key)) {
value = (class<t>) type_aliases.get(key);
} else {
value = (class<t>) resources.classforname(string);
} return value;
} catch (classnotfoundexception e) {
throw new typeexception("could not resolve type alias '" + string + "'. cause: " + e, e);
}
}
/**
* 配置文件中配置为package的时候, 会调用此方法,根据配置的报名去扫描javabean ,然后自动注册别名
* 默认会使用 bean 的首字母小写的非限定类名来作为它的别名
* 也可在javabean 加上注解@alias 来自定义别名, 例如: @alias(user) */
public void registeraliases(string packagename){
registeraliases(packagename, object.class);
} public void registeraliases(string packagename, class<?> supertype){
resolverutil<class<?>> resolverutil = new resolverutil<class<?>>();
resolverutil.find(new resolverutil.isa(supertype), packagename);
set<class<? extends class<?>>> typeset = resolverutil.getclasses();
for(class<?> type : typeset){
// ignore inner classes and interfaces (including package-info.java)
// skip also inner classes. see issue #6
if (!type.isanonymousclass() && !type.isinterface() && !type.ismemberclass()) {
registeralias(type);
}
}
} public void registeralias(class<?> type) {
string alias = type.getsimplename();
alias aliasannotation = type.getannotation(alias.class);
if (aliasannotation != null) {
alias = aliasannotation.value();
}
registeralias(alias, type);
} //这就是注册别名的本质方法, 其实就是向保存别名的hashmap新增值而已, 呵呵, 别名的实现太简单了,对吧
public void registeralias(string alias, class<?> value) {
if (alias == null) throw new typeexception("the parameter alias cannot be null");
string key = alias.tolowercase(locale.english); // issue #748
if (type_aliases.containskey(key) && type_aliases.get(key) != null && !type_aliases.get(key).equals(value)) {
throw new typeexception("the alias '" + alias + "' is already mapped to the value '" + type_aliases.get(key).getname() + "'.");
}
type_aliases.put(key, value);
} public void registeralias(string alias, string value) { try {
registeralias(alias, resources.classforname(value));
} catch (classnotfoundexception e) {
throw new typeexception("error registering type alias "+alias+" for "+value+". cause: " + e, e);
}
}
/**
* 获取保存别名的hashmap, configuration对象持有对typealiasregistry的引用,因此,如果需要,我们可以通过configuration对象获取 */
public map<string, class<?>> gettypealiases() {
return collections.unmodifiablemap(type_aliases);
}
}
由源码可见,设置别名的原理就这么简单,mybatis默认给我们设置了不少别名,在上面代码中都可以见到。
好啦,本篇内容就是这么简单,到此为止。 下篇将继续讲解还没讲完的配置节点。
以上就是深入浅出mybatis系列(四)---配置详解之typealiases别名(mybatis源码篇)的内容。