SpringMVC 解析（三） Controller 註解

御狐神發表於2022-02-16

我在前面的文章中介紹了Spring MVC最核心的元件DispatcherServlet，DispatcherServlet把Servlet容器(如Tomcat)中的請求和Spring中的元件聯絡到一起，是SpringWeb應用的樞紐。但是我們在日常開發中往往不需要詳細知道樞紐的作用，我們只需要處理樞紐分發給我們的請求。Spring中處理請求業務邏輯最常見的元件是Controller，本文會對Spring的Controller及相關元件做詳細介紹。

Controller的定義

Controller是Spring中的一個特殊元件，這個元件會被Spring識別為可以接受並處理網頁請求的元件。Spring中提供了基於註解的Controller定義方式：@Controller和@RestController註解。基於註解的Controller定義不需要繼承或者實現介面，使用者可以自由的定義介面簽名。以下為Spring Controller定義的示例。

@Controller
public class HelloController {

    @GetMapping("/hello")
    public String handle(Model model) {
        model.addAttribute("message", "Hello World!");
        return "index";
    }
}

@Controller註解繼承了Spring的@Component註解，會把對應的類宣告為Spring對應的Bean，並且可以被Web元件管理。@RestController註解是@Controller和@ResponseBody的組合，@ResponseBody表示函式的返回不需要渲染為View，應該直接作為Response的內容寫回客戶端。

對映關係RequestMapping

路徑的定義

定義好一個Controller之後，我們需要將不同路徑的請求對映到不同的Controller方法之上，Spring同樣提供了基於註解的對映方式：@RequestMapping。通常情況下，使用者可以在Controller類和方法上面新增@RequestMapping註解，Spring容器會識別註解並將滿足路徑條件的請求分配到對應的方法進行處理。在下面的示例中，"GET /persons/xxx"會呼叫getPerson方法處理。

@RestController
@RequestMapping("/persons")
class PersonController {

    @GetMapping("/{id}")
    public Person getPerson(@PathVariable Long id) {
        // ...
    }

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public void add(@RequestBody Person person) {
        // ...
    }
}

路徑的匹配

Spring支援兩種路徑匹配方式，二者之間可以很好的相容，Spring預設使用PathPattern進行路徑的匹配。

PathPattern：使用預解析的方法匹配路徑。專門為Web路徑匹配而設計，可以支援複雜的表示式，執行效率很高。
AntPathMatcher：Spring中用於類路徑、檔案系統和其它資源的解決方案，效率比較低。

PathPattern基本可以向下相容AntPathMatcher的邏輯，並且支援路徑變數和"**"多段路徑匹配，以下列出幾種PathPattern的示例：

路徑示例	說明
/resources/ima?e.png	路徑中有一個字元是可變的，如/resources/image.png
/resources/*.png	路徑中多個字元是可變的，如/resources/test.png
/resources/**	路徑中多段可變，如/resources/test/path/xxx
/projects/{project}/versions	匹配一段路徑，並且把路徑中的值提取出來，如/projects/MyApp/versions
/projects/{project:[a-z]+}/versions	匹配一段符合正規表示式路徑，並且把路徑中的值提取出來，如/projects/myapp/versions

路徑中匹配到的變數可以使用@PathVariable獲取，Path變數可以是方法或者類級別的，匹配到的變數會自動進行型別轉換，如果轉換失敗則會丟擲異常。

@GetMapping("/owners/{ownerId}/pets/{petId}")
public Pet findPet(@PathVariable Long ownerId, @PathVariable Long petId) {
    // ...
}

@Controller
@RequestMapping("/owners/{ownerId}")
public class OwnerController {

    @GetMapping("/pets/{petId}")
    public Pet findPet(@PathVariable Long ownerId, @PathVariable Long petId) {
        // ...
    }
}

路徑衝突

當一次請求匹配到多個Pattern，那麼就需要選出最接近的Pattern路徑。Spring為Pattern和AntPathMatcher提供了選擇最接近的路徑策略，二者之間邏輯相近，此處只介紹PathPattern。對於PathPattern，Spring提供了PathPattern.SPECIFICITY_COMPARATOR用於對比路徑之間的優先順序，對比的規則如下：

null的pattern具有最低優先順序。
包含萬用字元的pattern的具有最低優先順序(如/**)。
如果兩個pattern都包含萬用字元，長度比較長的有更高的優先順序。
包含越少匹配符號和越少路徑變數的pattern有越高的優先順序。
路徑越長的優先順序越高。

Spring 5.3之後不再支援.*字尾匹配，預設情況下“/person”就會匹配到所有的 “/person.*”

接受和返回引數的型別

RequestMapping還可以指定介面接受什麼型別的引數以及返回什麼型別的引數，這通常會在請求頭的Content-Type中指定：

@PostMapping(path = "/pets", consumes = "application/json") 
public void addPet(@RequestBody Pet pet) {
    // ...
}

@GetMapping(path = "/pets/{petId}", produces = "application/json") 
@ResponseBody
public Pet getPet(@PathVariable String petId) {
    // ...
}

RequestMapping還支援按照請求的引數或者Header判斷是否處理請求。

如只接受引數myParam的值為myValue的情況，可以通過如下方式指定：

@GetMapping(path = "/pets/{petId}", params = "myParam=myValue") 
public void findPet(@PathVariable String petId) {
    // ...
}

如只接受請求頭中myParam的值為myValue的情況，可以通過如下方式指定：

@GetMapping(path = "/pets", headers = "myHeader=myValue") 
public void findPet(@PathVariable String petId) {
    // ...
}

程式設計式註冊RequestMapping

我們前面的教程中講的都是怎麼通過@RequestMapping進行路徑的對映，使用這種方式會自動把路徑對映為新增了註解的方法。這種方式雖然使用很方便，但是靈活性方面有一些欠缺，如果我想要根據Bean的配置資訊動態對映路徑之間的關係時，註解的方式就無法做到這種需求。Spring提供了一種動態註冊RequestMapping的方法，註冊示例如下所示：

@Configuration
public class MyConfig {

    // 從容器中獲取維護對映關係的RequestMappingHandlerMapping和自定義元件UserHandler
    @Autowired
    public void setHandlerMapping(RequestMappingHandlerMapping mapping, UserHandler handler) 
            throws NoSuchMethodException {

        // 生成路徑匹配資訊
        RequestMappingInfo info = RequestMappingInfo
                .paths("/user/{id}").methods(RequestMethod.GET).build(); 

        // 獲取需要對映的方法
        Method method = UserHandler.class.getMethod("getUser", Long.class); 

        // 註冊路徑和方法之間的對映資訊
        mapping.registerMapping(info, handler, method); 
    }
}

處理方法

通過RequestMapping對映通常可以把依次請求對映到某個方法，這個方法就是處理方法（Handler Methods）。處理方法的引數和返回值可以使用很多請求中的資訊(如@RequestParam, @RequestHeader)等，這些引數支援使用Optional進行封裝。

方法引數	說明
WebRequest, NativeWebRequest	包含了請求引數、請求和Session資訊，主要用於Spring框架內部解析引數等操作
javax.servlet.ServletRequest, javax.servlet.ServletResponse	Servlet的請求和引數資訊
javax.servlet.http.HttpSession	請求的Session資訊
javax.servlet.http.PushBuilder	伺服器推送是HTTP/2協議中的新特性之一，旨在通過將伺服器端的資源推送到瀏覽器的快取中來預測客戶端的資源需求，以便當客戶端傳送網頁請求並接收來自伺服器的響應時，它需要的資源已經在快取中。這是一項提高網頁載入速度的效能增強的功能。在Servlet 4.0中，伺服器推送功能是通過PushBuilder例項公開的，此例項是從HttpServletRequest例項中獲取的。
java.security.Principal	當前使用者的登入資訊
HttpMethod	請求的方式，如GET，POST等
java.util.Locale	請求中的國際化資訊
java.util.TimeZone + java.time.ZoneId	請求的時區資訊
java.io.InputStream, java.io.Reader	用於獲取請求原始Body的輸入流
java.io.OutputStream, java.io.Writer	用於寫回響應的輸出流
@PathVariable	路徑變數，如"/pets/{petId}"中的petId
@MatrixVariable	用分號分割的引數，如GET /pets/42;q=11;r=22
@RequestParam	獲取請求中的引數，包含multipart型別的檔案
@RequestHeader	請求頭資訊
@CookieValue	請求中的Cookie資訊
@RequestBody	把請求的Body，會使用HttpMessageConverter轉為指定的型別的資料。
HttpEntity<B>	類似於@RequestBody
@RequestPart	用於獲取multipart/form-data中的資料
java.util.Map, org.springframework.ui.Model, org.springframework.ui.ModelMap	獲取用於渲染HTML檢視的引數
@ModelAttribute	用於獲取模型中的屬性
Errors, BindingResult	獲取引數校驗結果資訊
SessionStatus + class-level @SessionAttributes	Session資訊
UriComponentsBuilder	獲取匹配過程中的引數資訊
@SessionAttribute	獲取一個Session屬性
@RequestAttribute	獲取請求中的屬性

處理方法也可以支援很多型別的返回值，不同型別的返回有不同的意義。

返回引數	說明
@ResponseBody	@RestController就包含了這個註解，這個註解表示使用HttpMessageConverter把返回值寫入Response，不會進行檢視解析
HttpEntity<B>, ResponseEntity<B>	和@ResponseBody類似，返回值直接寫入Response
HttpHeaders	只返回Header不返回body
String	按照返回值去查詢View，並解析為模型
View	返回一個檢視
java.util.Map, org.springframework.ui.Model	用於渲染檢視的模型，View由RequestToViewNameTranslator決定
@ModelAttribute	用於渲染檢視的模型，View由RequestToViewNameTranslator決定
ModelAndView	返回一個可用的模型檢視
void	通常表示沒有返回Body
DeferredResult<V>	非同步返回結果，後文詳細介紹
Callable<V>	非同步返回結果，後文詳細介紹
ListenableFuture<V>, java.util.concurrent.CompletionStage<V>, java.util.concurrent.CompletableFuture<V>	類似於DeferredResult，非同步返回撥用結果
ResponseBodyEmitter, SseEmitter	非同步的把HttpMessageConverter轉換後的Body寫入Response
StreamingResponseBody	把返回非同步寫入Response
Reactive types — Reactor, RxJava, or others through ReactiveAdapterRegistry	Flux場景下的非同步返回

型別轉換

網路請求的引數往往是String型別的，而對映到後端時需要轉為處理方法需要的資料型別(如@RequestParam, @RequestHeader， @PathVariable， @MatrixVariable 和 @CookieValue)。這種情況下Spring會獲取容器內的型別轉換服務和屬性編輯器進行轉換，使用者也可以向WebDataBinder中注入自己需要的轉換服務。

Matrix引數

Matrix引數其實時RFC3986中關於Url編碼的一些規範，Matrix引數之間用分號分割，Matrix引數的多個值之間用逗號分割，例如/cars;color=red,green;year=2012，多個值之間也允許用分號分割，如color=red;color=green;color=blue

如果一個URL需要包含Matrix引數，那麼包含Matrix引數應該是一個路徑變數，否則Matrix引數會對路徑匹配造成影響：

// GET /pets/42;q=11;r=22

// 最後一段路徑必須為路徑變數{petId}，否則會造成路徑匹配失敗
@GetMapping("/pets/{petId}")
public void findPet(@PathVariable String petId, @MatrixVariable int q) {

    // petId == 42
    // q == 11
}

不僅僅URL最後一段可以加Matrix引數，URL的任意一段都可以家Matrix引數，如下所示:

// GET /owners/42;q=11/pets/21;q=22

@GetMapping("/owners/{ownerId}/pets/{petId}")
public void findPet(
        @MatrixVariable(name="q", pathVar="ownerId") int q1,
        @MatrixVariable(name="q", pathVar="petId") int q2) {

    // q1 == 11
    // q2 == 22
}

Matrix引數允許設定預設值，使用者沒有傳該引數的時候使用這個預設值：

// GET /pets/42

@GetMapping("/pets/{petId}")
public void findPet(@MatrixVariable(required=false, defaultValue="1") int q) {

    // q == 1
}

如果路徑中包含很多Matrix引數，一個一個接收可能比較麻煩，我們可以通過MultiValueMap用集合的形式去接收：

// GET /owners/42;q=11;r=12/pets/21;q=22;s=23

@GetMapping("/owners/{ownerId}/pets/{petId}")
public void findPet(
        @MatrixVariable MultiValueMap<String, String> matrixVars,
        @MatrixVariable(pathVar="petId") MultiValueMap<String, String> petMatrixVars) {

    // matrixVars: ["q" : [11,22], "r" : 12, "s" : 23]
    // petMatrixVars: ["q" : 22, "s" : 23]
}

如果你需要在程式中使用Matrix引數，需要的配置UrlPathHelper的removeSemicolonContent=false。

@RequestParam

@RequestParam用於把請求中的引數(查詢引數或者表單引數)繫結到對應的方法引數上，預設情況下不允許請求引數中不包含指定的引數，不過使用者可以指定required=false去允許設定請求引數到對應的方法引數。如果方法的引數型別不為String型別，Spring會自動進行型別轉換。當@RequestParam註解的引數型別為Map<String, String>並且@RequestParam沒有指定引數名稱的時候，Spring會把所有的引數注入到Map中。

@Controller
@RequestMapping("/pets")
public class EditPetForm {

    // ...

    @GetMapping
    public String setupForm(@RequestParam("petId") int petId, Model model) { 
        Pet pet = this.clinic.loadPet(petId);
        model.addAttribute("pet", pet);
        return "petForm";
    }

    // ...

}

@RequestHeader

一次Http請求往往會包含請求頭和Body兩部分，我們可以通過@RequestHeader把請求頭和處理方法的引數進行繫結，@RequestHeader同樣支援Map，假設一次請求有如下的頭：

Host                    localhost:8080
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9
Accept-Language         fr,en-gb;q=0.7,en;q=0.3
Accept-Encoding         gzip,deflate
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive              300

如果我們需要在方法中獲取Accept-Encoding和Keep-Alive標籤，我們可以通過如下程式碼獲取：

@GetMapping("/demo")
public void handle(
        @RequestHeader("Accept-Encoding") String encoding, 
        @RequestHeader("Keep-Alive") long keepAlive) { 
    //...
}

@CookieValue

如果我們需要獲取一次請求中的cookie資訊，我們可以通過@CookieValue獲取，獲取方法如下所示：

@GetMapping("/demo")
public void handle(@CookieValue("JSESSIONID") String cookie) { 
    //...
}

@ModelAttribute

@ModelAttribute可以把請求中的引數對映為物件，然後傳遞給對應的方法。

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute Pet pet) {
    // method logic...
}

上面的例子中，請求引數可以來自pet可以來自以下幾種途徑：

在請求預處理的過程中新增的@ModelAttribute屬性中的pet；
從HttpSession中的@SessionAttributes屬性中查詢pet；
從請求引數或者pathVariable中查詢pet屬性；
使用預設的建構函式初始化資料。

@PutMapping("/accounts/{account}")
public String save(@ModelAttribute("account") Account account) {
    // ...
}

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result) { 
    if (result.hasErrors()) {
        return "petForm";
    }
    // ...
}
@ModelAttribute
public AccountForm setUpForm() {
    return new AccountForm();
}

@ModelAttribute
public Account findAccount(@PathVariable String accountId) {
    return accountRepository.findOne(accountId);
}

@PostMapping("update")
public String update(@Valid AccountForm form, BindingResult result,
        @ModelAttribute(binding=false) Account account) { 
    // ...
}

@SessionAttributes 和 @SessionAttribute

@SessionAttributes用於在多個請求之間共享Session資料，該註解只能載入類之上。在第一次請求的時候，會把Session資料放入SessionAttributes中，Session結束的時候清除資料。

@Controller
@SessionAttributes("pet") // 把資料放入Session中
public class EditPetForm {

    // 從Session中查詢資料
    @PostMapping("/pets/{id}")
    public String handle(Pet pet, BindingResult errors, SessionStatus status) {
        if (errors.hasErrors) {
            // ...
        }
            // 清空Session中的資料.
            status.setComplete(); 
            // ...
        }
    }
}

如果Session的屬性不由Controller管理，而是其它元件管理(如Filter管理)，我們就可以使用@SessionAttribute去把Session中的資料和處理方法中的引數進行繫結。

@RequestMapping("/")
public String handle(@SessionAttribute User user) { 
    // ...
}

@RequestAttribute

@RequestAttribute和@SessionAttributes類似，一個是請求級別的，一個是Session級別的，此處不做詳細介紹。

@GetMapping("/")
public String handle(@RequestAttribute Client client) { 
    // ...
}

Multipart引數

我們在前面的文章中說過，DispatcherServlet中會包含MultipartResolver元件，如果一次請求的資料為multipart/form-data型別，DispatcherServlet會把上傳的檔案解析為MultipartFile格式的檔案。Servlet3中也支援使用 javax.servlet.http.Part代替MultipartFile接收檔案，上傳多個檔案的時候可以使用列表或者Map獲取引數。

@Controller
public class FileUploadController {

    @PostMapping("/form")
    public String handleFormUpload(@RequestParam("name") String name,
            @RequestParam("file") MultipartFile file) {

        if (!file.isEmpty()) {
            byte[] bytes = file.getBytes();
            // store the bytes somewhere
            return "redirect:uploadSuccess";
        }
        return "redirect:uploadFailure";
    }
}

Multipart也可以把需要接收的檔案封裝為物件進行接收。

class MyForm {

    private String name;

    private MultipartFile file;

    // ...
}

@Controller
public class FileUploadController {

    @PostMapping("/form")
    public String handleFormUpload(MyForm form, BindingResult errors) {
        if (!form.getFile().isEmpty()) {
            byte[] bytes = form.getFile().getBytes();
            // store the bytes somewhere
            return "redirect:uploadSuccess";
        }
        return "redirect:uploadFailure";
    }
}

除了通過瀏覽器上傳檔案，我們還可以通過RestFul方式以Json的格式上傳檔案：

POST /someUrl
Content-Type: multipart/mixed

--edt7Tfrdusa7r3lNQc79vXuhIIMlatb7PQg7Vp
Content-Disposition: form-data; name="meta-data"
Content-Type: application/json; charset=UTF-8
Content-Transfer-Encoding: 8bit

{
    "name": "value"
}
--edt7Tfrdusa7r3lNQc79vXuhIIMlatb7PQg7Vp
Content-Disposition: form-data; name="file-data"; filename="file.properties"
Content-Type: text/xml
Content-Transfer-Encoding: 8bit
... File Data ...

@PostMapping("/")
public String handle(@RequestPart("meta-data") MetaData metadata,
        @RequestPart("file-data") MultipartFile file) {
    // ...
}

@RequestBody和HttpEntity

@RequestBody應該是日常開發中使用最多的引數之一了，我們可以通過@RequestBody把請求中的Body和處理方法中的引數物件進行繫結，Spring會呼叫HttpMessageConverter服務把請求中的資料反序列化為處理方法中的引數物件。@RequestBody還可以和@Validated註解組合進行使用，如果校驗失敗會丟擲異常或者交給使用者處理校驗異常資訊。

@PostMapping("/accounts")
public void handle(@Valid @RequestBody Account account, BindingResult result) {
    // ...
}

HttpEntity和@RequestBody的原理類似，不過會把請求體封裝到HttpEntity中。

@PostMapping("/accounts")
public void handle(HttpEntity<Account> entity) {
    // ...
}

@ResponseBody和ResponseEntity

@ResponseBody表示會把返回值通過HttpMessageConverter直接序列化為String寫入Response，我們平時使用比較多的@RestController就是由@ResponseBody和@Controller組成。

@GetMapping("/accounts/{id}")
@ResponseBody
public Account handle() {
    // ...
}

ResponseEntity和@ResponseBody，不過返回的基礎上會包含狀態碼和返回頭等資訊。

@GetMapping("/something")
public ResponseEntity<String> handle() {
    String body = ... ;
    String etag = ... ;
    return ResponseEntity.ok().eTag(etag).build(body);
}

JSON Views

Spring內建了對JacksonJSON的支援，並且支援Jackson的Json序列化檢視，在使用@ResponseBody和ResponseEntity返會資料時，可以按照@JsonView來指定Json序列化時需要顯示的欄位。

@RestController
public class UserController {

    @GetMapping("/user")
    @JsonView(User.WithoutPasswordView.class)
    public User getUser() {
        return new User("eric", "7!jd#h23");
    }
}

public class User {

    public interface WithoutPasswordView {};
    public interface WithPasswordView extends WithoutPasswordView {};

    private String username;
    private String password;

    public User() {
    }

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    @JsonView(WithoutPasswordView.class)
    public String getUsername() {
        return this.username;
    }

    @JsonView(WithPasswordView.class)
    public String getPassword() {
        return this.password;
    }
}

我們也可以通過程式設計的方式實現物件的不同檢視的序列化，使用方法如下所示：

@RestController
public class UserController {

    @GetMapping("/user")
    public MappingJacksonValue getUser() {
        User user = new User("eric", "7!jd#h23");
        MappingJacksonValue value = new MappingJacksonValue(user);
        value.setSerializationView(User.WithoutPasswordView.class);
        return value;
    }
}

對於基於View的解決方案，我們可以在Model中新增對應的物件以及Json序列化檢視，使用的示例如下所示：

@Controller
public class UserController extends AbstractController {

    @GetMapping("/user")
    public String getUser(Model model) {
        model.addAttribute("user", new User("eric", "7!jd#h23"));
        model.addAttribute(JsonView.class.getName(), User.WithoutPasswordView.class);
        return "userView";
    }
}

Model物件

Spring中的model物件負責在控制器和展現資料的檢視之間傳遞資料。Spring提供了@ModelAttribute去獲取和寫入Model物件的屬性，@ModelAttribute有多種使用方式：

在處理方法的入參上新增@ModelAttribute，可以獲取WebDataBinder中已經有的Model中的屬性值。
在類上（如Controller）新增@ModelAttribute註解，則會為所有的請求初始化模型。
在處理方法的返回值上新增@ModelAttribute，表示返回值會作為模型的屬性。

@ModelAttribute
public void populateModel(@RequestParam String number, Model model) {
    model.addAttribute(accountRepository.findAccount(number));
    // add more ...
}

@ModelAttribute
public Account addAccount(@RequestParam String number) {
    return accountRepository.findAccount(number);
}

DataBinder

前面我們講了很多如何把請求引數和處理方法入參進行繫結的註解或者型別，並且知道請求引數需要經過型別轉換才能轉為對應型別的資料。然而註解只是一個標記，並不會實際執行引數繫結和型別轉換操作，Spring中必定有一個元件進行引數繫結和型別轉換，這個元件就是WebDataBinder。WebDataBinder有一下作用：

將請求中的引數和處理方法引數進行繫結；
把請求中Spring型別的資料轉為處理方法的引數型別；
對渲染表單的資料進行格式化。

Spring給使用者提供了修改WebDataBinder的介面，使用者可以在Controller中定義被@InitBinder註解的方法，在方法中修改WebDataBinder的定義：

@Controller
public class FormController {

    @InitBinder 
    public void initBinder(WebDataBinder binder) {
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        dateFormat.setLenient(false);
        binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, false));
    }

    // ...
}

異常處理

在關於DispatcherServlet相關的章節中，我們知道了DispatcherServlet包含了異常解析元件，當異常發生的時候會對異常進行解析。日常開發中使用比較多的異常處理元件是ExceptionHandlerExceptionResolver，用於在遇到異常時，使用帶有@ExceptionHandler註解的方法處理對應的異常，該方法可以定義中Controller或者ControllerAdvice中。

@Controller
public class SimpleController {

    // ...

    @ExceptionHandler
    public ResponseEntity<String> handle(IOException ex) {
        // ...
    }
    
    @ExceptionHandler({FileSystemException.class, RemoteException.class})
    public ResponseEntity<String> handle(Exception ex) {
        // ...
    }
}

如果我們需要定義很多@ExceptionHandler，我們可以選擇在@ControllerAdvice中定義，而不是在每個Controller中定義。

如果一個異常匹配到多個@ExceptionHandler，Spring會嘗試使用距離異常繼承體系最近的@ExceptionHandler去處理這個異常。

Controller Advice

如果我們需要定義全域性的@InitBinder或者@ExceptionHandler，那我們就不應該在Controller中定義這些方法。 Spring提供了@ControllerAdvice用於新增全域性配置：

// Target all Controllers annotated with @RestController
@ControllerAdvice(annotations = RestController.class)
public class ExampleAdvice1 {}

// Target all Controllers within specific packages
@ControllerAdvice("org.example.controllers")
public class ExampleAdvice2 {}

// Target all Controllers assignable to specific classes
@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
public class ExampleAdvice3 {}

我是御狐神，歡迎大家關注我的微信公眾號:wzm2zsd
qrcode_for_gh_83670e17bbd7_344-2021-09-04-10-55-16

本文最先發布至微信公眾號，版權所有，禁止轉載！

SpringMVC常用註解@Controller,@Service,@repository,@Component
2018-05-27
SpringMVCController
聊聊springmvc中controller的方法的引數註解
2017-10-23
SpringMVCController
SpringMVC 基於註解的Controller @RequestMapping @RequestParam
2017-06-06
SpringMVCControllerAPP
SpringMVC【開發Controller】詳解
2019-03-04
SpringMVCController
springmvc註解詳解
2016-09-26
SpringMVC
SpringMVC使用註解完成 URL 和 Controller & 方法之間的對映細節
2014-12-04
SpringMVCController
SpringMVC註解講解(一)
2016-12-18
SpringMVC
java自定義註解學習（三）_註解解析及應用
2018-12-24
Java
SpringMvc的常用註解
2020-10-22
SpringMVC
SpringMvc筆記-註解
2017-04-10
SpringMVC筆記
SpringMVC--常用註解（詳解）
2016-01-04
SpringMVC
SpringMVC系列之SpringMVC快速入門 MVC設計模式介紹+什麼是SpringMVC+ SpringMVC的作用及其基本使用+元件解析+註解解析
2020-10-08
SpringMVC設計模式元件
【SpringMVC】@RequestMapping註解
2021-08-27
SpringMVCAPP
【3】SpringMVC的Controller
2017-02-16
SpringMVCController
springmvc常用註解標籤詳解
2016-04-29
SpringMVC
SpringMVC 乾貨系列：從零搭建 SpringMVC+mybatis（二）：springMVC 原理解析及常用註解 | 掘金技術徵文
2019-03-04
SpringMVCMyBatis
Spring典型註解-@Controller,@Component,@
2021-09-09
SpringController
@Controller基本註解的控制器
2017-08-18
Controller
SpringMVC 中 @ControllerAdvice 註解的三種使用場景！
2020-10-30
SpringMVCController
SpringMVC的@ResponseBody註解說明
2021-09-09
SpringMVC
SpringMvc的常用註解介紹
2020-12-26
SpringMVC
SpringMVC原始碼之Handler註冊、獲取以及請求controller中方法
2020-11-18
SpringMVC原始碼Controller
SpringMVC註解和非註解(xml)的方法的異同點
2024-03-10
SpringMVCXML
SpringMvc的Controller singleton synchronized
2019-02-27
SpringMVCControllersynchronized
SpringMVC - controller中獲取session
2014-08-01
SpringMVCControllerSession
深入瞭解SpringMVC原始碼解析
2021-11-27
SpringMVC原始碼
Java 註解完全解析
2019-04-29
Java
Java 註解全面解析
2021-09-09
Java
Java註解全面解析
2018-05-23
Java
胖哥學SpringMVC:Hello World 註解版
2018-03-12
SpringMVC
springMVC中controller的返回值
2021-01-04
SpringMVCController
[譯]SpringMVC自定義驗證註解(SpringMVC custom validation annotations)
2014-10-25
SpringMVC
Java註解解析-搭建自己的註解處理器（CLASS註解使用篇）
2019-03-02
Java
SpringMVC入門學習---使用註解開發
2019-05-10
SpringMVC
SpringMvc自動裝配@Controller無效
2017-04-09
SpringMVCController
Java註解解析-基礎+執行時註解(RUNTIME)
2018-08-28
Java
springMVC學習筆記(二)-----註解和非註解入門小程式
2015-08-30
SpringMVC筆記
SpringMVC原始碼解析
2018-09-18
SpringMVC原始碼