报文构建器

内置了两种 Jt808MsgBuilder 实现类用来构建报文：

• 用来构建调试报文
• 回复客户端的消息也可以使用 Jt808MsgBuilder 来构建

EntityJt808MsgBuilder

该实现类通过被 @Jt808ResponseBody 标记的实体类来构建报文。

注意

• 该实现 支持 多次调用 builder.build() 方法
• 该实现不需要显式调用 builder.release()；当然即便是显式调用 builder.release()，也不会有任何影响
• 方法返回的构建结果需要调用方自己在恰当的时机释放

public class Jt808MsgBuilderTest {

    // 这里使用-1，通过 Jt808MsgBuilder.msgId(int msgId) 来指定了消息ID
    // 也可以直接在这里指定具体的消息ID
    @Jt808ResponseBody(msgId = -1)
    @Data
    @Accessors(chain = true)
    static class TestEntity {
        // 1. 应答流水号 WORD    对应的平台消息的流水号
        @ResponseField(order = 0, dataType = WORD)
        int serverFlowId;

        // 2. 应答id WORD     对应的平台消息的 ID
        @ResponseField(order = 1, dataType = WORD)
        int serverMsgId;

        // 3. 结果  byte 0:成功/确认;1:失败;2:消息有误;3:不支持
        @ResponseField(order = 2, dataType = BYTE)
        int result;

    }

    // 流水号生成器(这里使用一个永远返回0的生成器用来调试)
    // 可以使用 Jt808Session(已经实现了Jt808FlowIdGenerator) 或者 Jt808FlowIdGenerator.DEFAULT(默认实现类) 来生成自增的流水号
    private static final Jt808FlowIdGenerator ALWAYS_RETURN_0 = step -> 0;

    @Test
    void testEntityMsgBuilder() {
        // 通过实体类来转换消息体内容
        final TestEntity entity = new TestEntity()
                .setServerFlowId(0)
                .setServerMsgId(0x8103)
                .setResult(0);

        final EntityJt808MsgBuilder builder = Jt808MsgBuilder.newEntityBuilder(ALWAYS_RETURN_0)
                .version(Jt808ProtocolVersion.VERSION_2013)
                .terminalId("013912344323")
                .body(entity)
                .msgId(BuiltinJt808MsgType.CLIENT_COMMON_REPLY);

        final ByteBuf result = builder.build();

        assertEquals("7E0001000501391234432300000000810300F87E", HexStringUtils.byteBufToString(result));
        assertEquals("7E0001000501391234432300000000810300F87E", builder.toHexString());

        assertEquals(1, result.refCnt());
        result.release();
        assertEquals(0, result.refCnt());
    }
}

ByteBufJt808MsgBuilder

该实现类通过 Jt808ByteWriter (ByteBuf) 来构建报文。

注意

• 该实现 不支持 多次调用 builder.build() 方法
• 该实现需要调用 builder.release() 方法来释放 builder 内部用到的临时 ByteBuf
• 推荐在 try-with-resources 块中使用
• 方法返回的构建结果需要调用方自己在恰当的时机释放

public class Jt808MsgBuilderTest {

    // 流水号生成器(这里使用一个永远返回0的生成器用来调试)
    // 可以使用 Jt808Session(已经实现了Jt808FlowIdGenerator) 或者 Jt808FlowIdGenerator.DEFAULT(默认实现类) 来生成自增的流水号
    private static final Jt808FlowIdGenerator ALWAYS_RETURN_0 = step -> 0;

    @Test
    public void testByteBufMsgBuilder() {
        // final ByteBuf originalBuf = ByteBufAllocator.DEFAULT.buffer(128);
        final ByteBuf originalBuf = Unpooled.buffer(128);
        try (ByteBufJt808MsgBuilder builder = Jt808MsgBuilder.newByteBufBuilder(ALWAYS_RETURN_0, originalBuf)) {
            builder.version(Jt808ProtocolVersion.VERSION_2013)
                    .msgId(BuiltinJt808MsgType.CLIENT_COMMON_REPLY)
                    .terminalId("013912344323")
                    // 消息体借助 Jt808ByteWriter 来写入内容
                    // 也可以直接提供一个已经写好内容的 ByteBuf 用来充当消息体
                    .body(writer -> writer
                            // 1. 应答流水号 WORD    对应的平台消息的流水号
                            .writeWord(0)
                            // 2. 应答id WORD     对应的平台消息的 ID
                            .writeWord(0x8103)
                            // 3. 结果  byte 0:成功/确认;1:失败;2:消息有误;3:不支持
                            .writeByte(0)
                    );

            final ByteBuf result = builder.build();
            assertEquals("7E0001000501391234432300000000810300F87E", HexStringUtils.byteBufToString(result));

            assertEquals(1, result.refCnt());
            assertEquals(1, originalBuf.refCnt());

            // 在恰当的时机释放构建结果
            result.release();
            assertEquals(0, result.refCnt());
        }

        // try-with-resource 释放了 originalBuf
        assertEquals(0, originalBuf.refCnt());
    }
}

RebuildableByteBufJt808MsgBuilder v2.1.4

该实现类通过 Jt808ByteWriter (ByteBuf) 来构建报文。

注意

• 该实现 支持 多次调用 builder.build() 方法
• 该实现需要调用 builder.release() 方法来释放 builder 内部用到的临时 ByteBuf
• 推荐在 try-with-resources 块中使用
• 方法返回的构建结果需要调用方自己在恰当的时机释放

class RebuildableByteBufJt808MsgBuilderTest {
    
    Jt808FlowIdGenerator flowIdGenerator = step -> 0;

    @Test
    void test2() {
        final ByteBuf originalBuf = ByteBufAllocator.DEFAULT.buffer();
        try (var builder = Jt808MsgBuilder.newRebuildableByteBufBuilder(flowIdGenerator, originalBuf)) {
            builder.version(Jt808ProtocolVersion.VERSION_2013)
                    .msgId(BuiltinJt808MsgType.CLIENT_COMMON_REPLY)
                    .terminalId("013912344323")
                    // 消息体借助 Jt808ByteWriter 来写入内容
                    // 也可以直接提供一个已经写好内容的 ByteBuf 用来充当消息体
                    .body(writer -> writer
                            // 1. 应答流水号 WORD    对应的平台消息的流水号
                            .writeWord(0)
                            // 2. 应答id WORD     对应的平台消息的 ID
                            .writeWord(0x8103)
                            // 3. 结果  byte 0:成功/确认;1:失败;2:消息有误;3:不支持
                            .writeByte(0)
                    );
            final ByteBuf result = builder.build();
            Assertions.assertEquals(1, result.refCnt());
            Assertions.assertEquals("7E0001000501391234432300000000810300F87E", FormatUtils.toHexString(result));

            doSomeProcess(result);

            result.release();
            Assertions.assertEquals(0, result.refCnt());

            final ByteBuf result2 = builder.build();
            Assertions.assertEquals(1, result2.refCnt());

            doSomeProcess(result2);

            result2.release();
            Assertions.assertEquals(0, result2.refCnt());
        }
        // try-with-resources 会自动释放 originalBuf
        Assertions.assertEquals(0, originalBuf.refCnt());
    }

}