Xmappr源码解析

扩展使用说明参见:https://www.jianshu.com/p/772e9b823aab

1.简介

Xmappr是一个使用纯Java编写的处理XML的类库,提供一种非常简单的方式来处理XML,可以将任意XML与Java类相映射,具体可以参考https://code.google.com/archive/p/xmappr/

主要特性:

  • 映射通过注释或外部配置实现
  • 可以缓存未映射元素
  • 保持XML元素顺序
  • 可以自定义类型转换器
  • 完全支持XML命名空间
  • 线程安全(设计用于多线程使用)
  • 不包含任何依赖关系
  • 整个类库大小只有80kb
  • 采用BSD许可

2.整体类图

xmapper-类图.jpg

3.流程

3.1 整体流程

Xmappr映射整体分为3大步骤:

  • 解析ConfigRootElement上对应的注解@RootElement,@Attribute和@Element得到对应的ConfigRootElement属性attribute,element等。
  • 解析配置的模板文件,得到ClassConverter中对应的elementMappers和attributeMappers。
  • 根据得到的ClassConverter解析对应的待解析文件设置对应的对象的属性。
    整体流程序列图

3.2 注解解析流程

xmappr中的注解@RootElement,@Attribute和@Element与对应模板配置文件中节点是对应的,如下面代码:

@RootElement("root-element")
public class ConfigRootElement {
    @Attribute
    public String name;

    @Attribute(name = "class", converter = ClassNameConverter.class)
    public Class classType;

    @Attribute(converter = ClassNameConverter.class, defaultValue = "org.xmappr.converters.ElementConverter")
    public Class<? extends Converter> converter;

    @Element
    public List<ConfigNamespace> namespace;

    @Element
    public ConfigText text;

    @Element
    public List<ConfigAttribute> attribute;

    @Element
    public List<ConfigElement> element;
// 省略对应的方法定义
}
public class ConfigAttribute {
    @Attribute
    public String name;

    @Attribute
    public String field;

    @Attribute
    public String getter;

    @Attribute
    public String setter;

    @Attribute
    public String defaultvalue;

    @Attribute(converter = ClassNameConverter.class, defaultValue = "java.lang.Object")
    public Class targetType;

    @Attribute
    public String format;

    @Attribute(converter = ClassNameConverter.class, defaultValue = "org.xmappr.converters.ValueConverter")
    public Class<? extends ValueConverter> converter;
// 省去方法的定义
}

public class ConfigElement {
   @Attribute
    public String name;

    @Attribute
    public String field;

    @Attribute
    public String getter;

    @Attribute
    public String setter;

    @Attribute
    public String defaultvalue;

    @Attribute(converter = ClassNameConverter.class, defaultValue = "java.lang.Object")
    public Class targetType;

    @Attribute
    public String format;

    @Attribute(converter = ClassNameConverter.class, defaultValue = "org.xmappr.converters.ElementConverter")
    public Class<? extends Converter> converter;

    @Element
    public List<ConfigNamespace> namespace;

    @Element
    public ConfigText text;

    @Element
    public List<ConfigAttribute> attribute;

    @Element
    public List<ConfigElement> element;
// 省去方法的定义
}

对应的配置文件xml如下所示:

<root-element name="query"
    class="com.ctim.model.domain.evaluate.pengyuan.vehicle.VehicleEvaluateReportInfo">
    <attribute name="treatResult" field="treatResult"
        converter="com.ctim.xmppr.EnumConverter" targetType="com.ctim.model.enums.ThirdPartyQueryResultEnum" format="PENGYUAN" />
    <attribute name="treatErrorCode" field="treatErrorCode"
        converter="com.ctim.xmppr.EnumConverter" targetType="com.ctim.model.enums.ThirdPartyQueryErrorCodeEnum" format="PENGYUAN" />
    <attribute name="errorMessage" field="errorMessage" />
    <attribute name="receiveTime" field="receiveTime" />
    <attribute name="recordId" field="recordId" />

    <element name="queryCondition.item" field="otherInfos">
        <element name="name" field="key" />
        <element name="value" field="value" />
    </element>
    <element name="queryResult.item.newCarPrice" field="newCarPrice" />
    <element name="queryResult.item.oldCarPrice" field="oldCarPrice" />

</root-element> 

从上面两段代码可以看出xml文件的根节点“root-element”正好对应的ConfigRootElement对应的注解@RootElement("root-element")的name值,而且root-element节点对应的配置信息正好与ConfigRootElement加上对应注解的对象,如ConfigRootElement对应的属性name加上注解 @Attribute,则在xml配置文件中就有对应的name属性,而且对应的名称完全一致;在比如xml对应的root-element根节点有一个属性class,在ConfigRootElement中就有一个属性如下:

 @Attribute(name = "class", converter = ClassNameConverter.class)
 public Class classType;

虽然对应的名称为classType与root-element对应的属性不一致,但是其是通过@Attribute来实现一致,@Attribute注解对应的name值对应的就是xml配置文件中节点对应的属性值,如果@Attribute对应的name为空,则取对应的属性的名称为xml配置文件中的属性名称。

从ConfigRootElement对应类中读取注解,并将获得信息放入到ConfigRootElement对应的属性中,具体的流程如下图所示:
ConfigurationProcessor.readRootElementAnnotations对应的流程

3.3 MappingContext.addRootMapper处理流程

使用方法ConfigurationProcessor.readRootElementAnnotations从ConfigRootElement类中对应的注解读取信息,并将读取到的信息放入到对象ConfigRootElement的属性中,MappingContext.addRootMapper方法主要的作用是通过将ConfigRootElement中的属性解析放入到ClassConverter对象对应的属性中(主要是根据QName映射的map中),具体的流程如下图所示:
MappingContext.addRootMapper处理流程

3.4 RootMapper.getRootObject处理流程

方法RootMapper.getRootObject(XMLSimpleReader)从对应的xml文件中读取对应的信息,并解析对应的xml文件,对如果输入的是配置文件的话,则会从对应的模板文件中解析得到ConfigRootElement对应的ConfigElement列表,然后在通过MappingContext.addRootMapper方法将ConfigElement中信息放入到ClassConverter中供后续使用;如果处理的是待解析文件,则根据通过配置文件得到的ClassConverter中的信息对待解析文件进行解析,并将解析得到的信息放入到对应的待映射对应的字段中,对应的流程如下所示:
RootMapper.getRootObject处理流程

参考

xmappr源码地址:https://github.com/lwjaiyjk/xmappr-extend

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,657评论 18 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 22,405评论 1 92
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,144评论 25 707
  • “想来一圈吗?”乔拍拍沃森的肩膀。“去吧,你可以的。” “不不,我并不这么认为,还是让优莉娅开吧,我可不想再来一次...
    WHEREAREUUU阅读 338评论 0 1
  • 在本周四秦皇岛的海边,在被称作“最孤独的图书馆”中,魅族举办了魅族 PRO 6s 新品沟通会。相比起魅族PRO6,...
    悠叶阅读 421评论 0 1