springboot入門經典

will的猜想發表於2017-10-13
Spring Boot

今天給大家介紹一下Spring Boot MVC，讓我們學習一下如何利用Spring Boot快速的搭建一個簡單的web應用。

環境準備

  • 一個稱手的文字編輯器（例如Vim、Emacs、Sublime Text）或者IDE（Eclipse、Idea Intellij）
  • Java環境（JDK 1.7或以上版本）
  • Maven 3.0+（Eclipse和Idea IntelliJ內建，如果使用IDE並且不使用命令列工具可以不安裝）

一個最簡單的Web應用

使用Spring Boot框架可以大大加速Web應用的開發過程，首先在Maven專案依賴中引入spring-boot-starter-web：

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>com.tianmaying</groupId>
  <artifactId>spring-web-demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>spring-web-demo</name>
  <description>Demo project for Spring WebMvc</description>

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

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
  </dependencies>

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


</project>

接下來建立src/main/java/Application.java:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class Application {

    @RequestMapping("/")
    public String greeting() {
        return "Hello World!";
    }

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

執行應用：mvn spring-boot:run或在IDE中執行main()方法，在瀏覽器中訪問http://localhost:8080，Hello World!就出現在了頁面中。只用了區區十幾行Java程式碼，一個Hello World應用就可以正確執行了，那麼這段程式碼究竟做了什麼呢？我們從程式的入口SpringApplication.run(Application.class, args);開始分析：

  1. SpringApplication是Spring Boot框架中描述Spring應用的類，它的run()方法會建立一個Spring應用上下文（Application Context）。另一方面它會掃描當前應用類路徑上的依賴，例如本例中發現spring-webmvc（由 spring-boot-starter-web傳遞引入）在類路徑中，那麼Spring Boot會判斷這是一個Web應用，並啟動一個內嵌的Servlet容器（預設是Tomcat）用於處理HTTP請求。

  2. Spring WebMvc框架會將Servlet容器裡收到的HTTP請求根據路徑分發給對應的@Controller類進行處理，@RestController是一類特殊的@Controller，它的返回值直接作為HTTP Response的Body部分返回給瀏覽器。

  3. @RequestMapping註解表明該方法處理那些URL對應的HTTP請求，也就是我們常說的URL路由（routing)，請求的分發工作是有Spring完成的。例如上面的程式碼中http://localhost:8080/根路徑就被路由至greeting()方法進行處理。如果訪問http://localhost:8080/hello，則會出現404 Not Found錯誤，因為我們並沒有編寫任何方法來處理/hello請求。

使用@Controller實現URL路由

現代Web應用往往包括很多頁面，不同的頁面也對應著不同的URL。對於不同的URL，通常需要不同的方法進行處理並返回不同的內容。

匹配多個URL

@RestController
public class Application {

    @RequestMapping("/")
    public String index() {
        return "Index Page";
    }

    @RequestMapping("/hello")
    public String hello() {
        return "Hello World!";
    }
}

@RequestMapping可以註解@Controller類：

@RestController
@RequestMapping("/classPath")
public class Application {
    @RequestMapping("/methodPath")
    public String method() {
        return "mapping url is /classPath/methodPath";
    }
}

method方法匹配的URL是/classPath/methodPath"。

 提示

可以定義多個@Controller將不同URL的處理方法分散在不同的類中

URL中的變數——PathVariable

在Web應用中URL通常不是一成不變的，例如微博兩個不同使用者的個人主頁對應兩個不同的URL:http://weibo.com/user1，http://weibo.com/user2。我們不可能對於每一個使用者都編寫一個被@RequestMapping註解的方法來處理其請求，Spring MVC提供了一套機制來處理這種情況：

@RequestMapping("/users/{username}")
public String userProfile(@PathVariable("username") String username) {
    return String.format("user %s", username);
}

@RequestMapping("/posts/{id}")
public String post(@PathVariable("id") int id) {
    return String.format("post %d", id);
}

在上述例子中，URL中的變數可以用{variableName}來表示，同時在方法的引數中加上@PathVariable("variableName")，那麼當請求被轉發給該方法處理時，對應的URL中的變數會被自動賦值給被@PathVariable註解的引數（能夠自動根據引數型別賦值，例如上例中的int）。

支援HTTP方法

對於HTTP請求除了其URL，還需要注意它的方法（Method）。例如我們在瀏覽器中訪問一個頁面通常是GET方法，而表單的提交一般是POST方法。@Controller中的方法同樣需要對其進行區分：

@RequestMapping(value = "/login", method = RequestMethod.GET)
public String loginGet() {
    return "Login Page";
}

@RequestMapping(value = "/login", method = RequestMethod.POST)
public String loginPost() {
    return "Login Post Request";
}

模板渲染

在之前所有的@RequestMapping註解的方法中，返回值字串都被直接傳送到瀏覽器端並顯示給使用者。但是為了能夠呈現更加豐富、美觀的頁面，我們需要將HTML程式碼返回給瀏覽器，瀏覽器再進行頁面的渲染、顯示。

一種很直觀的方法是在處理請求的方法中，直接返回HTML程式碼，但是這樣做的問題在於——一個複雜的頁面HTML程式碼往往也非常複雜，並且嵌入在Java程式碼中十分不利於維護。更好的做法是將頁面的HTML程式碼寫在模板檔案中，渲染後再返回給使用者。為了能夠進行模板渲染，需要將@RestController改成@Controller：

import org.springframework.ui.Model;

@Controller
public class HelloController {

    @RequestMapping("/hello/{name}")
    public String hello(@PathVariable("name") String name, Model model) {
        model.addAttribute("name", name);
        return "hello"
    }
}

在上述例子中，返回值"hello"並非直接將字串返回給瀏覽器，而是尋找名字為hello的模板進行渲染，我們使用Thymeleaf模板引擎進行模板渲染，需要引入依賴：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

接下來需要在預設的模板資料夾src/main/resources/templates/目錄下新增一個模板檔案hello.html：

<!DOCTYPE HTML>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>Getting Started: Serving Web Content</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
    <p th:text="'Hello, ' + ${name} + '!'" />
</body>
</html>

th:text="'Hello, ' + ${name} + '!'"也就是將我們之前在@Controller方法裡新增至Model的屬性name進行渲染，並放入<p>標籤中（因為th:text是<p>標籤的屬性）。模板渲染還有更多的用法，請參考Thymeleaf官方文件。

處理靜態檔案

瀏覽器頁面使用HTML作為描述語言，那麼必然也脫離不了CSS以及JavaScript。為了能夠瀏覽器能夠正確載入類似/css/style.css, /js/main.js等資源，預設情況下我們只需要在src/main/resources/static目錄下新增css/style.css和js/main.js檔案後，Spring MVC能夠自動將他們釋出，通過訪問/css/style.css, /js/main.js也就可以正確載入這些資源。

相關文章