TLV格式数据JAVA编解码

       电信系统中不少通信数据都采用TLV格式进行二进制编解码，而具体的TLV格式并无统一的规范，只能算是一种统称，其规定了数据中的相应字段都由Tag-Length-Value三要素组成，有些协议对于固定长度的字段也会使用TV格式，省略其中的Length。

       最近针对工作中遇到的一种TLV格式消息，实现了一套编解码库（详细可参照TLVCodec）。目前可能并不能适用于所有TLV格式消息，但是实现中预留了一定的扩展能力，例如消息头自定义等，相信后续完善的话能够尽可能多的支持各种TLV格式消息的编解码。

---

TLV消息格式介绍

       目前先简单看目前支持的这种默认TLV消息格式

        其中 Message Length为TLV字段内容总长度加上Message Identity字段的长度（4字节）。消息头域部分最容易出现差异，有的协议会加上很多其他字段。为此库中提供了相应扩展方法，详见后续具体使用介绍。

        而TLV字段顾名思义包含Tag、Length和Value三个部分：

        同时也为了支持较大的数据传输，也包含一种长类型TLV字段，其中Length为2字节，为此其值的最大长度为64k。   

        TLV格式也支持嵌套，Value可以是多个TLV Field。另外还有一种List类型，实际上算是一种特殊的嵌套类型，只是其嵌套的子TLV Field类型均相同。

---

使用示例

1. 消息定义

@TLVMsgBean(type = 2)
public class BaseMsg extends TLVMsg {

    @TLVField(tag = 0xD0, index = 999, require = true, fieldLenType = FieldLenType.LONG, charset = TLVCharset.ASCII)
    private String baseString;

    @TLVField(tag = 0xD1, index = -1, require = true)
    private int baseInt;

    @TLVField(tag = 0x25)
    private DemoObj obj;

    @TLVField(tag = 0x28)
    @TLVField(tag = 0x25)
    private List listObjs;
    
    // Non-Parameter Constructor is Required
    public BaseMsg() {

    }

    ...
}

  如上所示，具体说明如下：

• TLVMsgBean用于定义该类为TLV消息类，其中type值对应前述的消息类型
• TLVField用于标示对应的TLV字段，tag就不多说了，其中index用于指示编码时该字段的顺序，fieldLenType即定义字段类型是否为长类型字段
• 对于String类型的消息，还可以通过TLVField的charset来指定其编码类型
• 对于List或Array类型的字段，需要使用两个TLVField注解，第一个用于标示其包装类型，第二个值用于标示其子类型值
• 对于嵌套格式的TLVField，可以定义TLVObject来描述其子TLVField，具体DemoObj如下所示

@TLVObject
public class DemoObj {

    @TLVField(tag = 0x01)
    private byte rawByte;

    public DemoObj() {

    }
 
    ...
}

2. 编解码

// 初始化上下文环境，定义其扫描的包
TLVContext context = new TLVContext().init("com.dream.codec.tlv.bean");
TLVCodec codec = new TLVCodec(context);

DemoMsg msg = new DemoMsg("hello", 1, 123456);
// TLV消息编码
byte[] encodeResult = codec.encode(msg);

// TLV消息解码
DemoMsg decodedMsg = codec.convertTo(codec.decode(encodeResult), DemoMsg.class);
assertEquals(decodedMsg, msg);

---

想要进一步了解可以去我的Github项目（TLVCodec），支持的话就点个星吧。