一.pom.xml中引入netty的依赖包:
io.netty
netty-all
4.1.31.Final
二.application.properties中添加配置:
# 作为客户端请求的服务端地址
netty.tcp.server.host=127.0.0.1
# 作为客户端请求的服务端端口
netty.tcp.server.port=7000
# 作为服务端开放给客户端的端口
netty.tcp.client.port=7000
三.server端编写:
1.NettyTcpServer:
package com.h3c.iot.app.engine.netty.tcp.server;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelOption;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.util.concurrent.Future;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* description:
* author:
* date: 2018-11-28 12:07
**/
@Component
public class NettyTcpServer {
private static final Logger log = LoggerFactory.getLogger(NettyTcpServer.class);
//boss事件轮询线程组
//处理Accept连接事件的线程,这里线程数设置为1即可,netty处理链接事件默认为单线程,过度设置反而浪费cpu资源
private EventLoopGroup boss = new NioEventLoopGroup(1);
//worker事件轮询线程组
//处理hadnler的工作线程,其实也就是处理IO读写 。线程数据默认为 CPU 核心数乘以2
private EventLoopGroup worker = new NioEventLoopGroup();
@Autowired
ServerChannelInitializer serverChannelInitializer;
@Value("${netty.tcp.client.port}")
private Integer port;
//与客户端建立连接后得到的通道对象
private Channel channel;
/**
* 存储client的channel
* key:ip,value:Channel
*/
public static Map map = new ConcurrentHashMap();
/**
* 开启Netty tcp server服务
*
* @return
*/
public ChannelFuture start() {
//启动类
ServerBootstrap serverBootstrap = new ServerBootstrap();
serverBootstrap.group(boss, worker)//组配置,初始化ServerBootstrap的线程组
.channel(NioServerSocketChannel.class)///构造channel通道工厂//bossGroup的通道,只是负责连接
.childHandler(serverChannelInitializer)//设置通道处理者ChannelHandler////workerGroup的处理器
.option(ChannelOption.SO_BACKLOG, 1024)//socket参数,当服务器请求处理程全满时,用于临时存放已完成三次握手请求的队列的最大长度。如果未设置或所设置的值小于1,Java将使用默认值50。
.childOption(ChannelOption.SO_KEEPALIVE, true);//启用心跳保活机制,tcp,默认2小时发一次心跳
//Future:异步任务的生命周期,可用来获取任务结果
ChannelFuture channelFuture1 = serverBootstrap.bind(port).syncUninterruptibly();//绑定端口,开启监听,同步等待
if (channelFuture1 != null && channelFuture1.isSuccess()) {
channel = channelFuture1.channel();//获取通道
log.info("Netty tcp server start success, port = {}", port);
} else {
log.error("Netty tcp server start fail");
}
return channelFuture1;
}
/**
* 停止Netty tcp server服务
*/
@PreDestroy
public void destroy() {
if (channel != null) {
channel.close();
}
try {
Future> future = worker.shutdownGracefully().await();
if (!future.isSuccess()) {
log.error("netty tcp workerGroup shutdown fail, {}", future.cause());
}
Future> future1 = boss.shutdownGracefully().await();
if (!future1.isSuccess()) {
log.error("netty tcp bossGroup shutdown fail, {}", future1.cause());
}
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("Netty tcp server shutdown success");
}
}
2.ServerChannelInitializer:
package com.h3c.iot.app.engine.netty.tcp.server;
import com.h3c.iot.app.engine.netty.tcp.MessagePacketDecoder;
import com.h3c.iot.app.engine.netty.tcp.MessagePacketEncoder;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.handler.timeout.IdleStateHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
/**
* description: 通道初始化,主要用于设置各种Handler
* author:
* date: 2018-11-28 14:55
**/
@Component
public class ServerChannelInitializer extends ChannelInitializer {
@Autowired
ServerChannelHandler serverChannelHandler;
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
ChannelPipeline pipeline = socketChannel.pipeline();
//IdleStateHandler心跳机制,如果超时触发Handle中userEventTrigger()方法
pipeline.addLast("idleStateHandler",
new IdleStateHandler(15, 0, 0, TimeUnit.MINUTES));
//字符串编解码器
pipeline.addLast(
new StringDecoder(),
new StringEncoder()
);
//自定义Handler
pipeline.addLast("serverChannelHandler", serverChannelHandler);
}
}
3.ServerChannelHandler:
package com.h3c.iot.app.engine.netty.tcp.server;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.timeout.IdleState;
import io.netty.handler.timeout.IdleStateEvent;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
/**
* description:
* author:
* date: 2018-11-28 15:49
**/
@Component
@ChannelHandler.Sharable
@Slf4j
public class ServerChannelHandler extends SimpleChannelInboundHandler
四.client端编写。
1.NettyTcpClient:
package com.h3c.iot.app.engine.netty.tcp.client;
import io.netty.bootstrap.Bootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelOption;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* description:
* author: yangzihe
* date: 2018-12-28 13:59
**/
@Component
public class NettyTcpClient {
private static final Logger log = LoggerFactory.getLogger(NettyTcpClient.class);
@Value(("${netty.tcp.server.host}"))
String HOST;
@Value("${netty.tcp.server.port}")
int PORT;
@Autowired
ClientChannelInitializer clientChannelInitializer;
//与服务端建立连接后得到的通道对象
private Channel channel;
/**
* 初始化 `Bootstrap` 客户端引导程序
*
* @return
*/
private final Bootstrap getBootstrap() {
Bootstrap b = new Bootstrap();
EventLoopGroup group = new NioEventLoopGroup();
b.group(group)
.channel(NioSocketChannel.class)//通道连接者
.handler(clientChannelInitializer)//通道处理者
.option(ChannelOption.SO_KEEPALIVE, true);//心跳报活
return b;
}
/**
* 建立连接,获取连接通道对象
*
* @return
*/
public void connect() {
ChannelFuture channelFuture = getBootstrap().connect(HOST, PORT).syncUninterruptibly();
if (channelFuture != null && channelFuture.isSuccess()) {
channel = channelFuture.channel();
log.info("connect tcp server host = {}, port = {} success", HOST, PORT);
} else {
log.error("connect tcp server host = {}, port = {} fail", HOST, PORT);
}
}
/**
* 向服务器发送消息
*
* @param msg
* @throws Exception
*/
public void sendMsg(Object msg) throws Exception {
if (channel != null) {
channel.writeAndFlush(msg).sync();
} else {
log.warn("消息发送失败,连接尚未建立!");
}
}
}
2.ClientChannelInitializer:
package com.h3c.iot.app.engine.netty.tcp.client;
import com.h3c.iot.app.engine.netty.tcp.server.ServerChannelHandler;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.handler.timeout.IdleStateHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
/**
* description: 通道初始化,主要用于设置各种Handler
* author:
* date: 2018-11-28 14:55
**/
@Component
public class ClientChannelInitializer extends ChannelInitializer {
@Autowired
ClientChannelHandler clientChannelHandler;
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
ChannelPipeline pipeline = socketChannel.pipeline();
//IdleStateHandler心跳机制,如果超时触发Handle中userEventTrigger()方法
pipeline.addLast("idleStateHandler",
new IdleStateHandler(15, 0, 0, TimeUnit.MINUTES));
//字符串编解码器
pipeline.addLast(
new StringDecoder(),
new StringEncoder()
);
//自定义Handler
pipeline.addLast("clientChannelHandler", clientChannelHandler);
}
}
3.ClientChannelHandler:
package com.h3c.iot.app.engine.netty.tcp.client;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import org.springframework.stereotype.Component;
/**
* description:
* author: yangzihe
* date: 2018-12-28 14:06
**/
@Component
@ChannelHandler.Sharable
public class ClientChannelHandler extends SimpleChannelInboundHandler
五.启动类配置:
package com.h3c.iot.app.engine;
import com.h3c.iot.app.engine.netty.tcp.client.NettyTcpClient;
import com.h3c.iot.app.engine.netty.tcp.server.NettyTcpServer;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
/**
* ClassName: SpringBootApplication
* description:
* author: yangzihe
* date: 2018-09-30 09:15
**/
@org.springframework.boot.autoconfigure.SpringBootApplication//@EnableAutoConfiguration @ComponentScan
public class SpringBootApplication implements CommandLineRunner {
public static void main(String[] args) {
SpringApplication.run(SpringBootApplication.class, args);
}
@Autowired
NettyTcpServer nettyTcpServer;
@Autowired
NettyTcpClient nettyTcpClient;
@Override
public void run(String... args) throws Exception {
//启动服务端
ChannelFuture start = nettyTcpServer.start();
//启动客户端,发送数据
nettyTcpClient.connect();
for (int i = 0; i < 10; i++) {
nettyTcpClient.sendMsg("hello world" + i);
}
//服务端管道关闭的监听器并同步阻塞,直到channel关闭,线程才会往下执行,结束进程
start.channel().closeFuture().syncUninterruptibly();
}
}
六.项目目录:
七.启动SpringBootApplication,结果如下: