总体来说,做Java TCP程序,netty框架是相当好用的。官网的文档也不错,入门足够了。
但是,在使用的过程中,也会遇到一些不多的问题,这篇文档,就是对搭建netty框架过程中遇到的少量问题做一个记录。
使用netty框架做TCP服务,过程可以分解为三个步骤:
写decoder;
所谓decode,就是把对象发过来的数据进行解析,获得我们想要的数据。写handler;
所谓handler,就是处理业务,将解析过的数据,做业务上的处理。写encoder。
所谓encode,就是把业务返回数据,系列化成为TCP通讯传递的数据流。
所以,在搭建netty框架的过程中,必须给框架指定decoder、handler和encoder,它们有一个顺序问题,我们基本上是先给定encoder,然后是decoder,最后是handler:
final String serverIp = super.ip;
b.handler(new ChannelInitializer<SocketChannel>() {
@Override
public void initChannel(SocketChannel ch) throws Exception {
//注册encoder
ch.pipeline().addLast(new CashboxDataEncoder());
// 注册handler
//ch.pipeline().addLast("framehandler", new CashboxDataLengthFieldBasedFrameDecoder(ByteOrder.LITTLE_ENDIAN, Integer.MAX_VALUE, 2, 2, 0, 0, true));
ch.pipeline().addLast("framehandler", new CashboxVariableFormatDecoder(ByteOrder.LITTLE_ENDIAN, Integer.MAX_VALUE, 2, 2, 0, 0, true));
//注册decoder
ch.pipeline().addLast(new CashboxDataDecoder(serverIp));
ch.pipeline().addLast("readTimeOut",new ReadTimeoutHandler(30000, TimeUnit.MILLISECONDS));
//注册handler
ch.pipeline().addLast(new CashboxDownstreamHandler(serverIp));
}
});
上述代码中,有一个encoder,多个decoder,最后是handler。
我们都知道,LengthFieldBasedFrameDecoder
是netty框架给出的一个非常好用的decoder,基本上帮我们解决了绝大多数的数据协议问题。所以,我们在解析数据做decoder的时候,基本上会先使用这个decoder做粘包和拆包的处理。当然了,我们有可能用其他的decoder做粘包和拆包的处理,甚至自定义粘包和拆包处理的decoder。不管怎么样,我们做了粘包和拆包的处理后,都会再做一次decoder,将数据转化为Java的POJO,最后交给handler进行业务处理。
如果有处理粘包和拆包的decoder,那么后面的decoder就必须继承自MessageToMessageDecoder
这个类,而不能继承自ByteToMessageDecoder
:
@Slf4j
public class CashboxDataDecoder extends MessageToMessageDecoder<ByteBuf>{
private String serverIp;
public CashboxDataDecoder(String serverIp)
{
this.serverIp = serverIp;
}
@Override
protected void decode(ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf, List<Object> out) throws Exception {
CashboxBaseData command = getCommandData(this.serverIp);
CashboxBaseDecoder decoder = new CashboxDecoder();
if (command instanceof CashboxParamBaseData) decoder.setHandleType(((CashboxParamBaseData) command).getHandleType());
decoder.setCommandType(command.getType());
CashboxBaseData data = decoder.decode(byteBuf);
//获取cashbox_id,很多地方需要用到。
Optional<Integer> cashboxId = getCashboxIdByIp(this.serverIp);
cashboxId.ifPresent(id -> data.setCashboxId(id));
out.add(data);
}
}
因为TCP传递的是byte数据,而经过前一个decoder以后,得到的数据就是Message类型了,所以第二个decoder就必须继承MessageToMessageDecoder
了。