实体编解码器

介绍

提示

这里介绍的是 io.github.hylexus.xtream.codec.core.EntityCodec

EntityCodec 用来支持基于注解的编解码。这里的注解指的是前面提到的：

• @XtreamField()
• @Preset.RustStyle.xxx()
• @Preset.JtStyle.xxx()
• 自定义注解 ...

本质上 EntityCodec 是 EntityEncoder 和 EntityDecoder 的组合。

示例

下面以 @Preset.RustStyle.xxx() 风格的注解为例，介绍如何使用 EntityCodec:

class EntityCodecTest {

    EntityCodec entityCodec = EntityCodec.DEFAULT;

    @Test
    void testEncode() {
        final UserEntity userEntity = new UserEntity()
                .setId(100L)
                .setName("无名氏")
                .setAge(1024)
                .setAddress("保密");
        final ByteBuf buffer = ByteBufAllocator.DEFAULT.buffer();
        try {
            this.entityCodec.encode(userEntity, buffer);
            final String hexString = FormatUtils.toHexString(buffer);
            assertEquals("0000006409e697a0e5908de6b08f040006e4bf9de5af86", hexString);
        } finally {
            buffer.release();
            assertEquals(0, buffer.refCnt());
        }
    }

    @Test
    void testDecode() {
        final ByteBuf buffer = XtreamBytes.byteBufFromHexString(ByteBufAllocator.DEFAULT, "0000006409e697a0e5908de6b08f040006e4bf9de5af86");
        try {
            final UserEntity entity = this.entityCodec.decode(UserEntity.class, buffer);
            assertEquals(100L, entity.getId());
            assertEquals("无名氏", entity.getName());
            assertEquals(1024, entity.getAge());
            assertEquals("保密", entity.getAddress());
        } finally {
            buffer.release();
            assertEquals(0, buffer.refCnt());
        }
    }

    @Getter
    @Setter
    @ToString
    @Accessors(chain = true)
    public static class UserEntity {

        @Preset.RustStyle.u32(desc = "用户ID(32位无符号数)")
        private Long id;

        // prependLengthFieldType: 前置一个 u8 类型的字段表示当前字段的长度
        @Preset.RustStyle.str(prependLengthFieldType = PrependLengthFieldType.u8, desc = "用户名")
        private String name;

        @Preset.RustStyle.u16(desc = "年龄(16位无符号数)")
        private Integer age;

        // prependLengthFieldType: 前置一个 u8 类型的字段表示当前字段的长度
        @Preset.RustStyle.str(prependLengthFieldType = PrependLengthFieldType.u8, desc = "地址")
        private String address;

    }
}