Netty挖掘机(三)结合Spring搭建Netty脚手架

上文《Netty挖掘机(二)初识Netty》,主要介绍了Netty的特性及其如何启动,启动的相关配置说明。这一篇主要讲一下如何结合Spring搭建Netty脚手架,实现API接口服务模块。

结合Spring依赖注入的特性,在Netty的handler中获取上下文的bean,再通过uri找到匹配的方法。

maven pom配置

主要引入了Netty、Spring的依赖, 及其日志框架logback,很简单。

封装请求体

@Data
public class ApiReq {
    /**
     * HTTP protocol
     */
    private String protocol;
    /**
     * ip
     */
    private String remoteIp;
    /**
     * request type
     */
    private String method;
    /**
     * request uri
     */
    private String uri;
    /**
     * request headers
     */
    private Map<String, String> headers;
    /**
     * request data
     */
    private Map<String, String> data = Maps.newHashMap();
    private String controllerName;
    private String invokeMethodName;
    public String getParam(String key) {
        return data.get(key);
    }
}

封装返回体

@Data
@Slf4j
public class ApiResp implements Serializable {

    private static final long serialVersionUID = -8826517176378050058L;
    private int result = 0;
    private String msg;
    private String data;
    public ApiResp() {}

    public static ApiResp create(String data){
        ApiResp ret = new ApiResp();
        ret.setMsg("success");
        ret.setData(data);
        return ret;
    }
}

定义Controller的基类,用于后续反射调用派生类方法

public class ApiController {
    public ApiResp invoke(String invokeMethodName, ApiReq req)  {
        try {
            Method method = getClass().getMethod(invokeMethodName, req.getClass());
            ApiResp result = (ApiResp) method.invoke(this, req);
            return result;
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        }
        return null;
    }
}

定义一个功能类

用户功能类,这里只列出一个方法,返回简单的文字描述信息。

public class UserController extends ApiController {
    public ApiResp get(ApiReq req) {
        return ApiResp.create("my name is " + req.getParam("name"));
    }
}

实现一个Netty 启动类

回顾一下上文讲到的启动类,其实启动类对外透明化,只要很简单的几行代码,就帮我们实现了很多配置,甚至有更多的透明化配置等着我们去使用。

@Slf4j
public class HttpServer {
    private AbstractControllerAdapter controllerAdapter;
    public HttpServer(AbstractControllerAdapter controllerAdapter) {
        this.controllerAdapter = controllerAdapter;
    }
    static EventLoopGroup boss = new NioEventLoopGroup();
    static EventLoopGroup worker = new NioEventLoopGroup();
    public void start(int port) {
        log.info("############# start server at port: {}... #############", port);
        try {
            ServerBootstrap bootstrap = new ServerBootstrap();
            bootstrap
                // 绑定两个组
                .group(boss, worker)
                // 创建NioServerSocketChannel实例
                .channel(NioServerSocketChannel.class)
                // 添加处理器Handler
                .childHandler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel channel) throws Exception {
                        // 为通道Channel进行初始化配置
                        ChannelPipeline pipeline = channel.pipeline();
                        pipeline.addLast(new HttpRequestDecoder(),
                                new HttpResponseEncoder(),
                                new HttpServerHandler(controllerAdapter)
                        );
                    }
                })
                // 服务于boss线程(accept connect)
                .option(ChannelOption.SO_BACKLOG, 1024)
                // 设置关闭tcp的Nagle算法(尽可能发送大块数据,避免网络中充斥着许多小数据块),要求高实时性
                .childOption(ChannelOption.TCP_NODELAY, true)
                // 设置启用心跳保活机制
                .childOption(ChannelOption.SO_KEEPALIVE, true);
            bootstrap.bind(port).sync();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

其中在初始化配置中,可以看到主要配置了三个

  • HttpRequestDecoder:将字节解码为HttpRequest、HttpContent和LastHttpContent消息;

  • HttpResponseEncoder:将HttpResponse、HttpContent和LastHttpContent消息编码为字节;

  • HttpServerHandler:服务中转站,下面会提到。

服务中转站

中转,即是一个协同者的角色,提供一个handler,拦截请求以执行入站和出战事件。

ChannelHandler是Netty中处理器的抽象,Netty对其提供了很多种可以开箱即用的实现,包括运用于各种协议(如HTTP SSL)的ChannelHandler,在内部也使用了事件和Future。

在这里我们用了其中的一个实现ChannelInboundHandlerAdapter来拦截和处理事件。其中涉及到Netty中对HTTP的执行流程的一个封装。

full_http.jpg

以上是一次完整的Http请求,HttpRequest是请求的第一部分,包含Http头部信息;HttpContent是请求中存放数据的块体,不止一个;LastHttpContent标志请求的结束,也包含数据,也可能包含尾随的Http头部信息。

按照这种顺序,接下来实现通过一次完整的Http请求获取数据

@Slf4j
public class HttpServerHandler extends ChannelInboundHandlerAdapter {
    private AbstractControllerAdapter adapter;
    private ApiReq req;
    public HttpServerHandler(AbstractControllerAdapter adapter) {
        this.adapter = adapter;
    }
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        long startTime = System.currentTimeMillis();
        try {
            if(msg instanceof HttpRequest) {
                HttpRequest request = (HttpRequest) msg;
                req = ApiReq.decode(request);
            } else if(msg instanceof LastHttpContent) {
                String controllerName = req.getControllerName();
                HttpContent content = (HttpContent) msg;
                Map<String, String> data = req.parseData(content);
                req.setData(data);
                FullHttpResponse response = ApiResp.response(adapter, req);
                ctx.write(response);
            }
        } finally {
            ReferenceCountUtil.release(msg);
        }
    }
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        super.channelReadComplete(ctx);
        try {
            ctx.channel().flush();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        super.exceptionCaught(ctx, cause);
    }
}

到这里,基于Spring+Netty实现的API框架已成功搭建好了哈。

具体源码请查看github:

https://github.com/qJerry/Netty-Analyze-Demo/tree/master/Chapter1-2


Ending......

阿黑在下一章节将结合SpringBoot搭建Netty脚手架...!

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

推荐阅读更多精彩内容