快捷導(dǎo)航

詳解netty中常用的xml編碼解碼器

更新時間：2022年05月13日 16:22:50 作者：flydean程序那些事

這篇文章主要介紹了netty中常用的xml編碼解碼器,進行frame拆分可以使用XmlFrameDecoder,進行xml文件內(nèi)容的解析則可以使用XmlDecoder，接下來我們會詳細(xì)講解兩個decoder實現(xiàn)和使用，感興趣的朋友一起看看吧

簡介

在json之前，xml是最常用的數(shù)據(jù)傳輸格式，雖然xml的冗余數(shù)據(jù)有點多，但是xml的結(jié)構(gòu)簡單清晰，至今仍然運用在程序中的不同地方，對于netty來說自然也提供了對于xml數(shù)據(jù)的支持。

netty對xml的支持表現(xiàn)在兩個方面，第一個方面是將編碼過后的多個xml數(shù)據(jù)進行frame拆分，每個frame包含一個完整的xml。另一方面是將分割好的frame進行xml的語義解析。

進行frame拆分可以使用XmlFrameDecoder,進行xml文件內(nèi)容的解析則可以使用XmlDecoder，接下來我們會詳細(xì)講解兩個decoder實現(xiàn)和使用。

XmlFrameDecoder

因為我們收到的是數(shù)據(jù)流，所以不確定收到的數(shù)據(jù)到底是什么樣的，一個正常的xml數(shù)據(jù)可能會被拆分成多個數(shù)據(jù)frame。

如下所示:

+-------+-----+--------------+
| <this | IsA | XMLElement/> |
+-------+-----+--------------+

這是一個正常的xml數(shù)據(jù)，但是被拆分成為了三個frame，所以我們需要將其合并成為一個frame如下：

+-----------------+
| <thisIsAXMLElement/> |
+-----------------+

還有可能不同的xml數(shù)據(jù)被分拆在多個frame中的情況,如下所示：

+-----+-----+-----------+-----+----------------------------------+
| <an | Xml | Element/> | <ro | ot><child>content</child></root> |
+-----+-----+-----------+-----+----------------------------------+

上面的數(shù)據(jù)需要拆分成為兩個frame：

+-----------------+-------------------------------------+
| <anXmlElement/> | <root><child>content</child></root> |
+-----------------+-------------------------------------+

拆分的邏輯很簡單，主要是通過判斷xml的分隔符的位置來判斷xml是否開始或者結(jié)束。xml中的分隔符有三個，分別是’<', ‘>’ 和 ‘/’。

在decode方法中只需要判斷這三個分隔符即可。

另外還有一些額外的判斷邏輯，比如是否是有效的xml開始字符：

 private static boolean isValidStartCharForXmlElement(final byte b) {
        return b >= 'a' && b <= 'z' || b >= 'A' && b <= 'Z' || b == ':' || b == '_';
    }

是否是注釋:

  private static boolean isCommentBlockStart(final ByteBuf in, final int i) {
        return i < in.writerIndex() - 3
                && in.getByte(i + 2) == '-'
                && in.getByte(i + 3) == '-';
    }

是否是CDATA數(shù)據(jù)：

 private static boolean isCDATABlockStart(final ByteBuf in, final int i) {
        return i < in.writerIndex() - 8
                && in.getByte(i + 2) == '['
                && in.getByte(i + 3) == 'C'
                && in.getByte(i + 4) == 'D'
                && in.getByte(i + 5) == 'A'
                && in.getByte(i + 6) == 'T'
                && in.getByte(i + 7) == 'A'
                && in.getByte(i + 8) == '[';

通過使用這些方法判斷好xml數(shù)據(jù)的起始位置之后，就可以調(diào)用extractFrame方法將要使用的ByteBuf從原始數(shù)據(jù)中拷貝出來，最后放到out中去：

final ByteBuf frame =
                    extractFrame(in, readerIndex + leadingWhiteSpaceCount, xmlElementLength - leadingWhiteSpaceCount);
            in.skipBytes(xmlElementLength);
            out.add(frame);

XmlDecoder

將xml數(shù)據(jù)拆分成為一個個frame之后，接下來就是對xml中具體數(shù)據(jù)的解析了。

netty提供了一個xml數(shù)據(jù)解析的方法叫做XmlDecoder,主要用來對已經(jīng)是一個單獨的xml數(shù)據(jù)的frame進行實質(zhì)內(nèi)容的解析，它的定義如下：

public class XmlDecoder extends ByteToMessageDecoder

XmlDecoder根據(jù)讀取到的xml內(nèi)容，將xml的部分拆分為XmlElementStart,XmlAttribute,XmlNamespace,XmlElementEnd,XmlProcessingInstruction,XmlCharacters,XmlComment,XmlSpace,XmlDocumentStart,XmlEntityReference,XmlDTD和XmlCdata。

這些數(shù)據(jù)基本上覆蓋了xml中所有可能出現(xiàn)的元素。

所有的這些元素都是定義在io.netty.handler.codec.xml包中的。

但是XmlDecoder對xml的讀取解析則是借用了第三方xml工具包：fasterxml。

XmlDecoder使用了fasterxml中的AsyncXMLStreamReader和AsyncByteArrayFeeder用來進行xml數(shù)據(jù)的解析。

這兩個屬性的定義如下：

 private static final AsyncXMLInputFactory XML_INPUT_FACTORY = new InputFactoryImpl();
    private final AsyncXMLStreamReader<AsyncByteArrayFeeder> streamReader;
    private final AsyncByteArrayFeeder streamFeeder;
            this.streamReader = XML_INPUT_FACTORY.createAsyncForByteArray();
        this.streamFeeder = (AsyncByteArrayFeeder)this.streamReader.getInputFeeder();

decode的邏輯是通過判斷xml element的類型來分別進行不同數(shù)據(jù)的讀取,最后將讀取到的數(shù)據(jù)封裝成上面我們提到的各種xml對象，最后將xml對象添加到out list中返回。