Yoyo的雜記: 2018/10

工作上的系統，架構常用到micro-service，建立這些服務，常常都需要自己架構出需要的服務元件。常讀到Spring Boot的介紹，對它的自動化很好奇，趁著有個小空檔來試作一下。

試作目標：

支援 static resources
支援 servlets (HTTP request handler)，收到request後，可根據client的資訊作回應
嵌入Tomcat或Jetty

使用環境：Eclipse 2018-09

安裝 Spring Tools
進入Eclipse後，點選 Help | Eclipse Marketplace...
以 "spring tool" 就可找到 Spring Tools 4，點選Install即可安裝

建立 project
我們利用剛剛安裝的Spring Tools提供的工具來建立Spring Boot專案。
首先在主選單點選 File | New | Other...

選擇 Spring Boot | Spring Starter Project，然後進入Next

接下來要設定專案的相關資訊了，雖然事後都還可以調整，不過一開始就先設定好，後面可以省些事

幾個比較重要的欄位：

Name (專案名稱)，這預設會連動到下面的Artifact ID
Type, Java Version, Language都使用預設，Packaging有Jar與War，看未來想打包成何種形式，可以在pom.xml中改變
Group (Group ID) 用來識別此專案的名稱 (可參考這裡)，可以在pom.xml中改變
Artifact (Artiface ID)在未來產生Jar file時會用到這名稱，可以在pom.xml中改變
Version用來記錄版本，在未來產生Jar file時會用到，可以在pom.xml中改變
Description用來對這個專案作一個描述，可以在pom.xml中改變
Package則是建立程式時預設的package架構

接下來就要選擇專案需要的dependent libraries了，例如若專案需要用到PostgreSQL的JDBC driver，就可以直接勾選，Maven就會自動幫你下載了。
目前試作的專案只需要Web，所以就勾選Web即可。

點選Finish，Spring Tool就開始幫我們產生專案了。

Spring Tool幫我們產生了一個程式 GreetingApplication.java。這程式的內容很簡單，就只是啟動Spring Boot的應用

建立靜態網頁
靜態網頁與相關資源(js, css, etc.) 可以放在src/main/resources/static下。在此專案我們就放一個簡單的網頁。

page.html


<!DOCTYPE html>

<html>

<head>

<meta charset="utf-8">

<title>Welcome</title>

<link href="css/page.css" rel="stylesheet" type="text/css" />

</head>

<body>

 <h1>Hello, welcome to static page.</h1>

</body>

</html>

page.css


h1 {

 color: #ff7777;

 font-style: italic;

}

建立Servlet (request handler)
接下來我們要進行動態回應的部分。我們列出需求：

當使用者以POST或GET連結到 http://:8080/func時，則會由此handler來處理
如果request parameter有name，我們就回覆 Hello, !，如果沒有name，則回覆 Hello, world!
列出使用者的IP

我們建立的handler如下 (RequestHandler.java)


@RestController

public class RequestHandler {


    @RequestMapping(value="/func", method={RequestMethod.GET, RequestMethod.POST})

    public String handler1(@RequestParam(value="name", required=false) String name, 

            HttpServletRequest request, HttpServletResponse response) {

        String user = (name==null || name.isEmpty())? "world": name;

        String host = request.getRemoteHost();

        String result = String.format("Hello, %s! You are from %s", user, host);

        return result;

    }

}

對此程式片段作一個註記：

@RestController：Spring採用MVC架構，註冊此程式為Controller
@RequestMapping：註冊此方法負責特定request的處理。value的值為URL對應的path，method則標記了要處理的方法
@RequestParam(value="name", required=false) String name
Spring Boot會幫我們解析parameters，你可以將你需要的parameters都列出來。
required預設為true，如果為false則表示此參數可能不存在於query string中
解析出來的name值會放到字串name中
因為我們需要使用者的IP，這需要從request物件中來取得，因此我們handler1的參數列加上了HttpServletRequest request，以便在程式中抓到IP
雖然不會用到，我們也加上了HttpServletResponse response，若程式需要對response object作一些設定可以使用。在這個專案中是可以拿掉