解析XML和JSON內容的一點技巧

Honwhy發表於2016-11-26
XMLJSON

解析XML和JSON內容的一點技巧

概述

在沒有統一標準的情況下，一個系統對接多個外部系統往往會遇到請求介面響應資料異構的情況，有可能返回的是XML，也有可能返回
JSON。除了返回型別不同，內容結構也不盡相同。以XML型別為例，
介面1返回內容

<root>
    <bizKey>16112638767472747178067</bizKey>
    <returnMsg>OK</returnMsg>
    <returnCode>200</returnCode>
    ...
</root>

介面2返回內容

<root>
    <bid>16112638767472747178068</bid>
    <note>成功</note>
    <returnStatus>1</returnStatus>
    ...
</root>

如果在我們系統中為每種格式的內容針對處理顯然是不合理的，上面的內容中我們只是關心三種資訊，分別是業務ID、狀態值和描述資訊，那麼可不可以抽象這三種資訊，
獲得這些資訊後再進行業務邏輯處理。

解析XML和JSON

根據業務抽象我們需要從XML或者JSON內容中獲得三種資訊，我們這裡將會使用XPath和JSONPath的方式來解析。比如獲得介面1的重要資訊，
我們可以設定三個XPath表示式，

{
    bid: "/root/bizKey",
    code: "/root/returnCode",
    description: "/root/returnMsg"
}

bid,code和description對應我們系統自己定義的欄位名。
解析JSON內容也是同理的，只不過定義的是JSONPath表示式。

分兩步走處理資料內容

假設我們從原始的XML和JSON資料中獲得了bid,code和description資訊，
從介面1獲得

{
    bid: `16112638767472747178067`,
    code: `200`,
    description: `OK`
}

從介面2獲得

{
    bid: `16112638767472747178068`,
    code: `1`,
    description: `成功`
}

假設我們從介面1文件獲知狀態值200表示請求成功，從介面2文件獲知狀態值1表示請求成功，雖然他們都表示請求成功，但是我們還是不能
把他們原原本本地儲存到我們的業務相關表中（當然這些響應資料還是需要儲存到另外的記錄表中的，至少方便排查問題）。
假設我們的業務相關表是這樣設計的

欄位名 型別 描述
bid string 業務ID
code int 狀態值，0=初始，1=請求中，2=成功，3=失敗
description string 描述

因此，我們還必須定義規則把介面1返回的狀態值200轉換為我們系統的2，把介面2返回的狀態值1轉換為我們系統的2。
總結一下，兩步走解析XML和JSON資料內容

  1. 根據XPath或者JSONPath表示式解析獲得重要資訊
  2. 根據規則轉換狀態值

第一步解析資料獲得重要資訊

以XML為例，

public class XmlParseUtils {
    private DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
    private XPathFactory xpathFactory = XPathFactory.newInstance();
    
    /**
     * 
     * @param param    資料內容
     * @param paths 表示式
     * @return
     * @throws Exception
     */
    public Map<String,Object> parse(String param, Map<String,String> paths) throws Exception{
        InputSource inputSource = new InputSource(new StringReader(param));
        Document document = dbFactory.newDocumentBuilder().parse(inputSource);
        Map<String,Object> map = Maps.newHashMap();
        for(String key : paths.keySet()) {
            XPath xpath = xpathFactory.newXPath();
            Node node = (Node) xpath.evaluate(paths.get(key), document, XPathConstants.NODE);
            if(node == null) {
                throw new Exception("node not found, xpath is " + paths.get(key));
            }
            map.put(key, node.getTextContent());
        }
        return map;
    }

}

parse函式的返回型別也可以是Map<String,String>，暫且用Map<String,Object>。

第二步根據規則轉換狀態值

這一步稍稍有點麻煩，不過我們先不考慮程式碼實現，反正你能想到的可能別人已經幫你實現了。首先我們根據介面文件定義規則，寫出規則表示式（或者其他的什麼），
又是表示式。假設介面1的返回的狀態值比較簡單，只有200表示成功，其他情況都是失敗，那麼我們可以這樣定義規則，

code.equals("200") ? 2: 3

或者

<#if code == "200">
2
<#else>
3
<#/if>

亦或者

function handle(arg) {
    if(arg == 200) {
        return 2;
    }
    return 3;
}
handle(${code})

以上根據同一份文件定義了三種不同型別的狀態值轉換規則，肯定需要三種不同的實現。下面一一說明，

三目表示式

code.equals("200") ? 2: 3是一個三目表示式，我們將使用jexl引擎來解析，利用第一步解析資料獲得重要資訊的結果，我們可以這樣做

    public Object evaluateByJexl(String expression, Map<String,Object> context) {
        JexlEngine jexl = new JexlBuilder().create();
        JexlExpression e = jexl.createExpression(expression);
        JexlContext jc = new MapContext(context);
        return e.evaluate(jc);
    }

FreeMarker模板

<#if code == "200">
2
<#else>
3
<#/if>

處理這段模板我們可以這麼做

    /**
     * 
     * @param param FreeMarker模板
     * @param context
     * @return
     * @throws Exception
     */
    public String render(String param, Map<String,Object> context) throws Exception {
        Configuration cfg = new Configuration();
        StringTemplateLoader stringLoader = new StringTemplateLoader();
        stringLoader.putTemplate("myTemplate",param);
        cfg.setTemplateLoader(stringLoader);
        Template template = cfg.getTemplate("myTemplate","utf-8");
        StringWriter writer = new StringWriter();
        template.process(context, writer);
        return writer.toString();
    }

如果FreeMarker模板比較複雜，從模板預編譯成Template可能會消耗更多的效能，就要考慮把Template快取起來。

JavaScript程式碼段

function handle(arg) {
    if(arg == 200) {
        return 2;
    }
    return 3;
}
handle(${code})

這段js程式碼中存在${code}，首先它需要使用FreeMarker渲染得到真正的handle方法的呼叫引數，然後

    public Object evaluate(String expression) throws Exception {
        ScriptEngineManager manager = new ScriptEngineManager();
        ScriptEngine engine = manager.getEngineByName("javascript");
        return engine.eval(expression);
    }

ScriptEngineManager的效能估計不太樂觀，畢竟是一個語言的引擎。

不同轉換規則實現的比較

型別 實現 優點 缺點
三目表示式 Jexl 簡單（easy） 簡單（simple）
FreeMarker模板 FreeMarker — —
JavaScript程式碼段 FreeMarker + ScriptEngine 直觀 過程複雜，效能問題

看起來Freemarker是一個不錯的選擇。
至此兩步走小技巧已經實現了，都是利用了現成的程式碼實現。

或許我們會這樣的挑戰，在做狀態值轉換時需要知道當前系統某個業務狀態值的情況，
此時Freemarker表示式可能是這樣的，

<# assign lastCode = GetLastCode(code)>
<#if lastCode == "2">
2
<#elseif code == "200">
2
<#else>
3
<#/if>

這裡我們可以使用Freemarker的特性，自定義Java函式或工具類，在模板中呼叫。

程式碼地址

https://github.com/Honwhy/xml…

相關文章