構建的rest的Web服務所要實現的功能

  構建一個接受HTTP GET請求的服務，如下：

http://localhost:8080/greeting

  greeting響應的json資料格式如下：

{"id":1,"content":"Hello, World!"}

  在greeting中，我們可以自定義一個名為name的請求引數：

http://localhost:8080/greeting?name=User

  當我們加入name的請求引數後，預設的“World”值將會被重寫，因而響應的結果變更為：

{"id":1,"content":"Hello, User!"}

構建rest的Web伺服器

構建rest的Web伺服器需要準備的前提條件

• JDK 1.8 及以上版本

• Gradle 2.3+ 或者 Maven 3.0+

  而我這裡主要是以Maven 3.0+為基礎來進行演示。

構建Maven格式的rest的Web服務

構建Maven格式的rest的Web伺服器基礎框架

  我們需要建立的目錄結構如下：

└── src
    └── main
        └── java
            └── hello

  pom.xml原始碼如下

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns
 
="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.springframework</groupId>
    <artifactId>gs-rest-service</artifactId
 
>
    <version>0.1.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.9.RELEASE</version>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>com.jayway.jsonpath</groupId>
            <artifactId>json-path</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <properties>
        <java.version>1.8</java.version>
    </properties>


    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <repositories>
        <repository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-releases</id>
            <url>https://repo.spring.io/libs-release</url>
        </pluginRepository>
    </pluginRepositories>
</project>

  其實我們在搭建這個rest的Web服務的基礎框架時有一個更好的辦法，那就是在Maven官網的GitHub賬號上有一個官方的基礎框架可以直接拿來使用，該框架支援Maven、Gradle，能夠支援在包括windows和linux等的作業系統在內的命令列執行。其連結如下：

  這個 Spring Boot Maven外掛提供了許多方便的特性

• 它收集類路徑上的所有jar，並構建一個單一的、可執行的“über-jar”，這使得執行和傳輸您的服務更加方便。

• 它搜尋public static void main()方法並將其標記為可執行的類。

• 它提供了一個內建的依賴解析器，它可以設定版本號來匹配Spring Boot dependencies。您可以覆蓋任何您希望的版本，但是它將引導預設所選擇的版本集。

新增java程式碼

  我們通過考慮服務互動來開始這個過程。

  該服務將以GET請求的方式來請求/greeting，並可選地使用查詢字串中的name引數。GET請求應該返回一個200 OK的JSON格式的問候響應，其應該是這樣的：

{
    "id": 1,
    "content": "Hello, World!"
}

  id欄位是問候的唯一識別符號，content是問候的文字表示。

  要對問候表示建模，您需要建立一個資源表示類。為id和 content資料提供一個帶有欄位、構造器和存取器的普通java物件。

src/main/java/hello/Greeting.java

package hello;

public class Greeting {

    private final long id;
    private final String content;

    public Greeting(long id, String content) {
        this.id = id;
        this.content = content;
    }

    public long getId() {
        return id;
    }

    public String getContent() {
        return content;
    }
}

  正如您在下面的步驟中看到的，Spring將會呼叫 Jackson JSON的執行庫將Greeting的返回資料轉換成JSON格式。

  接下來，您將建立資源控制器來提供這些問候。

建立一個資源controller

  在Spring構建RESTful web服務的方法中，HTTP請求由控制器處理。這些元件很容易通過@restcontroller註解來識別，下面的GreetingController通過處理訪問/greeting的GET請求來返回並裝載一個新的Greeting類。

src/main/java/hello/GreetingController.java

package hello;

import java.util.concurrent.atomic.AtomicLong;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

    private static final String template = "Hello, %s!";
    private final AtomicLong counter = new AtomicLong();

    @RequestMapping("/greeting")
    public Greeting greeting(@RequestParam(value="name", defaultValue="World") String name) {
        return new Greeting(counter.incrementAndGet(),
                            String.format(template, name));
    }
}

  這個控制器簡潔而簡單，但是在底層有很多東西。讓我們一步一步地把它分解。

  @RequestMapping註解確保將/greeting的HTTP請求對映到greeting()方法。

  上面的例子並沒有指定GET和PUT、POST等等，因為@RequestMapping在預設情況下對映所有的HTTP操作。使用@RequestMapping(method=GET)來縮小這個對映。

  @RequestParam將查詢的字串引數name的值繫結到greeting()方法的name引數中。這個查詢字串引數被顯式地標記為可選的(預設情況下required=true):如果在請求中沒有，則使用defaultValue中的“World”。

  方法主體的實現建立並返回一個帶有id和content屬性的新Greeting物件，該物件基於counter的下一個值，並通過使用問候template來格式化給定的name。

  傳統的MVC控制器和上面的RESTful Web服務控制器之間的一個關鍵區別是HTTP響應主體的建立方式。這個rest式的web服務控制器並不依賴於檢視技術來執行向HTML的問候資料的伺服器端呈現，而是簡單地填充並返回一個Greeting物件。物件資料將以JSON形式直接寫入HTTP響應。

  這段程式碼使用了Spring 4的新@RestController註釋，它將類標記為一個控制器，其中每個方法都返回一個域物件而不是一個檢視。它是@Controller和@ResponseBody的縮寫。

  Greeting物件必須轉換為JSON。由於Spring的HTTP訊息轉換器支援，您不需要手工進行這種轉換。因為 Jackson 2類路徑中,Spring的 MappingJackson2HttpMessageConverter自動選擇Greeting例項轉換為JSON。

使應用程式成為可執行檔案

  儘管可以將此服務打包為用於部署到外部應用伺服器的傳統WAR檔案，但下面演示的更簡單的方法建立了一個獨立的應用程式。您可以將所有內容打包到一個單獨的、可執行的JAR檔案中，這個JAR檔案由一個好的舊Java main()方法驅動。在此過程中，您使用Spring的支援來將Tomcat servlet容器嵌入到HTTP執行時中，而不是將其部署到外部例項中。

src/main/java/hello/Application.java

package hello;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

  @SpringBootApplication是一個方便的註釋，它添加了以下所有內容:

• @Configuration將類標記為應用程式上下文中bean定義的來源。

• @EnableAutoConfiguration告訴Spring引導開始新增基於類路徑設定、其他bean以及各種屬性設定。

• 通常情況下，你會為一個Spring MVC應用新增@EnableWebMvc，但是當Spring引導在類路徑上看到spring-webmvc時，它會自動新增它。這將應用程式標記為web應用程式，並激活諸如設定DispatcherServlet之類的關鍵行為。

• @ComponentScan告訴Spring在hello包中尋找其他元件、配置和服務，以便找到控制器。

  main()方法使用Spring Boot的SpringApplication.run()方法來啟動一個應用程式。您注意到沒有一行XML嗎?沒有web.xml檔案。這個web應用程式是100%純Java的，您不需要處理任何管道或基礎設施的配置。

構建一個可執行JAR

  您可以在命令列中使用Gradle或Maven來執行該應用程式。或者您可以構建一個單一的可執行JAR檔案，該檔案包含所有必需的依賴項、類和資源，並執行該檔案。這使得在整個開發生命週期中，跨不同的環境，以及在不同的環境中，將服務作為一個獨立的應用程式進行釋出、版本和部署服務變得更加容易。

  在Maven中，如果是Linux作業系統，我們需要在應用程式下使用./mvnw spring-boot:run，如果是windows作業系統，我們需要在應用程式下使用mvnw spring-boot:run或者你可以在Linux下使用./mvnw clean package如果在windows下使用mvnw clean package。然後你就可以執行這個JAR檔案了，執行指令如下：

java -jar target/gs-rest-service-0.1.0.jar

   上面的過程將建立一個可執行的JAR。您也可以選擇構建一個典型的WAR檔案。

測試服務

  現在服務已經執行,訪問http://localhost:8080/greeting,你將會看到：

{"id":1,"content":"Hello, World!"}

  新增查詢引數name訪問http://localhost:8080/greeting?name=User。注意，內容屬性的值從“Hello，World!”變成“Hello User!”:

{"id":2,"content":"Hello, User!"}

  這一變化表明，GreetingController中的@RequestParam是按預期工作的。name引數被賦予了“World”的預設值，但是總是可以通過查詢字串顯式地覆蓋它。

  還要注意id屬性是如何從1變更為2的。這就證明了您在多次請求中對同一個GreetingController例項進行了操作，並且它的計數器欄位在每次呼叫時都是按照預期的那樣遞增的。