Netty通道的容器属性Attribute

Netty中的Channel通道类,有类似于Map的容器功能,可以通过“key-value”键值对的形式来保存任何Java Object的值。一般来说可以存放一些与通道实例相关联的属性,比如说服务期端的ServerSession会话实例。

Netty对此的实现其实并没有依赖Map接口,而是定义了一个类似的接口叫做AttributeMap。它有一个方法 Attributeattr(AttributeKey key),此方法接收一个AttributeKey类型的key,返回一个Attribute类型的值,即根据key获取value。这里的AttributeKey不是原始的key,而是一个key的包装类。AttributeKey确保了key的唯一性,在单个Netty应用中,key值必须唯一。而Attribute也不是原始的value,而是value的包装类。原始的value值就放置在Attribute包装类中,可以通过Attribute包装类实现value的读取(get)和设置(set),取值和设置值。这个方法永远不会返回null,但可能会返回一个尚未设置值的Attribute。

AttributeMap只是一个接口,Netty提供了默认的实现DefaultAttributeMap(Channel通道类就是继承了这个类)。这个类维护了一个DefaultAttribute(继承自AtomicReference类,用来保存value值,此外还维护了AttributeKey属性和DefaultAttributeMap属性)类型的数组变量attributes,提供了对attr方法的实现。对于传入的AttributeKey会在attributes中二分查找是否存在,如果不存在则将有序插入(根据key的id值,默认后插入的id要大)。

AttributeMap的实现要求是线程安全的,所以在DefaultAttributeMap中的实现都采用拷贝副本的方式。可以通过AttributeMap的attr方法,根据key取得Attribute类型的value,然后根据value实例完成最终的两个重要操作:设置(set)和取值(get)。

使用方式:

// 定义key
public static final AttributeKey<ServerSession> SESSION_KEY = AttributeKey.valueOf("SESSION_KEY");
// ......
// 通过设置将会话绑定到通道
channel.attr(SESSION_KEY).set(session);


// 取值
ServerSession session = ctx.channel().attr(SESSION_KEY).get();

AttributeKey的创建需要用到静态方法AttributeKey.valueOf(String)方法。该方法的返回值为一个AttributeKey实例,它的泛型类型为实际上的key-value键值对中value的键值对中value的实际类型。创建完AttributeKey之后就可以通过通道完成key-value的设值和取值了。

这里AttributeKey一般定义为一个常量,需要提前定义,它的泛型参数是Attribute最终的包装值的value的数据类型。

你可能感兴趣的:(java,后端,Java,Netty)