netty 使用简易教程

服务端主要有以下几步:

  1. 新建服务netty boot
  2. 实现出站数据分包规则
  3. 实现数据入站组包规则
  4. 实现自定义对象转换为bytes编码器
  5. 实现bytes转换为自定义对象解码器
  6. 对接收到的对象处理.

  1. 第一步很简单,直接new就可以.
ServerBootstrap nettyBoot =new ServerBootstrap();
  1. 第二步,第三步,netty也实现了,只需传参自定义即可.
LengthFieldPrepender prepender = new LengthFieldPrepender(4, true);
LengthFieldBasedFrameDecoder frameDecoder = new LengthFieldBasedFrameDecoder(Integer.MAX_VALUE, 0, 4, -4, 4);
  1. 第四步,新建对象编码字符串类.这里写一个简单点的StringToBytes编码类.
/**
 * StringToBytesEncoder
 * <p>
 * 释义: 字符串转换为bytes编码器
 *
 * @author: xinyi.pan
 * @create: 2018-11-28 09:42
 **/
@ChannelHandler.Sharable
public class StringToBytesEncoder extends MessageToByteEncoder<String> {
    @Override
    protected void encode(ChannelHandlerContext ctx, String msg, ByteBuf out) throws Exception {
        //编码
        out.writeCharSequence(msg, StandardCharsets.UTF_8);
    }
}
  1. 第五步,新建一个bytes解码类
/**
 * BytesToStringDecoder
 * <p>
 * 释义: bytes -> string 解码器
 *
 * @author: xinyi.pan
 * @create: 2018-11-28 09:44
 **/
@ChannelHandler.Sharable
public class BytesToStringDecoder extends MessageToMessageDecoder<ByteBuf> {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf msg, List<Object> out) throws Exception {
        //解码
        String str = msg.toString(StandardCharsets.UTF_8);

        out.add(str);
    }
}
  1. 第六步,接收到的消息处理类,这个类负责处理,并且消息不再转发到下一级.
/**
 * MsgHandler
 * <p>
 * 释义:
 * 数据转发,得到的string 可以经由该处理器转发出来
 *
 * @author: xinyi.pan
 * @create: 2018-11-28 09:50
 **/
@ChannelHandler.Sharable
public class MsgClientHandler extends ChannelInboundHandlerAdapter {

    String name ;

    public MsgClientHandler(String name) {
        this.name = name;
    }

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {

        String str = (String) msg;
        System.out.println("客户端收到:" + str);
        /**
         *  do any thing ....
         */
        //释放msg
        ReferenceCountUtil.release(msg);
    }

}
/**
 * MsgHandler
 * <p>
 * 释义:
 * 数据转发,得到的string 可以经由该处理器转发出来
 *
 * @author: xinyi.pan
 * @create: 2018-11-28 09:50
 **/
@ChannelHandler.Sharable
public class MsgServerHandler extends ChannelInboundHandlerAdapter {

    String name ;

    public MsgServerHandler(String name) {
        this.name = name;
    }

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        String str = (String) msg;
        System.out.println("服务端收到:" + str);
        ctx.writeAndFlush("服务端返回数据:" + RandomStringUtils.randomAlphabetic(10));
        //释放msg
        ReferenceCountUtil.release(msg);
    }
}
  1. 剩下的就是启动netty.服务端启动
//用于接收网络I/O请求线程池,异步IO
    private static EventLoopGroup bossEventLoop = new NioEventLoopGroup();
    //处理channel的线程池
    private static EventLoopGroup workerEventLoop = new NioEventLoopGroup();


    public static void nettySart() {

        //
        ServerBootstrap nettyBoot = new ServerBootstrap();
        //出站 最后一步,数据分包
        final LengthFieldPrepender prepender = new LengthFieldPrepender(4, true);
        //出站,第一步,将自定义对象:String转化为bytes
        final StringToBytesEncoder encoder = new StringToBytesEncoder();
        //入站第一步:网络包组包,不过这里加入last的时候要new出来,不然回报异常.
        LengthFieldBasedFrameDecoder frameDecoder = new LengthFieldBasedFrameDecoder(Integer.MAX_VALUE, 0, 4, -4, 4);
        //入站,第二步,bytes 转化为自定义的对象:String
        final BytesToStringDecoder decoder = new BytesToStringDecoder();
        //入战,第三步,消息处理,亦可以转发.
        final MsgServerHandler msgServerHandler = new MsgServerHandler("服务端");

        //配置netty服务
        nettyBoot.group(bossEventLoop, workerEventLoop)
                .channel(NioServerSocketChannel.class)
                .option(ChannelOption.SO_BACKLOG, 100)
                .handler(new LoggingHandler(LogLevel.INFO))
                .childHandler(new ChannelInitializer<Channel>() {
                    @Override
                    protected void initChannel(Channel ch) {
                        ChannelPipeline pipeline = ch.pipeline();
                        //入站,1,2,3出站5,4
                        pipeline.addLast(new LoggingHandler(LogLevel.INFO)) //日志打印
                                .addLast("4", prepender)//4 分包,bytes -> http数据包
                                .addLast("5", encoder)//5 //msg -> bytes
                                .addLast("1", new LengthFieldBasedFrameDecoder(1000000, 0, 4, -4, 4))//1,http网络数据包,组包
                                .addLast("2", decoder)//2 //bytes -> msg ,自定义解码
                                .addLast("3", msgServerHandler);//3 //msg -> msg,数据转换,转发数据
                    }
                });
        try {
            //启动netty并监听指定端口,这里是main执行用同步阻塞.也可以用异步.
            ChannelFuture channelFuture = nettyBoot.bind(1765).await();
        } catch (Throwable ex) {
            throw new RuntimeException(ex);
        }

    }

    
    @PreDestroy
    public void close() {
        bossEventLoop.shutdownGracefully();
        workerEventLoop.shutdownGracefully();
    }

7.客户端发送数据

//用于连接和处理网络请求I/O的线程池
    private static NioEventLoopGroup eventLoopGroup;


    public static void startConnect() {
        //关闭检查
        if (eventLoopGroup != null) {
            try {
                eventLoopGroup.shutdownGracefully().sync();
                eventLoopGroup = null;
            } catch (InterruptedException e) {
            }

        }
        //新建
        eventLoopGroup = new NioEventLoopGroup();
        //出站 最后一步,数据分包
        final LengthFieldPrepender prepender = new LengthFieldPrepender(4, true);
        //出站,第一步,将自定义对象:String转化为bytes
        final StringToBytesEncoder encoder = new StringToBytesEncoder();
        //入站,第二步,bytes 转化为自定义的对象:String
        final BytesToStringDecoder decoder = new BytesToStringDecoder();
        //入战,第三步,消息处理,亦可以转发.
        final MsgClientHandler msgClientHandler = new MsgClientHandler("客户端");

        //服务配置
        Bootstrap clientBoot = new Bootstrap();
        clientBoot.group(eventLoopGroup)
                .channel(NioSocketChannel.class)
                .option(ChannelOption.SO_KEEPALIVE, true)
                .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 15 * 1000) // 超时时间
                .option(ChannelOption.TCP_NODELAY, true)
                .handler(new ChannelInitializer<Channel>() {
                    @Override
                    protected void initChannel(Channel ch) throws Exception {
                        ChannelPipeline pipeline = ch.pipeline();
                        //请求日志
                        pipeline.addLast(new LoggingHandler(LogLevel.INFO)) //日志打印
                                .addLast("4", prepender)//out 4
                                .addLast("5", encoder)//out 5
                                .addLast("1", new LengthFieldBasedFrameDecoder(Integer.MAX_VALUE, 0, 4, -4, 4))//in 1
                                .addLast("2", decoder)//in 2
                                .addLast("3", msgClientHandler)//in 3
                        ;
                    }
                });

        try {
            //链接
            ChannelFuture channelFuture = clientBoot.connect("127.0.0.1", 1765).sync();
            Channel channel = channelFuture.channel();
   
            channel.writeAndFlush("啊还是大所大撒所大");

            // 服务器返回结果在 MsgHandler 里面处理
        } catch (Throwable ex) {
        }
    }

    @PreDestroy
    public void close() {
        eventLoopGroup.shutdownGracefully();
    }
  1. 测试,先启动服务端
    public static void main(String[] args) {

        nettySart();

    }
  1. 然后启动客户端
    public static void main(String[] args) {
        startConnect();

        try {
            Thread.sleep(100000000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }finally {
        }
        System.out.println("OK");
    }

10, 查看日志

         +-------------------------------------------------+
         |  0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 24 e6 9c 8d e5 8a a1 e7 ab af e8 bf 94 |...$............|
|00000010| e5 9b 9e e6 95 b0 e6 8d ae 3a 42 69 52 41 4f 67 |.........:BiRAOg|
|00000020| 63 45 70 7a                                     |cEpz            |
+--------+-------------------------------------------------+----------------+
客户端收到:服务端返回数据:BiRAOgcEpz
L:/127.0.0.1:1765 - R:/127.0.0.1:52226] READ: 31B
         +-------------------------------------------------+
         |  0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 1f e5 95 8a e8 bf 98 e6 98 af e5 a4 a7 |................|
|00000010| e6 89 80 e5 a4 a7 e6 92 92 e6 89 80 e5 a4 a7    |............... |
+--------+-------------------------------------------------+----------------+
服务端收到:啊还是大所大撒所大
11:34:19.663 [nioEventLoopGroup-3-1] INFO io.netty.handler.logging.LoggingHandler - [id: 0x29ed7f41, L:/127.0.0.1:1765 - R:/127.0.0.1:52226] WRITE: 4B
         +-------------------------------------------------+
         |  0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 24                                     |...$            |
+--------+-------------------------------------------------+----------------+

另外:附一个自己的基github地址:于netty开发的rpc

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

推荐阅读更多精彩内容