手寫Netty版本的簡易tomcat以及實現部分SpringMVC功能

手寫Netty版本的簡易tomcat以及實現部分SpringMVC功能

實現思路

1. 首先加載配置文件。
2. 將配置文件中的掃描包進行位置掃描
   1. 解析類結構
   2. 根據註解將URL以及實例信息進行關聯
3. 構建一個Netty的服務端，負責阻塞接收客戶端傳遞過來的請求。
4. 服務端接收到的請求需要解析成對應的Request。
5. 根據得到解析的Request信息中的URL去匹配第一步加載到的Servlet，反射觸發，執行後續的業務邏輯。
6. 處理完業務邏輯之後，將返回結果封裝成Response。
7. 返回給客戶端。

這裏一共有幾個關鍵步驟:

1. 服務端接收請求      ->      NettyTomcatServer
2. 將請求解析成Request。->  Request
3. 根據Request轉發Servlet。-> DispatchServletHandler
4. 處理業務之後，將返回值轉換成Response。 -> Response
5. 返回客戶端

代碼實現

路徑 : com.lkx.code.netty.tomcat

啓動類: NettyTomcatServer

模擬路由:

GET - http://localhost:8080/get/query
POST - http://localhost:8080/post/query
{
    "name":"lkx"
}

解析配置文件

WebConfiguration

  private Properties webXml = new Properties();
private Map<String, String> configMap = new HashMap<>();

/**
* 解析配置文件，並將解析完成的配置文件關係綁定到servletMapping中
*/
public void init() {
    //加載web.xml文件,同時初始化 ServletMapping對象
    try {
        String WEB_INF = this.getClass().getResource("/").getPath();
        FileInputStream fis = new FileInputStream(WEB_INF + "web.properties");

        webXml.load(fis);

        for (Object k : webXml.keySet()) {

            configMap.put(k.toString(), webXml.getProperty(k.toString()));
            //                String key = k.toString();
            //                if (key.endsWith(".url")) {
            //                    String servletName = key.replaceAll("\\.url$", "");
            //                    String url = webXml.getProperty(key);
            //                    String className = webXml.getProperty(servletName + ".className");
            //                    HttpServlet obj = (HttpServlet) Class.forName(className).newInstance();
            //                    servletMapping.put(url, obj);
            //                }
        }
    } catch (Exception e) {
        e.printStackTrace();
    }
}

public Map<String, String> getConfigMap() {
    return configMap;
}

啓動服務監聽，來接收客戶端請求。

NettyTomcatServer

/**
 * 開啓Netty的服務端，負責接收請求數據
 */
public void start() throws IOException {
    // 1. 解析配置
    webConfiguration.init();
    // 2. 根據配置掃描servlet,並註冊
    scan();
    // 3. 啓動服務
    startServer();
}

由於使用了Netty的HttpRequestDecoder進行解碼，所以解析Request請求就省略了。

實際上就是讀到客戶端傳遞過來的流解析成文本，然後根據scan掃描到的類信息得到入參class，然後通過json轉換成入參class，後續反射調用。

然後將請求通過handler進行轉發給業務類。

DispatchServletHandler

@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
    if (msg instanceof FullHttpRequest) {
        FullHttpRequest req = (FullHttpRequest) msg;
        // 轉交給我們自己的request實現
        Request request = new Request(ctx, req);
        // 轉交給我們自己的response實現
        Response response = new Response(ctx, req);
        // 實際業務處理
        String url = request.getUrl();
        logger.info("URL : " + url + " 開始與servletMapping進行匹配  ");
        ServletDefinition servletDefinition = servletFactory.getServlet(url);
        String jsonString = getJSONString(req);
        if (servletDefinition != null) {
            logger.info(" 匹配成功！ 執行業務邏輯類:" + servletDefinition.toString());
            Class clazzServlet = servletDefinition.getServlet();
            Method method = servletDefinition.getMethod();
            Class requestClass = servletDefinition.getRequestClass();
            Object requestBody = JSON.parseObject(jsonString, requestClass);
            Object servlet = servletFactory.getObject(clazzServlet);
            Object responseBody = null;
            if (requestClass == null) {
                responseBody = ReflectUtil.invoke(servlet, method, null);
            } else {
                responseBody = ReflectUtil.invoke(servlet, method, requestBody);
            }
            logger.info(" 執行完成 .. " + responseBody);
            // 處理完成，將結果返回給客戶端。
            response.write(responseBody);
        } else {
            logger.info(" URL : " + url + " 匹配失敗!");
            response.write("404 - Not Found");
        }
    }
}

業務處理完成了之後，將返回值進行包裝，返回給客戶端

Response

public void write(String out) throws Exception {
        try {
            if (out == null || out.length() == 0) {
                return;
            }
            // 設置 http協議及請求頭信息
            FullHttpResponse response = new DefaultFullHttpResponse(
                    // 設置http版本爲1.1
                    HttpVersion.HTTP_1_1,
                    // 設置響應狀態碼
                    HttpResponseStatus.OK,
                    // 將輸出值寫出 編碼爲UTF-8
                    Unpooled.wrappedBuffer(out.getBytes("UTF-8")));

            response.headers().set("Content-Type", "text/html;");
            ctx.write(response);
        } finally {
            ctx.flush();
            ctx.close();
        }
    }

另外仿照SpringMVC的Controller

PostServlet

@Controller
@RequestMapping("/post")
public class PostServlet {


    private Logger logger = LoggerFactory.getLogger(PostServlet.class);

    @RequestMapping(value = "/query", method = RequestMethod.POST, produces = "application/json;charset=UTF-8")
    public Map<String, String> query(JSONObject jsonObject) {
        logger.info(" 獲取到的數據 : " + jsonObject.toJSONString());

        Map<String, String> map = new HashMap<>();
        map.put("success", "true");
        map.put("date", DateUtil.formatDateTime(new Date()));
        return map;

    }

}

以上詳細代碼地址

以上僅供學習練手，如有錯誤，請指正！共同進步。