使用 Java 语言基于 Netty 自己动手实现一个极简 web 框架

quasiceo 2018-09-04

展开全文

这是一个创建于 132 天前的主题，其中的信息可能已经有所发展或是发生改变。

上节课我们自己动手制作了一个 RPC 框架，本节课我们挑战一个稍有难度的一点的任务，手动制作一个 Web 框架。我不太愿意叫什么 MVC 框架，因为我在制作这个小项目的时候可没想过它要怎么怎么的 MVC，一切皆以易于使用为目标。

首先我们看看这个 Web 框架使用起来如何简单

Hello World

import httpkids.server.KidsRequestDispatcher;
import httpkids.server.Router;
import httpkids.server.internal.HttpServer;

public class HelloWorld {

    public static void main(String[] args) {
        var rd = new KidsRequestDispatcher("/kids", new Router((ctx, req) -> {
            ctx.html("Hello, World");
        }));
        new HttpServer("localhost", 8080, 2, 16, rd).start();
    }

}

http://localhost:8080/kids

KidsRequestDispatcher是请求派发器，用于将收到的 HTTP 请求对象扔给响应的RequestHandler进行处理。 Router用于构建路由，它负责的是将 URL 规则和RequestHandler挂接起来，形成一个复杂的映射表。

Router为了简化实现细节，所以没有支持复杂的 URL 规则，例如像RESTFUL这种将参数写在 URL 里面的这种形式是不支持的。

HttpServer是 Web 服务器的核心对象，构建 HttpServer 除了 IP 端口之外，还需要提供 3 个关键参数，分别是 IO 线程数、业务线程数和请求派发器对象。IO 线程用于处理套件字读写，由 Netty 内部管理。业务线程专门用于处理 HTTP 请求，由 httpkids 框架来管理。

一个全面的例子

import java.util.HashMap;

import httpkids.server.KidsRequestDispatcher;
import httpkids.server.Router;
import httpkids.server.internal.HttpServer;

public class HelloWorld {

    public static void main(String[] args) {
        var router = new Router((ctx, req) -> {
            ctx.html("Hello, World"); // 纯文本网页
        }).handler("/hello.json", (ctx, req) -> {
            ctx.json(new String[] { "Hello", "World" });  // json api
        }).handler("/hello", (ctx, req) -> {
            var res = new HashMap<String, Object>();
            res.put("req", req);
            ctx.render("playground.ftl", res);  // 模版渲染
        }).handler("/world", (ctx, re) -> {
            ctx.redirect("/hello");  // 302 跳转
        }).child("/user", () -> {  //  URL 嵌套
            return new Router((ctx, req) -> {
                ctx.html("Hello, World");
            }).handler("/hello.json", (ctx, req) -> {
                ctx.json(new String[] { "Hello", "World" });
            }).handler("/hello", (ctx, req) -> {
                var res = new HashMap<String, Object>();
                res.put("req", req);
                ctx.render("playground.ftl", res);
            }).handler("/world", (ctx, re) -> {
                ctx.redirect("/hello");
            }).filter((ctx, req, before) -> {  // 请求过滤器、拦截器
                if (before) {
                    System.out.printf("before %s\n", req.path());
                } else {
                    System.out.printf("after %s\n", req.path());
                }
                return true;
            });
        }).resource("/pub", "/static");  // 静态资源

        var rd = new KidsRequestDispatcher("/kids", router);
        rd.templateRoot("/tpl"); // 模版所在的 classpath 目录

        var server = new HttpServer("localhost", 8080, 2, 16, rd);
        server.start();
        
        // 优雅停机
        Runtime.getRuntime().addShutdownHook(new Thread() {

            public void run() {
                server.stop();
            }

        });
    }

}

http://localhost:8080/kids
http://localhost:8080/kids/hello
http://localhost:8080/kids/hello.json
http://localhost:8080/kids/world
http://localhost:8080/kids/user
http://localhost:8080/kids/user/hello
http://localhost:8080/kids/user/hello.json
http://localhost:8080/kids/user/world
http://localhost:8080/kids/pub/bootstrap.min.css