Java 實現一個基於 NIO 的多線程Web服務器


代碼地址:https://github.com/yuanyb/webserver

實現了

  • 靜態、動態資源獲取;

  • Cookie、Session、HTTP 長連接,及 Session 和 HTTP 長連接的定時清除;

  • 類似 Spring MVC 的注解式編程,如 @RequestMapping @RequestParam 等,方法中可以根據參數名從前台獲取數據,可以傳遞對象,也支持級聯屬性,如:

    // GET /page?pageSize=10&pageNum=1 HTTP/1.1
    @RequestMapping("/page")
    String page(@RequestParam(value="pageSize", defaultValue="10") Integer pageSize, Integer pageNum) {...}
    
    /**
     * POST /login HTTP/1.1
     * ...
     * user.name=admin&user.passwd=admin&user.data.val=ok
     * *******
     * User 類:String name; String passwd; Data data;
     * Data 類: String val;
     */
    @RequestMapping("/login", method = HttpMethod.POST)
    String login(User user) {...}
  • 方法可以返回一個字符串表示模板路徑,模板使用正則實現,僅可以從 request 和 session 域中獲取屬性值,如 ${request.user.id}

  • 日志記錄(使用 java.util.logging 內置日志記錄器,自定義了日志格式):服務器運行相關日志(server-n.log),HTTP 請求日志(access-n.log)。

API 匯總:

@Controller
@RequestMapping
@RequestParam
@RequestHeader
@CookieValue
HttpRequest
HttpResponse
HttpSession
Cookie
HttpMethod

 

類結構

  • webserver.BootStrap:啟動類,讀取配置文件,初始化日志記錄器,並啟動 webserver.connector.Server 類

  • webserver.connector:存放與網絡連接相關的類

    • Server:初始化服務器的各個組件

    • Acceptor:監聽客戶端的連接請求,並將連接放入Poller中進行請求監聽,守護線程

    • Poller:保存與客戶端的Socket連接,監聽客戶端的請求,多個守護線程

    • SocketWrapper:客戶端 SocketChannel 的包裝器,封裝了一些方法

    • RequestProcessor:請求處理器,將請求放入內部的線程池中處理

    • ExpiredConnectionCleaner:清理長時間為傳輸數據的Socket(HTTP長連接的定時清除)

  • webserver.container:存放容器類及相關的一些類和注解

    • annotation:存放注解

    • Container:容器類,保存 HttpSession 和 控制器中的響應方法,包含HttpSession的創建獲取銷毀的方法,對傳過來的 HttpRequest 找到對應的響應方法執行

    • TargetMethod:對控制器中的響應方法的封裝

    • ControllerScanner:掃描 classpath 下被 @Controller 注解標記的控制器類

  • webserver.http:存放與HTTP相關的類

    • request.HttpRequest

    • request.HttpRequestParser:從請求數據中解析出 HttpRequest

    • response.HttpResponse

    • response.HttpStatus

    • session.HttpSession

    • session.ExpiredSessionCleaner:清理過期的HttpSessin

    • Cookie

    • HttpMethod

  • webserver.template:模板
    • TemplateParser:解析模板,並將數據寫入 HttpResponse
  • webserver.constant:存放一些常量

    • ...

  • webserver.exception:自定義異常

    • ...

  • webserver.util:工具類

    • ...

 

使用方法

導入 jar 包(見 release)即可使用相關注解,還需要在 classpath 下創建一個 webapp 目錄,表示靜態 web 資源的根路徑。然后在主類的 main 方法中調用 BootStrap.run(),由於掃描控制器是通過遍歷目錄實現的,所以項目不支持打包,必須以 class 文件的形式發布。參數配置需要在 classpath 中提供一個 server-config.properties 配置文件即可,包含如下配置項:

# 服務器端口
PORT=80
# 存儲日志文件的路徑
LOG_FILE_STORAGE_PATH=E:\\
# 連接過期時間,單位毫秒
CONNECTION_EXPIRY_TIME=30000
# 清理過期連接的周期,單位毫秒
CONNECTION_CLEANING_CYCLE=30000
# Session 過期時間,單位毫秒
SESSION_EXPIRY_TIME=30000
# 清理過期 Session 的周期,單位毫秒
SESSION_CLEANING_CYCLE=30000
# 監聽客戶端讀事件的線程數目
POLLER_THREAD_COUNT=2
# 處理具體請求的線程池的大小
REQUEST_PROCESSOR_THREAD_COUNT=4

  

演示

  • 項目結構

image-20200311225337531

  • EchoController.java

    package com.test;
    
    // 導包省略...
    
    @Controller // 只有被 @Controller 標記的才會被認為是控制器
                // 支持在類上使用 @RequestMapping 注解,
    public class EchoController {
    
        // 線程安全
        private static final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
    
        @RequestMapping("/echo") // 映射到 "/echo"
        public String echo(HttpRequest request, @RequestParam(value = "msg", defaultValue = "輸入為空") String msg) {
    
            LocalDateTime localDateTime = LocalDateTime.ofEpochSecond(request.getSession().getLastAccessedTime() / 1000, 0, ZoneOffset.ofHours(8));
            request.setAttribute("lastAccessedTime", localDateTime.format(formatter));
            request.setAttribute("msg", msg);
            return "test.html"; // 要渲染的的模板路徑(classpath:webapp/test.html)
        }
    
        public static void main(String[] args) {
            BootStrap.run();
        }
    }
  • test.html

    <!DOCTYPE>
    <html lang="en">
        <head>
            <title>Test</title>
        </head>
        <body>
            <p>Echo: ${request.msg}</p>
            <p>Last Accessed Time: ${request.lastAccessedTime}</p>
            <p><img src="img/girl.jpg" alt="girl" width="320" height="480"/></p>
        </body>
    </html>
  • 效果

    image-20200311230536372
  • 日志

    image-20200311230911751 image-20200311230942940


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM