在使用Spring MVC開發Web應用程式時，控制器Controller的開發非常重要，雖然說檢視(JSP或者是Thymeleaf)也很重要，因為它才是直接呈現給使用者的，不過由於現在前端越來越重要，很多公司都開始採用前後端分離的開發模式，所以我們暫時可以將精力放在開發控制器上。

使用Spring MVC開發控制器主要使用以下7個註解：

1. @Controller
2. @RequestMapping
3. @ResponseBody
4. @RequestParam
5. @PathVariable
6. @RequestBody
7. @RestController

接下來，我們依次講解每個註解的使用方法。

1. @Controller

先回顧下上篇部落格中新建的簡單控制器HelloController：

package chapter05.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class HelloController {
    @RequestMapping(value = "index", method = RequestMethod.GET)
    public String hello() {
        // 這裡返回的邏輯檢視名
        return "index";
    }
}
 

這裡@Controller註解的作用是用來宣告控制器，它的原始碼如下所示：

package org.springframework.stereotype;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Controller {
    String value() default "";
}
 

這裡值得注意的是，@Controller註解使用了@Component註解，而@Component註解我們並不陌生，它用來宣告一個Bean。

雖然有些書中說可以把@Controller註解替換為@Component註解，執行沒有差別，只是表意性差一點，但是如果你將上面程式碼中的@Controller註解修改為@Component註解，然後重新打包釋出到Tomcat，會發現訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/index時，報如下所示的404錯誤：

將@Component註解還原為@Controller註解，然後重新打包釋出到Tomcat，再次訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/index時，訪問正常：

所以，在Spring MVC中宣告控制器時，推薦使用@Controller註解。

注意事項：程式設計師在閱讀技術書籍時，要多思考，多嘗試，因為書籍中講解的，很可能是錯的。

2. @RequestMapping

@RequestMapping註解用來對映Web請求，它有2種使用形式：

1. 應用在方法級別，如上面的程式碼中展示的那樣。
2. 應用在類級別，當控制器在類級別上新增@RequestMapping註解時，這個註解會應用到控制器的所有處理器方法上，處理器方法上的@RequestMapping註解會對類級別上的@RequestMapping註解的宣告進行補充。

@RequestMapping註解常用的3個引數如下所示：

1. value：指定對映的URL地址，如index
2. method：指定對映的請求型別，如GET請求、POST請求等
3. produces：指定返回的response的媒體型別和字符集，如application/json;charset=UTF-8。

指定method值時使用org.springframework.web.bind.annotation.RequestMethod列舉：

package org.springframework.web.bind.annotation;

public enum RequestMethod {
    GET,
    HEAD,
    POST,
    PUT,
    PATCH,
    DELETE,
    OPTIONS,
    TRACE;

    private RequestMethod() {
    }
}

指定produces值時一般使用org.springframework.http.MediaType類下的常量：

public static final String APPLICATION_JSON_VALUE = "application/json";
public static final MediaType APPLICATION_JSON_UTF8 = valueOf("application/json;charset=UTF-8");
public static final String APPLICATION_JSON_UTF8_VALUE = "application/json;charset=UTF-8";

為了更好的理解，我們在HelloController類上新增如下程式碼：

package chapter05.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
@RequestMapping("/hello")
public class HelloController {
    @RequestMapping(value = "index", method = RequestMethod.GET)
    public String hello() {
        // 這裡返回的邏輯檢視名
        return "index";
    }
}

重新打包並部署到Tomcat中，此時的訪問地址從之前的http://localhost:8080/spring-action-1.0-SNAPSHOT/index變成了http://localhost:8080/spring-action-1.0-SNAPSHOT/hello/index，如下所示：

@RequestMapping註解的value屬性還支援接受一個String型別的陣列，如下所示：

@RequestMapping({"/hello", "/index"})
public class HelloController {
    // 省略其它程式碼
}

此時也可以通過地址http://localhost:8080/spring-action-1.0-SNAPSHOT/index/index進行訪問：

3. @ResponseBody

在上面的程式碼中，我們的方法是返回邏輯檢視名index，然後由檢視解析器最終找到執行時的/WEB-INF/classes/views/index.jsp檢視，但有時我們不需要返回一個頁面，而是直接返回資料給到前端。

此時我們可以使用@ResponseBody註解，該註解可以放在返回值前或者方法上，用於將返回值放在response體內，而不是返回一個頁面。

為了更好的理解，我們新建個DemoAnnoController控制器如下所示：

package chapter05.controller;

import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@Controller
@RequestMapping("/anno")
public class DemoAnnoController {
    @RequestMapping(value = "/index", method = RequestMethod.GET, produces = MediaType.TEXT_PLAIN_VALUE)
    public @ResponseBody
    String index(HttpServletRequest request) {
        return "url:" + request.getRequestURI() + " can access";
    }
}

重新打包並部署到Tomcat中，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/index，效果如下所示：

也可以將@ResponseBody註解放在方法上，如下所示：

@RequestMapping(value = "/index", method = RequestMethod.GET, produces = MediaType.TEXT_PLAIN_VALUE)
@ResponseBody
public String index(HttpServletRequest request) {
    return "url:" + request.getRequestURI() + " can access";
}

4. @RequestParam

@RequestParam註解用於接收URL中的引數資訊。

為了更好的理解 ，我們在DemoAnnoController控制器中新增如下方法：

@RequestMapping(value = "/requestParam", method = RequestMethod.GET, produces = "text/plain;charset=UTF-8")
@ResponseBody
public String passRequestParam(@RequestParam("id") Long id, @RequestParam("name") String name, HttpServletRequest request) {
    return "url:" + request.getRequestURI() + " can access,id: " + id + ",name=" + name;
}

重新打包並部署到Tomcat中，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam?id=1&name=zwwhnly ，效果如下所示：

注意事項：上面示例中，Url中的引數名稱和方法中的變數名稱完全一致，所以可以省略掉@RequestParam註解，不過為了程式碼的易讀性，建議保留@RequestParam註解。

如果不傳遞引數，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam，則會提示如下資訊：

或者只傳遞其中1個引數，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam?id=1，則會提示如下資訊：

由此也說明，使用了@RequestParam註解的引數，在Url中必須傳遞。

不過，@RequestParam註解提供了defaultValue屬性，可以給引數指定預設值，比如我們給引數id設定預設值1，給引數name設定預設值zwwhnly，然後訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam，效果如下所示：

或者訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam?id=2，效果如下所示：

不過，還是有一個異常場景需要注意，就是Url中傳遞的引數和方法中定義的引數型別不匹配，比如我們將id的值傳錯，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/requestParam?id=zwwhnly&name=zwwhnly，會看到如下報錯資訊：

5. @PathVariable

@PathVariable註解也是用於接收URL中的引數資訊，不過和@RequestParam註解稍有不同。

@PathVariable註解用於解析Url中的路徑引數，如https://www.cnblogs.com/zwwhnly/中的zwwhnly部分，而@RequestParam註解用於解析Url中的查詢引數，如https://i.cnblogs.com/posts?page=2中的page部分。

為了更好的理解 ，我們在DemoAnnoController控制器中新增如下方法：

@RequestMapping(value = "/pathvar/{str}", produces = "text/plain;charset=UTF-8")
public @ResponseBody
String demoPathVar(@PathVariable("str") String str, HttpServletRequest request) {
    return "url:" + request.getRequestURI() + " can access,str: " + str;
}

重新打包並部署到Tomcat中，訪問地址http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/pathvar/zwwhnly ，效果如下所示：

注意事項：如果@PathVariable註解中指定value屬性的話，它會假設佔位符的名稱與方法的引數名相同。

因為這裡方法的引數名正好與佔位符的名稱相同，所以我們可以去掉@PathVariable註解的value屬性：

@RequestMapping(value = "/pathvar/{str}", produces = "text/plain;charset=UTF-8")
public @ResponseBody
String demoPathVar(@PathVariable String str, HttpServletRequest request) {
    return "url:" + request.getRequestURI() + " can access,str: " + str;
}

6. @RequestBody

@RequestBody註解允許request的引數在request體中，而不是直接連結在地址後面，該註解放在引數前。

為了更好的理解 ，我們在DemoAnnoController控制器中新增如下方法：

@RequestMapping(value = "/obj", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
public String passObj(@RequestBody DemoObj demoObj, HttpServletRequest request) {
    return "url:" + request.getRequestURI() + " can access,demoObj id：" + demoObj.getId() +
            " demoObj name:" + demoObj.getName();
}

重新打包並部署到Tomcat中，然後使用Postman工具呼叫介面http://localhost:8080/spring-action-1.0-SNAPSHOT/anno/passObj，效果如下所示：

7. @RestController

@RestController是一個組合註解，它組合了@Controller註解和@ResponseBody註解，原始碼如下所示：

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.stereotype.Controller;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    String value() default "";
}

因此，如果某個控制器中所有的方法都只是返回資料而不是頁面的話，就可以使用@RestController註解。

為了更好的理解 ，我們舉個具體的示例。

首先，在pom.xml中新增如下依賴，用於物件和json之間的轉換：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.9.9</version>
</dependency>

然後新建控制器DemoRestController如下所示：

package chapter05.controller;

import chapter05.model.DemoObj;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/rest")
public class DemoRestController {
    @RequestMapping(value = "/getjson", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public DemoObj getjson(@RequestBody DemoObj demoObj) {
        return new DemoObj(demoObj.getId(), demoObj.getName());
    }
}

因為使用@RestController註解，相當於同時使用了@Controller註解和@ResponseBody註解，所以上面的程式碼等價於下面的程式碼：

package chapter05.controller;

import chapter05.model.DemoObj;
import org.springframework.http.MediaType;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
@ResponseBody
@RequestMapping("/rest")
public class DemoRestController {
    @RequestMapping(value = "/getjson", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public DemoObj getjson(@RequestBody DemoObj demoObj) {
        return new DemoObj(demoObj.getId(), demoObj.getName());
    }
}

重新打包並部署到Tomcat中，然後使用Postman工具呼叫介面http://localhost:8080/spring-action-1.0-SNAPSHOT/rest/getjson，效果如下所示：

8. 原始碼及參考

原始碼地址：https://github.com/zwwhnly/spring-action.git，歡迎下載。

Craig Walls 《Spring實戰（第4版）》

汪雲飛《Java EE開發的顛覆者：Spring Boot實戰》

9. 最後

歡迎掃碼關注微信公眾號：「申城異鄉人」，定期分享Java技術乾貨，讓我們一起進步。

相關推薦