1. 介紹

本篇將使用Spring Boot建立一個簡單restful風格web服務，接受HTTP GET請求：

http://localhost:8080/greeting

響應體（respond）為一個JSON字串

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

IED 或 文字編輯器

JDK1.8+

Maven 3.0+

3. 專案工程

1) 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.4.2.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>
 

將本專案classpath裡面的所有jar包打包成一個可執行的jar檔案；

    找到包含public static void main() 方法的類，作為可執行jar的入口

提供內建的依賴分析器，為Spring boot dependencies設定預設的版本號（可以被自己指定的版本號覆蓋）

2) 建立資源表示類（resource representation，即RESTful中的R，簡單理解就是實體）

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;
    }
}
 

3) 資源控制類

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));
    }
}
 

@RestController將該類標註為一個spring bean，並標記其中的每個方法返回一個實體物件。相當於@[email protected]。

@RequestMapping提供url和方法的對映，當接收到一個/greeting的請求時，能執行greeting()方法。

注：上面的例子沒有指定http動作(GET, PUT, POST, DELETE)，所以會與所有的動作匹配。更好的方法是使用@RequestMapping(method=GET)，這樣只會接收到GET請求。

@RequestParam通過指定的value繫結url中的引數。本例中，url引數是可選的，因為提供了預設值“World”。

方法體建立Greeting()物件並返回。

注：傳統的MVC 控制器和RESTful 控制器的區別在於http響應是怎樣被建立的。

傳統的MVC 控制器會通過檢視轉換將Greeting物件渲染成html返回到前端。

而RESTful 控制器直接返回Greeting物件，通過JSON轉換器變成一個JSON字串。

4) 執行類

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);
    }
}

@Configuration將該類標註為一個spring bean

@EnableAutoConfiguration告訴Spring Boot裝載bean的方式可以基於classpath設定、其他bean或屬性設定。

正常情況下我們會為Spring MCV應用加上@EnableWebMvc，但是這裡Spring Boot已經為我們做好了，它檢測到了工程classpath下有spring-mvc jar，就會自動加上這個註解來啟用web應用的關鍵動作，如建立DispatcherServlet。

@ComponentScan 掃描當前包裡面所有帶@Component、@Service、@Controller等註解的類，加入spring容器註冊成bean。

main方法裡用Spring Boot的SpringApplication.run()方法啟動web應用。整個專案沒有一個xml配置檔案，包括web.xml，這就是Spring Boot的強大所在，讓使用者只關注業務邏輯的java程式碼，不用去處理專案配置和結構。

5) 構建可執行JAR

命令列進入專案根目錄

輸入./mvnw spring-boot:run

或./mvnw clean package

會發現專案目錄下生成一個target資料夾，裡面的jar檔案即為可執行JAR。

執行JAR  java -jar target/gs-rest-service-0.1.0.jar

6) 測試

返回結果

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

返回結果

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

原文：  http://spring.io/guides/gs/rest-service/，翻譯省去了關於Gradle的部分。