一、@Sharable的真實含義

當netty嘗試往多個channel的pipeline中添加同一個ChannelHandlerAdapter實例時，會判斷該實例類是否添加了@Sharable，沒有則拋出… is not a @Sharable handler, so can’t be added or removed multiple times異常

如果你添加的不是單例Handler，你加不加@Sharable沒有任何區別

如果你添加的是單例Handler，只要它會被添加到多個channel的pipeline，那就必須加上@Sharable

網上有些資料說netty會將注解了@Sharable的Handler單例化，實在誤導人。channelHandler是不是單例跟netty沒有任何關系，netty只會在你嘗試用單例ChannelHandler時加上第1條說明的限制，這個限制意思很明確，多個channel公用單例ChannelHandler，那它就必須是線程安全的，@Sharable就是用于告訴netty，我這個Handler是線程安全的，可以被多個channel安全的share，假如你搞了個線程不安全的類，你對它用上了單例，還加個@Sharable，這時候netty拿你也沒辦法，只是你的老板可能會有點不開心

• 一般情況下，我們的代碼是這樣：

bootstrap.childHandler(new ChannelInitializer<Channel>() {@Overrideprotected void initChannel(Channel ch) throws Exception {//每次都是new一個新對象，這時候你 ShareTestChannelHandler這個類加不加@Sharable沒有任何區別ch.pipeline().addLast(new ShareTestChannelHandler());}; });

在initChannel方法中，我們addLast傳入的Handler實例，他是不是單例的與netty沒有任何關系，和你是否注解@Sharable也沒有任何關系。就拿上面的代碼說，它就不是單例的，每次都是new一個新對象，這時候你ShareTestChannelHandler這個類加不加@Sharable沒有任何區別。

• 如下代碼

bootstrap.childHandler(new ChannelInitializer<Channel>() {@Overrideprotected void initChannel(Channel ch) throws Exception {//每次傳入的都是單例的Handler對象，只要它會被添加到多個channel的pipeline鏈中，那它就必須是@Sharable的，不然就拋出第1點說的異常ch.pipeline().addLast(new ShareTestChannelHandler());}; });@Sharable public class ShareTestChannelHandler extends SimpleChannelInboundHandler<ByteBuf>public static ShareTestChannelHandler INSTANCE = new ShareTestChannelHandler();private ShareTestChannelHandler() {}...... }

如果，你傳入一個單例的Handler對象，只要它會被添加到多個channel的pipeline鏈中，那它就必須是@Sharable的，不然就拋出第1點說的異常

二、是不是所有Handler都可以加上@Sharable

不是，netty中，解碼器有關的Handler都是不安全的，因為粘包拆包的緣故，Decoder必須要保存一些解析過程的中間狀態，比如ByteToMessageDecoder類中維護的一個字節累加器cumulation，每次讀到當前channel的消息后都會將消息累加到cumulation中，然后再調用子類實現的decode方法。所以它不能被多個channel安全的共享，netty明確的禁止了使用單例Decoder，即使你自作聰明的給他加上@Sharable，也會被禁止掉，拋出... is not allowed to be shared錯誤。

所以我們在添加Decoder時：

必須不是單例

不要添加@Sharable

例子

@Slf4j //這里添加了@Sharable，肯定會報錯 @ChannelHandler.Sharable public class MessageCodec extends ByteToMessageCodec<Message> {@Overridepublic void encode(ChannelHandlerContext ctx, Message msg, ByteBuf out) throws Exception {// 1. 4 字節的魔數out.writeBytes(new byte[]{1, 2, 3, 4});// 2. 1 字節的版本,out.writeByte(1);// 3. 1 字節的序列化方式 jdk 0 , json 1out.writeByte(0);// 4. 1 字節的指令類型out.writeByte(msg.getMessageType());// 5. 4 個字節out.writeInt(msg.getSequenceId());// 無意義，對齊填充，讓固定字節數為2的n次方倍out.writeByte(0xff);// 6. 獲取內容的字節數組(序列化)ByteArrayOutputStream bos = new ByteArrayOutputStream();ObjectOutputStream oos = new ObjectOutputStream(bos);oos.writeObject(msg);byte[] bytes = bos.toByteArray();// 7. 長度out.writeInt(bytes.length);// 8. 寫入內容out.writeBytes(bytes);}@Overrideprotected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {int magicNum = in.readInt();byte version = in.readByte();byte serializerType = in.readByte();byte messageType = in.readByte();int sequenceId = in.readInt();in.readByte();int length = in.readInt();byte[] bytes = new byte[length];in.readBytes(bytes, 0, length);ObjectInputStream ois = new ObjectInputStream(new ByteArrayInputStream(bytes));Message message = (Message) ois.readObject();log.debug("{}, {}, {}, {}, {}, {}", magicNum, version, serializerType, messageType, sequenceId, length);log.debug("{}", message);//可能解析出多條信息，加到list里面，給下一個handler處理out.add(message);} }

但是，如果我們明確知道MessageCodec是線程安全的），要使用@Sharable，就不要繼承ByteToMessageCodec了，可以通過繼承 MessageToMessageCodec來實現。

@Slf4j @ChannelHandler.Sharable /*** 必須和 LengthFieldBasedFrameDecoder 一起使用，以確保接到的 ByteBuf 消息是完整的，防止沒接收到完整信息，又切換到其他channel使用，導致線程不安全*/ public class MessageCodecSharable extends MessageToMessageCodec<ByteBuf, Message> {@Overridepublic void encode(ChannelHandlerContext ctx, Message msg, List<Object> outList) throws Exception {ByteBuf out = ctx.alloc().buffer();// 1. 4 字節的魔數out.writeBytes(new byte[]{1, 2, 3, 4});// 2. 1 字節的版本,out.writeByte(1);// 3. 1 字節的序列化方式 jdk 0 , json 1out.writeByte(Config.getSerializerAlgorithm().ordinal());// 4. 1 字節的指令類型out.writeByte(msg.getMessageType());// 5. 4 個字節out.writeInt(msg.getSequenceId());// 無意義，對齊填充out.writeByte(0xff);// 6. 獲取內容的字節數組byte[] bytes = Config.getSerializerAlgorithm().serialize(msg);// 7. 長度out.writeInt(bytes.length);// 8. 寫入內容out.writeBytes(bytes);outList.add(out);}@Overrideprotected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {int magicNum = in.readInt();byte version = in.readByte();byte serializerAlgorithm = in.readByte(); // 0 或 1byte messageType = in.readByte(); // 0,1,2...int sequenceId = in.readInt();in.readByte();int length = in.readInt();byte[] bytes = new byte[length];in.readBytes(bytes, 0, length);// 找到反序列化算法Serializer.Algorithm algorithm = Serializer.Algorithm.values()[serializerAlgorithm];// 確定具體消息類型Class<? extends Message> messageClass = Message.getMessageClass(messageType);Message message = algorithm.deserialize(messageClass, bytes);out.add(message);} }

三、總結

加了@Sharable的類，netty就認為是線程安全，可以共享，而只要netty明確的禁止了使用單例Handler，即使你給他加上@Sharable，也會被禁止掉。同時，如果一個類是單例的Handler對象，同時他會被添加到多個channel的pipeline鏈中，那它就必須是@Sharable的，不然也會報錯。

• handler 不保存狀態時，就可以安全地在多線程下被共享
• 但要注意對于編解碼器類，不能繼承 ByteToMessageCodec 或 CombinedChannelDuplexHandler 父類，他們的構造方法對 @Sharable 有限制
• 如果能確保編解碼器不會保存狀態，可以繼承 MessageToMessageCodec 父類

參考視頻
參考文章
參考文章

總結

以上是生活随笔為你收集整理的Netty @Sharable的使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。