Netty系列(6) Netty中的读写检测&断线重连机制

2.示例实现

2.1 server

package com.zy.netty.netty06;

import com.zy.netty.common.Constants;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.buffer.Unpooled;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.DelimiterBasedFrameDecoder;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.handler.timeout.IdleStateEvent;
import io.netty.handler.timeout.IdleStateHandler;
import io.netty.util.concurrent.DefaultThreadFactory;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;

import java.nio.charset.StandardCharsets;
import java.time.LocalDateTime;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.LongAdder;

@Slf4j
@Getter
public class Server06 {
    private final ServerBootstrap server;
    private final NioEventLoopGroup acceptorGroup;
    private final NioEventLoopGroup ioGroup;
    private final int acceptorThreads;
    private final int ioThreads;
    private final String host;
    private final int port;

    public Server06(int acceptorThreads, int ioThreads, String host, int port) {
        this.acceptorThreads = acceptorThreads;
        this.ioThreads = ioThreads;
        this.host = host;
        this.port = port;
        this.server = new ServerBootstrap();
        // FIXME 为了调试, 这里不要通过线程工厂设置 daemon 线程, 如果后续 client 运行在容器(如 tomcat) 中, 这里可以设置为 daemon
        // FIXME 说明下, 如果这里全设置为 daemon, 而下述 bind 端口后又未阻塞主线程, 则所有 daemon 将被销毁, 进行停止. 关于 daemon 线程, 可自行研究
        this.acceptorGroup = new NioEventLoopGroup(acceptorThreads, new DefaultThreadFactory("server-acceptor-group", false));
        this.ioGroup = new NioEventLoopGroup(ioThreads, new DefaultThreadFactory("server-io-group", true));
        this.start();
    }

    public Server06(String host, int port) {
        this(1, Runtime.getRuntime().availableProcessors(), host, port);
    }

    private void start() {
        try {
            server.group(acceptorGroup, ioGroup)
                    .channel(NioServerSocketChannel.class)
                    .childOption(ChannelOption.TCP_NODELAY, true)
                    .childHandler(new ChannelInitializer<NioSocketChannel>() {
                        @Override
                        protected void initChannel(NioSocketChannel ch) throws Exception {
                            ch.pipeline()
                                    .addLast(new DelimiterBasedFrameDecoder(4096, Unpooled.copiedBuffer(Constants.CUSTOM_DELIMITER_01.getBytes(StandardCharsets.UTF_8))))
                                    .addLast(new StringDecoder())
                                    .addLast(new StringEncoder())
                                    .addLast(new IdleStateHandler(180L, 0L, 0L, TimeUnit.SECONDS))
                                    .addLast(new BusinessServerHandler());
                        }
                    });

            server.bind(host, port).syncUninterruptibly();
            // FIXME 这里一直监听 client 连接; 也可以用死循环阻塞线程如 while(true){}; 如果 boss 线程都不为 daemon, 则此处也不用再设置
            // channelFuture.channel().closeFuture().sync();
        } catch (Throwable e) {
            System.out.println("server error.");
            e.printStackTrace();
        }
    }

    public void close() {
        if (Objects.nonNull(acceptorGroup)) {
            acceptorGroup.shutdownGracefully();
        }
        if (Objects.nonNull(ioGroup)) {
            ioGroup.shutdownGracefully();
        }
    }

    @ChannelHandler.Sharable
    private class BusinessServerHandler extends SimpleChannelInboundHandler<Object> {
        private LongAdder counter = new LongAdder();
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
            counter.increment();
            System.out.println("server receive msg: " + msg + "; the counter is: " + counter.doubleValue());
            // FIXME 这里是 ctx.channel()?
            ctx.writeAndFlush(LocalDateTime.now().toString() + Constants.CUSTOM_DELIMITER_01);
        }

        @Override
        public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
            if (evt instanceof IdleStateEvent) {
                IdleStateEvent event = (IdleStateEvent) evt;
                if (event == IdleStateEvent.READER_IDLE_STATE_EVENT) {
                    System.out.println(String.format("there is a long time to receive msg from client [%s]", ctx.channel().remoteAddress().toString()));
                    // FIXME 这里是用 ctx.close() 还是 ctx.disconnect() ? 二者区别?
                    ctx.close();
                }
            } else {
                super.userEventTriggered(ctx, evt);
            }
        }
    }
}

2.2 client

package com.zy.netty.netty06;

import com.zy.netty.common.Constants;
import io.netty.bootstrap.Bootstrap;
import io.netty.buffer.Unpooled;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioSocketChannel;
import io.netty.handler.codec.DelimiterBasedFrameDecoder;
import io.netty.handler.codec.string.StringDecoder;
import io.netty.handler.codec.string.StringEncoder;
import io.netty.handler.timeout.IdleStateEvent;
import io.netty.handler.timeout.IdleStateHandler;
import io.netty.util.HashedWheelTimer;
import io.netty.util.Timeout;
import io.netty.util.TimerTask;
import io.netty.util.concurrent.DefaultThreadFactory;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;

import java.nio.charset.StandardCharsets;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.LongAdder;

/**
 * https://www.cnblogs.com/MrRightZhao/p/11967982.html
 * <p>
 * https://www.jianshu.com/p/7052761fa480
 */
@Slf4j
@Getter
public class Client06 {
    private final Bootstrap client;
    private final NioEventLoopGroup nioEventLoopGroup;
    private final int nioThreads;
    private final String host;
    private final int port;
    private final int connectTimeoutMills;
    private final int reconnectTimeoutMills;
    // volatile, please copy reference to use
    private volatile Channel channel;

    public Client06(int nioThreads, String host, int port, int connectTimeoutMills, int reconnectTimeoutMills) {
        this.nioThreads = nioThreads;
        this.host = host;
        this.port = port;
        this.connectTimeoutMills = connectTimeoutMills;
        this.reconnectTimeoutMills = reconnectTimeoutMills;
        this.client = new Bootstrap();
        // FIXME 为了调试, 这里不要通过线程工厂设置 daemon 线程, 如果后续 client 运行在容器(如 tomcat) 中, 这里可以设置为 daemon
        // FIXME 说明下, 如果这里全设置为 daemon, 而下述 bind 端口后又未阻塞主线程, 则所有 daemon 将被销毁, 进行停止. 关于 daemon 线程, 可自行研究
        this.nioEventLoopGroup = new NioEventLoopGroup(nioThreads, new DefaultThreadFactory("client-group", false));
        this.init();
    }

    public Client06(String host, int port) {
        this(Runtime.getRuntime().availableProcessors(), host, port, Constants.CONNECT_TIMEOUT_MILLS, Constants.RECONNECT_TIMEOUT_MILLS);
    }

    private void init() {
        try {
            final WatchdogClientHandler watchdogClientHandler = new WatchdogClientHandler(reconnectTimeoutMills);
            client.group(nioEventLoopGroup)
                    .channel(NioSocketChannel.class)
                    .option(ChannelOption.TCP_NODELAY, true)
                    .option(ChannelOption.SO_KEEPALIVE, true)
                    .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, connectTimeoutMills)
                    .handler(new ChannelInitializer<NioSocketChannel>() {
                        @Override
                        protected void initChannel(NioSocketChannel ch) throws Exception {
                            ch.pipeline()
                                    .addLast(new DelimiterBasedFrameDecoder(4096, Unpooled.copiedBuffer(Constants.CUSTOM_DELIMITER_01.getBytes(StandardCharsets.UTF_8))))
                                    .addLast(new StringDecoder())
                                    .addLast(new StringEncoder())
                                    .addLast(new BusinessClientHandler())
                                    .addLast(new IdleStateHandler(0L, 90L, 0L, TimeUnit.SECONDS))
                                    .addLast(watchdogClientHandler);
                        }
                    });

            doConnect();
            // FIXME 这行代码的意思是, 当监听到 channel 被关闭时, 关闭自身的连接, 仅做调试用, 不可用于生产
            // channelFuture.channel().closeFuture().sync();
        } catch (Throwable e) {
            System.out.println("client error");
            e.printStackTrace();
        }
    }

    public void doConnect() {
        synchronized (client) {
            try {
                ChannelFuture channelFuture = client.connect(host, port);
                channelFuture.addListener((ChannelFutureListener) future -> {
                    if (!future.isSuccess()) {
                        future.channel().pipeline().fireChannelInactive();
                    } else {
                        Channel newChannel = channelFuture.channel();
                        // copy volatile reference
                        Channel oldChannel = Client06.this.channel;
                        if (Objects.nonNull(oldChannel)) {
                            oldChannel.close();
                        }
                        Client06.this.channel = newChannel;
                    }
                });
            } catch (Exception e) {
                System.out.println("client error");
                e.printStackTrace();
            }
        }
    }

    public Channel getChannel() {
        Channel ch = channel;
        if (Objects.isNull(ch) || !ch.isActive()) {
            return null;
        }
        return ch;
    }

    public void close() {
        if (Objects.nonNull(nioEventLoopGroup)) {
            nioEventLoopGroup.shutdownGracefully();
        }
    }

    @ChannelHandler.Sharable
    private class BusinessClientHandler extends SimpleChannelInboundHandler<Object> {
        private LongAdder counter = new LongAdder();

        @Override
        protected void channelRead0(ChannelHandlerContext ctx, Object msg) throws Exception {
            counter.increment();
            System.out.println("client receive msg: " + msg + "; the counter is: " + counter.doubleValue());
        }
    }

    /**
     * 请一定要加上次注解, 关于该注解的作用, 在下文已讲过
     * https://www.jianshu.com/p/051e48410a9d
     */
    @ChannelHandler.Sharable
    private class WatchdogClientHandler extends ChannelInboundHandlerAdapter implements TimerTask {
        private HashedWheelTimer timer;
        private final int timeInternalMills;
        private int retryTimes;

        WatchdogClientHandler(int timeInternalMills) {
            this.timer = new HashedWheelTimer();
            this.timeInternalMills = timeInternalMills;
            this.retryTimes = 0;
        }

        @Override
        public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
            if (evt instanceof IdleStateEvent) {
                IdleStateEvent event = (IdleStateEvent) evt;
                if (event == IdleStateEvent.WRITER_IDLE_STATE_EVENT) {
                    // FIXME 注释掉这里, 测试服务端 close channel 后, 是否重连
                    ctx.writeAndFlush("ping" + Constants.CUSTOM_DELIMITER_01);
                }
            } else {
                super.userEventTriggered(ctx, evt);
            }
        }

        @Override
        public void channelActive(ChannelHandlerContext ctx) throws Exception {
            System.out.println("连接成功 -- 重置 retryTimes=0");
            retryTimes = 0;
            ctx.fireChannelActive();
        }

        @Override
        public void channelInactive(ChannelHandlerContext ctx) throws Exception {
            retryTimes++;
            System.out.println("第" + retryTimes + "次连接失效了");
            // 这里可以根据 retryTimes 大小判断是否无限重连
            timer.newTimeout(this, timeInternalMills, TimeUnit.MILLISECONDS);
            ctx.fireChannelInactive();
        }

        @Override
        public void run(Timeout timeout) throws Exception {
            System.out.println("开始重连");
            doConnect();
        }
    }
}

2.3 common

package com.zy.netty.common;

public interface Constants {
    String CUSTOM_DELIMITER_01 = "$_";
    Integer CONNECT_TIMEOUT_MILLS = 3000;
    Integer RECONNECT_TIMEOUT_MILLS = 180;
}
服务端读空闲, 主动关闭了客户端连接.png
服务端异常关闭,客户端重连.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,445评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,889评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,047评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,760评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,745评论 5 367
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,638评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,011评论 3 398
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,669评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,923评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,655评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,740评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,406评论 4 320
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,995评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,961评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,023评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,483评论 2 342

推荐阅读更多精彩内容