Eclipse下利用Maven創建SpringBoot的Restful風格程序

參考文章：https://spring.io/guides/gs/rest-service/

　　　　中文翻譯：https://blog.dubby.cn/detail.html?id=9040

 

1.目標是什么

構建一個web應用，我們可以請求：

 http://localhost:8080/greeting 


返回一個JSON：

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


還可以發起一個帶參數的請求：

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

返回一個JSON：

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


 

2.開始創建

2.1.Maven依賴

新建一個Maven項目

pom.xml文件

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.niiam</groupId>
  <artifactId>SpringBootRestfulTest</artifactId>
  
  <version>0.0.1-SNAPSHOT</version>
  <name>SpringBootRestfulTest Maven Webapp</name>
  <url>http://maven.apache.org</url>
  
  <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>9.0.1</java.version>
  </properties>
  
  <build>
    <finalName>SpringBootRestfulTest</finalName>
    <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>

其中，spring-boot-maven-plugin給我們提供了這么幾個功能：

• 他會把classpath下的jar統一打包成一個可直接運行的”über-jar”，方便我們運行。
• 他會自動搜索public static void main()作為程序執行的入口。
• 他內置一個依賴版本決定者。也就是他會指定依賴的版本。當然你也可以指定版本，如果你不指定，默認由他來決定版本。

2.2 實體類

根據

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

 

來寫出一個表達這個json的bean    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。

 

2.3 controller

在Spring構建的restful應用中，HTTP請求是由controller接收並處理的。想要創建一個controller可以使用@RestController修飾一個類，那么這個類就變成了一個controller。一個controller里的每個方法都可以接收一個特定的URI，需要使用@RequestMapping來修飾每個方法，來制定URI的路徑，參數，方法等。

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

這個controller很簡潔明了，但是在背后隱藏了很多事先細節，我們一點點來分解。

@RequestMapping這個注解確保/greeting這個HTTP請求會被路由到greeting()這個方法上來處理。

上面的例子沒有指明GET，PUST或者是PUT等HTTP方法，因為@RequestMapping默認是映射所有的方法。如果你只希望某個方法被映射到這個方法，可以使用@RequestMapping(method=GET)來縮小映射范圍。

@RequestParam把請求參數中的name的值綁定到greeting()的參數name上。這個參數被標記為可選的，也就是可傳可不傳的，（默認情況下，required=true是必須要傳的），在這里，如果沒有傳name，就會使用defaultValue的值。

greeting()方法里創建了一個Greeting對象，然后返回，用一個自增的int作為id，用name的值拼接成content。

傳統的MVC的controller和RESTful的controller的最大的區別就是返回的HTTP的response。傳統的controller返回的是一個由后端渲染的HTML，而RESTful返回的是一個對象，然后被序列化成JSON字符串。

@RestController是Spring4新加的一個注解，用它修飾的controller返回的是一個對象（也就是JSON），而不是一個視圖（也就是HTML）。這個注解等同於同時使用@Controller和@ResponseBody。

上面提到Spring會自動把對象轉化成JSON，我們還不需要手動來轉換，那么是誰幫我們做的呢？真相是，只要Jackson 2在classpath下，Spring就會使用MappingJackson2HttpMessageConverter來自動轉換。

 

2.4 可執行Jar

雖然也可以打包成傳統的war包然后交給servlet容器來執行，但是更多的時候是打包成一個可以直接執行的Jar。

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修飾的類會被作為定義context上下文的bean。
• @EnableAutoConfiguration允許Spring從配置文件，其他bean，等各種方式來加載bean。
• 一般來說，對於Spirng MVC項目，你需要使用@EnableWebMvc，不過對於Spring Boot來說，只要你的classpath里包含spring-webmvc，他就會自動幫你加上這個，比如，設置DispatcherServlet。
• @ComponentScan告訴Spirng去掃描hello包下的其他組件，包含controller,service等。

main()就是這個應用的入口。發現了嗎，整個應用沒有一個XML文件，全部都是Java代碼，沒有任何配置，這就是Spring Boot想帶給你的禮物。

 

右鍵點擊Application.java，選擇run as->java application，即可啟動服務。

 

2.5 生成可執行Jar

右鍵點擊項目->run as->Maven Install生成jar包，可能需要在項目設置里將JRE換成JDK

在command line輸入：

java -jar SpringBootRestfulTest.jar

啟動

 

在瀏覽器中輸入：

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

http://localhost:8080/greeting

 

需注意的是，此處啟動的jar是包含了Tomcat服務器的

如需終止，可參考：如何優雅地停止運行中的內嵌Tomcat的Spring Boot應用 http://jaskey.github.io/blog/2016/04/05/shutdown-spring-boot-application-gracefully/