2011年1月31日 星期一

用Java寫一個簡單的Web Server

Java的生產力很高,拿它來寫個簡單的Web Server只需要不到200行的程式碼,底下就用Java一步一步實作一個簡單的HTTP網頁伺服器。

;

在開始前,需要對HTTP協定有一個基本的認識,在我們這個例子裡面,只需要知道GET請求(Request)即可。

當我們在瀏覽器的網址列輸入一個位址時,瀏覽器會送出一個GET請求到位址欄裡指定的網頁伺服器,去跟這個網頁伺服器取得網頁或檔案的內容。

例如,我們在網址列輸入 http://www.google.com.tw/,就是向www.google.com.tw這台伺服器要求一個檔案,而要求的檔案就是首頁(/)。

這個動作,瀏覽器會送出如下的HTTP請求命令到伺服器去 (以Chrome為例):

GET / HTTP/1.1
Host: www.google.com.tw
Connection: keep-alive
Cache-Control: max-age=0
Accept: application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,i
mage/png,*/*;q=0.5
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/534.10 (
KHTML, like Gecko) Chrome/8.0.552.237 Safari/534.10
Accept-Encoding: gzip,deflate,sdch
Accept-Language: zh-TW,zh;q=0.8,en-US;q=0.6,en;q=0.4
Accept-Charset: Big5,utf-8;q=0.7,*;q=0.3
<注意,這裡還有一個空行,表示結束>

這裡的重點是第一行和最後一行。

由第一行,伺服器可以知道Client作的是那一種類的請求,這裡可以明顯的看到Client(Chrome)作了一個GET請求。同時,在第一行裡面也可以知道Client請求的是什麼。在此例中,可以看到Client請求的是/這個檔案。在第一行最後的部份,則是註明HTTP協定的版本號。

而最後一行,是一個空行,表示請求包的結束。伺服器在收到一個請求時,從第一行的請求命令開始,一直讀取到一個空行為止,為一個完整的封包。除了第一行和最後一行,對我們的簡單伺服器來說,中間的部份可以全都忽略不看。

伺服器收這個GET請求後,假如可以找到到指定的檔案,接下來就會把Client請求的檔案內容回傳,使用的格式如下:

HTTP/1.0 200 OK
Content-Type: text/html
Content-Length:
<注意,這裡還有一個空行,表示結束>
<接下來,這裡開始都是檔案資料內容,總長度為Content-Length所指定的數字>

否則回傳我們常見的404 Not Found錯誤,如下:

HTTP/1.0 404 File Not Found
<注意,這裡還有一個空行,表示結束>

有了以上這些知識後,就足夠我們寫個簡單的網頁伺服器。

;

考慮到因為每一個Client的請求,都是在發出時才和伺服器建立連線,完成後就立即切斷連線。所以在設計上,我們可以用多緒(multi-thread)的方法,每一個請求都用一個獨立的執行緒來處理,處理完成後切斷連線,同時也結束這個執行緒。

根據這個想法,很直接的就可以寫出如下的基本框架來:

public class SimpleWebServer implements Runnable {

 ServerSocket server = null ;

 public static void main(String args[]) throws Exception {
  new SimpleWebServer(80);
 }

 public SimpleWebServer(int port) throws Exception {
  server = new ServerSocket(port) ;
  run();
 }

 public void run() {

  try {

   //
   // 1, 等待一個新的連接請求(Request).
   //

   Socket s = server.accept();

   //
   // 2, 開新Thread處理新連接請求.
   //

   Thread task = new Thread(this);
   task.start();

   //
   // 3, 處理請求內容.
   //
   
   handleRequest(...);
  }
}
如上,在進入點main我們開了一個SimpleWebServer,給它一個80的port number(80是HTTP的port number)。SimpleWebServer的Constructor會建立一個ServerSocket的實體,然後啟動主執行緒。執行緒的主體非常簡單,它只作三件事情。
  1. 等待一個新的請求連線進來。
  2. 開啟一個新的執行緒繼續等待下一個新的連線請求進來。
  3. 處理這個請求。
完成這三件事情後,這條連線被關閉,執行緒結束。

以上的部份,已經是一個可以執行的最簡易版伺服器,差別只在於它完全不處理作任事。接下來,我們再把最後處理請求的部份完成。

;

void handleRequest(Socket s, BufferedReader reader, DataOutputStream os) throws Exception {

 try {

  //
  // 1, 讀取HTTP Header字串.
  //

  //
  // 2, 解出請求的資源路徑.
  //

  //
  // 3, 處理請求的資源.
  // (測試: 只處理Homepage的請求)
  //

  if ("/".equals(path) || "index.html".equals(path)) {
   String homepage = "Hello Simple Web Server";
   os.writeBytes(
     "HTTP/1.0 200 OK\r\nContent-Type: text/html\r\nContent-Length: " +
     homepage.length() +
     "\r\n\r\n" +
     homepage);

   return;
  }

  os.writeBytes("HTTP/1.0 404 File Not Found\r\n\r\n");
 } catch (Exception e) {
  os.writeBytes("HTTP/1.0 500 Internal Server Error\r\n\r\n");
 }
}
處理請求的部份也是分為三個步驟:
  1. 讀出HTTP請求內容。
  2. 從讀出的HTTP請求裡,取出請求的檔案名稱路徑。
  3. 傳送請求的檔案內容。
因為我們只實作一個最簡單的網頁伺服器,所以只處埋Homepage的請求。如果Client要求的是首頁,就回傳首頁的內容,這邊只回傳一個簡單的字串"Hello Simple Web Server"表示首頁。否則回傳找不到檔案的錯誤404 Not Found。其它狀況,則回傳伺服器錯誤500的錯誤碼。(更多的錯誤碼可以在這裡找到。)


完整的原始程式碼,在這裡下載。

沒有留言:

張貼留言

Related Posts Plugin for WordPress, Blogger...