Netty 搭建 TCP服务器（一）
本文内容如有错误、不足之处，欢迎技术爱好者们一同探讨，在本文下面讨论区留言，感谢。
需求
软件客户端定时发送心跳包到TCP服务器，TCP服务器在接到消息情况下（是与webSocket服信息交互），发送命令到软件客户端。
设计思路
流程图：
设计代码
-
项目介绍
项目使用gradle构建、springboot框架。 -
netty搭建
搭建tcp服务器采用netty，一是netty是nio服务器，效率高。而是netty搭建比较成熟，可以找到资料进行业务完善。 -
核心类
编解码、netty配置信息、通信类、handler处理器 -
核心代码
工具类Crc16Utils:
import java.nio.ByteBuffer;
import java.nio.ByteOrder;
public class Crc16Utils {
private static final byte[] CRC_HI = {0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x01,
(byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01,
(byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80,
(byte) 0x41, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01,
(byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80,
(byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x01,
(byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x01, (byte) 0xC0, (byte) 0x80,
(byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x00, (byte) 0xC1,
(byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80,
(byte) 0x41, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x00, (byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40, (byte) 0x01, (byte) 0xC0,
(byte) 0x80, (byte) 0x41, (byte) 0x00, (byte) 0xC1, (byte) 0x81,
(byte) 0x40, (byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41,
(byte) 0x01, (byte) 0xC0, (byte) 0x80, (byte) 0x41, (byte) 0x00,
(byte) 0xC1, (byte) 0x81, (byte) 0x40};
private static final byte[] CRC_LO = {(byte) 0x00, (byte) 0xC0,
(byte) 0xC1, (byte) 0x01, (byte) 0xC3, (byte) 0x03, (byte) 0x02,
(byte) 0xC2, (byte) 0xC6, (byte) 0x06, (byte) 0x07, (byte) 0xC7,
(byte) 0x05, (byte) 0xC5, (byte) 0xC4, (byte) 0x04, (byte) 0xCC,
(byte) 0x0C, (byte) 0x0D, (byte) 0xCD, (byte) 0x0F, (byte) 0xCF,
(byte) 0xCE, (byte) 0x0E, (byte) 0x0A, (byte) 0xCA, (byte) 0xCB,
(byte) 0x0B, (byte) 0xC9, (byte) 0x09, (byte) 0x08, (byte) 0xC8,
(byte) 0xD8, (byte) 0x18, (byte) 0x19, (byte) 0xD9, (byte) 0x1B,
(byte) 0xDB, (byte) 0xDA, (byte) 0x1A, (byte) 0x1E, (byte) 0xDE,
(byte) 0xDF, (byte) 0x1F, (byte) 0xDD, (byte) 0x1D, (byte) 0x1C,
(byte) 0xDC, (byte) 0x14, (byte) 0xD4, (byte) 0xD5, (byte) 0x15,
(byte) 0xD7, (byte) 0x17, (byte) 0x16, (byte) 0xD6, (byte) 0xD2,
(byte) 0x12, (byte) 0x13, (byte) 0xD3, (byte) 0x11, (byte) 0xD1,
(byte) 0xD0, (byte) 0x10, (byte) 0xF0, (byte) 0x30, (byte) 0x31,
(byte) 0xF1, (byte) 0x33, (byte) 0xF3, (byte) 0xF2, (byte) 0x32,
(byte) 0x36, (byte) 0xF6, (byte) 0xF7, (byte) 0x37, (byte) 0xF5,
(byte) 0x35, (byte) 0x34, (byte) 0xF4, (byte) 0x3C, (byte) 0xFC,
(byte) 0xFD, (byte) 0x3D, (byte) 0xFF, (byte) 0x3F, (byte) 0x3E,
(byte) 0xFE, (byte) 0xFA, (byte) 0x3A, (byte) 0x3B, (byte) 0xFB,
(byte) 0x39, (byte) 0xF9, (byte) 0xF8, (byte) 0x38, (byte) 0x28,
(byte) 0xE8, (byte) 0xE9, (byte) 0x29, (byte) 0xEB, (byte) 0x2B,
(byte) 0x2A, (byte) 0xEA, (byte) 0xEE, (byte) 0x2E, (byte) 0x2F,
(byte) 0xEF, (byte) 0x2D, (byte) 0xED, (byte) 0xEC, (byte) 0x2C,
(byte) 0xE4, (byte) 0x24, (byte) 0x25, (byte) 0xE5, (byte) 0x27,
(byte) 0xE7, (byte) 0xE6, (byte) 0x26, (byte) 0x22, (byte) 0xE2,
(byte) 0xE3, (byte) 0x23, (byte) 0xE1, (byte) 0x21, (byte) 0x20,
(byte) 0xE0, (byte) 0xA0, (byte) 0x60, (byte) 0x61, (byte) 0xA1,
(byte) 0x63, (byte) 0xA3, (byte) 0xA2, (byte) 0x62, (byte) 0x66,
(byte) 0xA6, (byte) 0xA7, (byte) 0x67, (byte) 0xA5, (byte) 0x65,
(byte) 0x64, (byte) 0xA4, (byte) 0x6C, (byte) 0xAC, (byte) 0xAD,
(byte) 0x6D, (byte) 0xAF, (byte) 0x6F, (byte) 0x6E, (byte) 0xAE,
(byte) 0xAA, (byte) 0x6A, (byte) 0x6B, (byte) 0xAB, (byte) 0x69,
(byte) 0xA9, (byte) 0xA8, (byte) 0x68, (byte) 0x78, (byte) 0xB8,
(byte) 0xB9, (byte) 0x79, (byte) 0xBB, (byte) 0x7B, (byte) 0x7A,
(byte) 0xBA, (byte) 0xBE, (byte) 0x7E, (byte) 0x7F, (byte) 0xBF,
(byte) 0x7D, (byte) 0xBD, (byte) 0xBC, (byte) 0x7C, (byte) 0xB4,
(byte) 0x74, (byte) 0x75, (byte) 0xB5, (byte) 0x77, (byte) 0xB7,
(byte) 0xB6, (byte) 0x76, (byte) 0x72, (byte) 0xB2, (byte) 0xB3,
(byte) 0x73, (byte) 0xB1, (byte) 0x71, (byte) 0x70, (byte) 0xB0,
(byte) 0x50, (byte) 0x90, (byte) 0x91, (byte) 0x51, (byte) 0x93,
(byte) 0x53, (byte) 0x52, (byte) 0x92, (byte) 0x96, (byte) 0x56,
(byte) 0x57, (byte) 0x97, (byte) 0x55, (byte) 0x95, (byte) 0x94,
(byte) 0x54, (byte) 0x9C, (byte) 0x5C, (byte) 0x5D, (byte) 0x9D,
(byte) 0x5F, (byte) 0x9F, (byte) 0x9E, (byte) 0x5E, (byte) 0x5A,
(byte) 0x9A, (byte) 0x9B, (byte) 0x5B, (byte) 0x99, (byte) 0x59,
(byte) 0x58, (byte) 0x98, (byte) 0x88, (byte) 0x48, (byte) 0x49,
(byte) 0x89, (byte) 0x4B, (byte) 0x8B, (byte) 0x8A, (byte) 0x4A,
(byte) 0x4E, (byte) 0x8E, (byte) 0x8F, (byte) 0x4F, (byte) 0x8D,
(byte) 0x4D, (byte) 0x4C, (byte) 0x8C, (byte) 0x44, (byte) 0x84,
(byte) 0x85, (byte) 0x45, (byte) 0x87, (byte) 0x47, (byte) 0x46,
(byte) 0x86, (byte) 0x82, (byte) 0x42, (byte) 0x43, (byte) 0x83,
(byte) 0x41, (byte) 0x81, (byte) 0x80, (byte) 0x40};
public static short calcCrc16(byte[] data) {
int uIndex;
byte uchCRCHi = (byte) 0xFF;
byte uchCRCLo = (byte) 0xFF;
for (int i = 0; i < data.length; i++) {
uIndex = (uchCRCHi ^ data[i]) & 0xFF;
uchCRCHi = (byte) (uchCRCLo ^ CRC_HI[uIndex]);
uchCRCLo = CRC_LO[uIndex];
}
int crc = ((((int) uchCRCLo) << 8 | (((int) uchCRCHi) & 0xFF))) & 0xFFFF;
return (short) crc;
}
static public short calcCrc16ByLittleEndian(byte[] data) {
short res = Crc16Utils.calcCrc16(data);
ByteOrder order = ByteOrder.LITTLE_ENDIAN;
ByteBuffer buf = ByteBuffer.allocate(2).order(order);
buf.putShort(res);
byte[] bytes = new byte[2];
bytes[0] = buf.get(1);
bytes[1] = buf.get(0);
res = ByteBuffer.wrap(bytes).order(order).getShort();
return res;
}
}
编码类：
import common.util.Crc16Utils;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;
import java.nio.charset.Charset;
import java.util.List;
public class MessageDecoder extends ByteToMessageDecoder {
private final Charset charset;
/**
* Creates a new instance with the current system character set.
*/
public MessageDecoder() {
this(Charset.defaultCharset());
}
/**
* Creates a new instance with the specified character set.
*/
public MessageDecoder(Charset charset) {
if (charset == null) {
throw new NullPointerException("charset");
}
this.charset = charset;
}
@Override
protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, Listimport common.util.Crc16Utils;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;
import java.nio.charset.Charset;
public class MessageEncoder extends MessageToByteEncoder {
private final Charset charset;
/**
* Creates a new instance with the current system character set.
*/
public MessageEncoder() {
this(Charset.defaultCharset());
}
/**
* Creates a new instance with the specified character set.
*/
public MessageEncoder(Charset charset) {
if (charset == null) {
throw new NullPointerException("charset");
}
this.charset = charset;
}
@Override
protected void encode(ChannelHandlerContext ctx, SelfDefinedProtocol msg, ByteBuf out) throws Exception {
// 写入消息自定义的具体内容
// steep1.写入消息的开头的信息标志（int类型）
out.writeShort(msg.getHeadData());
// steep2.写入消息的长度（int类型）
out.writeShort(msg.getContentLength());
// steep3.写入协议版本（byte[] 类型）
out.writeByte(msg.getVersion());
// steep4.写入消息的内容（byte[] 类型）
out.writeBytes(msg.getContent());
// steep5.写入消息内容的crc校验（short 类型）
byte[] data = msg.getContent();
byte[] newBytes = new byte[data.length + 1];
newBytes[0] = SelfDefinedProtocol.VERSION;
for (int i = 1; i < newBytes.length; i++) {
newBytes[i] = data[i - 1];
}
short calcCrcValue = Crc16Utils.calcCrc16(data);
out.writeShort(calcCrcValue);
// steep6.写入消息的结尾的信息标志（int类型）
out.writeShort(msg.getTailData());
}
}
采用spring ymal配置文件方式配置netty服务器配置
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelOption;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.stereotype.Component;
import java.net.InetSocketAddress;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
/**
* 读取yml配置文件中的信息
*/
@Component
@ConfigurationProperties(prefix = "netty")
public class NettyConfig {
private int port;
private int bossCount = 2;
private int workerCount = 2;
@Value("${netty.port:}")
private int tcpPort;
@Value("${netty.keepalive:true}")
private boolean keepAlive ;
@Value("${netty.backlog:}")
private int backlog;
@Autowired
@Qualifier("springProtocolInitializer")
private StringProtocolInitalizer protocolInitalizer;
/**
* bootstrap配置
* @return
*/
@SuppressWarnings("unchecked")
@Bean(name = "serverBootstrap")
public ServerBootstrap bootstrap() {
ServerBootstrap b = new ServerBootstrap();
b.group(bossGroup(), workerGroup())
.channel(NioServerSocketChannel.class)
.childHandler(protocolInitalizer);
Map, Object> tcpChannelOptions = tcpChannelOptions();
Set> keySet = tcpChannelOptions.keySet();
for (@SuppressWarnings("rawtypes")
ChannelOption option : keySet) {
b.option(option, tcpChannelOptions.get(option));
}
return b;
}
@Bean(name = "bossGroup", destroyMethod = "shutdownGracefully")
public NioEventLoopGroup bossGroup() {
return new NioEventLoopGroup(bossCount);
}
@Bean(name = "workerGroup", destroyMethod = "shutdownGracefully")
public NioEventLoopGroup workerGroup() {
return new NioEventLoopGroup(workerCount);
}
@Bean(name = "tcpSocketAddress")
public InetSocketAddress tcpPort() {
return new InetSocketAddress(tcpPort);
}
@Bean(name = "tcpChannelOptions")
public Map, Object> tcpChannelOptions() {
Map, Object> options = new HashMap, Object>();
options.put(ChannelOption.SO_KEEPALIVE, keepAlive);
options.put(ChannelOption.SO_BACKLOG, backlog);
return options;
}
@Bean(name = "stringEncoder")
public StringEncoder stringEncoder() {
return new StringEncoder();
}
@Bean(name = "stringDecoder")
public StringDecoder stringDecoder() {
return new StringDecoder();
}
/**
* Necessary to make the Value annotations work.
*
* @return
*/
@Bean
public static PropertySourcesPlaceholderConfigurer propertyPlaceholderConfigurer() {
return new PropertySourcesPlaceholderConfigurer();
}
}
自定义报文协议
参考《NMEA协议》
NMEA协议的基本格式
- 以$或者!开头，以结尾
- 在开始字符与结束字符之间，为一组以逗号分隔的字符串，例如：
- $GPAAM,A,A,0.10,N,WPTNME*32
- 因为回车+换行无法显示，因此实际上上面的例子中32后面是回车+换行
- 在$与*中间的字符，为实际传输的信息，*之后的信息为校验码，有些NMEA0183协议有校验码，有些没有校验码，也不是所有的设备及所有的
- 分为四种语句
- 参数语句，即类似上述例子中的语句，以$开头，前两个字符为发送设备代号，如GP为GPS，后面紧跟的三个字符（上例中为AAM）是语句的类型，之后的每个逗号分隔的字段都是一个信息内容
- 封装语句，以！开头，例如!AIVDM,1,1,B,16:>>s5Oh08dLO8AsMAVqptj0@>p,0*67，在B以后的内容为封装信息，需要在解析并适当合并了逗号分隔的信息之后另外解析
- 查询语句，格式为$Q,*
- 私有语句，以$或!开头，紧接P[,”^”,”,”]”*""
采用的报文字段含义：
| 内容 | 格式及符号 | 备注 |
|---|---|---|
| 消息索引 | llll | 四位整数 |
| 消息内容 | SSSSSSS | 字符串标识 |
| 时间 | hhmmss.ss | 时分秒 |
| 变长数 | x.x | 字段长度可变，例如73，73.0 |
数据源可能是TCP、串口、文件或者其它类型，在本系统采用TCP协议。
报文编解码流程：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iKMR01PM-1578401721351)(https://note.youdao.com/yws/api/personal/file/584CC330E154402DB12F774F26AEC557?method=download&shareKey=d91978252e067e5c7f47d70f66c28959)]
/**
*
* 自定义报文协议
* 数据包格式
* +——----——+——-----——+——----——+
* |协议开始标志| 长度 | 版本 | 数据 | crc校验 | 协议结束标志 |
* |-----2------|----2----|----1-----|----N-----|-----2----|-------2------|
* +——----——+——-----——+——----——+
* 1.协议开始标志head_data，为int类型的数据，16进制表示为0X76
* 2.传输数据的长度contentLength，int类型
* 3.要传输的数据
*
*/
public class SelfDefinedProtocol {
/**
* 最小长度
*/
public static final short MIN_LENGTH = 9;
/**
* 消息的开头标志
*/
public static final short HEAD_DATA = 0x2A2A;
/**
* 消息的结束标志
*/
public static final short TAIL_DATA = 0x2323;
/**
* 消息的版本号
*/
public static final byte VERSION = '1';
/**
* 消息的开头的信息标志
*/
private short headData = HEAD_DATA;
/**
* 消息的长度
*/
private short contentLength;
/**
* 版本号
*/
private byte version = VERSION;
/**
* 消息的内容
*/
private byte[] content;
/**
* crc消息的内容
*/
private short crcContent;
/**
* 消息的结束的信息标志
*/
private short tailData = TAIL_DATA;
public SelfDefinedProtocol(short contentLength, byte[] content) {
this.contentLength = contentLength;
this.content = content;
}
public short getHeadData() {
return headData;
}
public void setHeadData(short headData) {
this.headData = headData;
}
public short getContentLength() {
return contentLength;
}
public void setContentLength(short contentLength) {
this.contentLength = contentLength;
}
public byte getVersion() {
return version;
}
public void setVersion(byte version) {
this.version = version;
}
public byte[] getContent() {
return content;
}
public void setContent(byte[] content) {
this.content = content;
}
public short getCrcContent() {
return crcContent;
}
public void setCrcContent(short crcContent) {
this.crcContent = crcContent;
}
public short getTailData() {
return tailData;
}
public void setTailData(short tailData) {
this.tailData = tailData;
}
public static SelfDefinedProtocol newSuccess() {
byte[] content = Result.newSuccess().toString().getBytes();
SelfDefinedProtocol selfDefinedProtocol = new SelfDefinedProtocol((short)content.length,content);
return selfDefinedProtocol;
}
public static SelfDefinedProtocol newFail() {
byte[] content = Result.newFaild().toString().getBytes();
SelfDefinedProtocol selfDefinedProtocol = new SelfDefinedProtocol((short)content.length,content);
return selfDefinedProtocol;
}
}