Netty学习笔记--1(使用Netty搭建一个基于Http协议的服务)

0.what is Netty?

简单来说,Netty是异步的,事务驱动的,高性能的NIO框架
Netty官网
其中有详细的netty介绍,刚开始学习,有什么不对,欢迎指出。

1.Netty中几个比较重要的概念

1.0 Handler

Handler其实就是事件的处理器,Netty通过Channel读入请求内容后会分配给Handler进行事件处理,Handler能够处理的事件包括:数据接收,异常处理,数据转换,编码解码等问题,其中包含两个非常重要的接口ChannelInboundHandler,ChannelOutboundHandler,前者负责处理客户端发送到服务端的请求,后者反之。关于Handler执行顺序的一些介绍可以看一看这篇文章: handler的执行顺序
在这个地方有一个值得注意的点,无论是InboundHandler还是OutboundHandler都不适合用于做耗时操作,官方要求耗时操作应当使用单独的EventExcutorGroup+专门的Handler来进行操作

static final EventExecutorGroup group = new DefaultEventExecutorGroup(16); 
... 
ChannelPipeline pipeline = ch.pipeline(); 
pipeline.addLast("decoder", new MyProtocolDecoder()); pipeline.addLast("encoder", new MyProtocolEncoder()); 
// Tell the pipeline to run MyBusinessLogicHandler's event handler methods 
// in a different thread than an I/O thread so that the I/O thread is not blocked by 
// a time-consuming task. 
// If your business logic is fully asynchronous or finished very quickly, you don't 
// need to specify a group. 
pipeline.addLast(group, "handler", new MyBusinessLogicHandler());

1.1 Channel

这里的Channel的概念和NIO中Channel的概念是一样的,相当于一个Socket连接

1.2 Bootstrap

Bootstrap其实就是Netty服务的启动器,服务端使用的是ServerBootstrap,客户端使用的是Bootstrap,我们可以通过配置Bootstrap来配置Netty使用哪种的Channel,Group,Handler和Encoder,Decoder……

1.3 LoopGroup

一个LoopGroup可以包含多个EventLoop,我目前的理解是将其理解为一个线程池,其中的EventLoop为其中的线程

1.4 ChannelFuture

这点在官方的Guide中也有提到,在Netty中,所有的处理都是异步的,因此需要一个Future对象,可以注册监听在异步线程处理完以后进行一些处理

2.HelloWorld

2.0 Server端代码

public class Server{

    public void start(int port) throws InterruptedException {
        EventLoopGroup bossGroup = new NioEventLoopGroup();
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        EventExecutorGroup bussinessGroup = new DefaultEventExecutorGroup(16);
        try {
            ServerBootstrap b = new ServerBootstrap();
            b.group(bossGroup, workerGroup)
                     //使用哪一种Channel
                    .channel(NioServerSocketChannel.class)
                    .childHandler(new ChannelInitializer<SocketChannel>() {
                        @Override
                        protected void initChannel(SocketChannel ch) throws Exception {
                            //添加http请求所需要的编码器与解码器
                            ch.pipeline().addLast(new HttpResponseEncoder());
                            ch.pipeline().addLast(new HttpRequestDecoder());
                            //ch.pipeline().addLast(new ServerOutboundHandler()); //如果存在OutboundHandler则必须在最后一个inbound前面
                            ch.pipeline().addLast(new ServerHandler());
                            //耗时操作使用的group和专门的handler
                            ch.pipeline().addLast(bussinessGroup, "handler", new BusinessHandler());
                        }
                    })
                    .childOption(ChannelOption.SO_KEEPALIVE, true);
            ChannelFuture f = b.bind(port);
            f.channel().closeFuture().sync();
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }

    public static void main(String[] args) throws InterruptedException {
        Server server = new Server();
        server.start(8090);
    }

}

2.1 ServerHandler

public class ServerHandler extends ChannelInboundHandlerAdapter {

    private HttpRequest request;
    private HttpContent content;
    private FullHttpResponse response;
    private StringBuilder sb = new StringBuilder();

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

        if (msg instanceof HttpRequest) {
            request = (HttpRequest) msg;
            System.out.println(request.uri());
            System.out.println("request received success");
            sb.append("request received success \n");
        }
        if (msg instanceof HttpContent) {
            content = (HttpContent) msg;
            ByteBuf buf = content.content();
            String result = buf.toString(CharsetUtil.UTF_8);
            System.out.println(result);
            buf.release();
            System.out.println("content received success");
            sb.append("content received success");
            response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK, Unpooled.wrappedBuffer(sb.toString().getBytes()));
            ctx.writeAndFlush(response);
        }
    }

    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        ctx.close();
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        HttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.BAD_GATEWAY);
        ctx.writeAndFlush(response);
        ctx.close();
    }
}

3. 请求服务器

3.0 使用postman来请求服务器

postman访问netty服务器

我使用post方式随意发送了任意内容到服务器,能够得到返回内容,并且idea控制台输出如下,表明可以获得postman发送的数据

idea控制台输出内容

3.1 使用NettyClient访问Netty服务器

3.1.0 Client

public class Client {

    public static void main(String[] args) throws InterruptedException {
        EventLoopGroup group = new NioEventLoopGroup();
        try {
            Bootstrap b = new Bootstrap();
            b.group(group)
                .channel(NioSocketChannel.class)
                .option(ChannelOption.SO_KEEPALIVE, true)
                .handler(new ChannelInitializer<SocketChannel>() {
                @Override
                protected void initChannel(SocketChannel ch) throws Exception {
                    ch.pipeline().addLast(new HttpClientCodec());
                    ch.pipeline().addLast(new ClientHandler());
                }
            });
            ChannelFuture f = b.connect("127.0.0.1", 8090).sync();
            Channel ch = f.channel();
            FullHttpRequest request = new DefaultFullHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.POST, "http://127.0.0.1:8090", Unpooled.wrappedBuffer("{ \"test\" : \"test\" }".getBytes()));  //发送请求道服务端
            request.headers().set(HttpHeaderNames.CONTENT_TYPE, HttpHeaderValues.APPLICATION_JSON);
            request.headers().set(HttpHeaderNames.CONTENT_LENGTH, 1024);  //必须设置Content length否则服务端收不到content
            System.out.println(request.content().toString(CharsetUtil.UTF_8));
            ch.writeAndFlush(request);
            //wait until server to close the connection
            ch.closeFuture().sync();
        }finally {
            group.shutdownGracefully();
        }
    }

}

3.1.1 ClientHandler

public class ClientHandler extends ChannelInboundHandlerAdapter {

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        HttpContent content;
        HttpResponse response;
        if (msg instanceof HttpResponse) {
            response = (HttpResponse) msg;
            System.out.println(response.status().toString());
        }

        if (msg instanceof HttpContent) {
            content = (HttpContent) msg;
            ByteBuf buf = content.content();
            String responseContent = buf.toString(CharsetUtil.UTF_8);
            System.out.println(responseContent);
            buf.release();
        }
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }
}

以上代码也能获得和postman访问相同的效果

4.其中思考的问题

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • netty常用API学习 netty简介 Netty是基于Java NIO的网络应用框架. Netty是一个NIO...
    花丶小伟阅读 5,987评论 0 20
  • 本文是Netty文集中“Netty 源码解析”系列的文章。主要对Netty的重要流程以及类进行源码解析,以使得我们...
    tomas家的小拨浪鼓阅读 5,840评论 9 12
  • 一场秋雨,将弥漫的尘雾一扫而空。 碧空万里,书写的不光是夏日的澄澈 行走在秋的环视中,是增添秋的美还是享受秋的吻?...
    沙漠里的胡杨v阅读 299评论 0 2
  • 周末,早饭很迟。 不忍心叫醒正在熟睡的儿子。 早已做好的早餐就只等儿子起来用餐了。餐桌上摆好了儿子喜欢吃的饭菜,牛...
    薛静春阅读 262评论 2 1