SpringBoot 中如何使用@ControllerAdvice

SpringBoot 中如何使用@ControllerAdvice，針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

@ControllerAdvice 是一種作用于控制層的切面通知（Advice），該注解能夠將通用的@ExceptionHandler、@InitBinder和@ModelAttributes方法收集到一個類型，并應用到所有控制器上。

@ModelAttribute 添加全局數據

一、設置全局數據

先準備一個實體類對象。

public class User {

    private String username;

    private Integer age;
}

編寫設置全局數據配置。 

import com.example.demo.model.Demo;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ModelAttribute;

/**
 * @author piao
 * @date 2021-04-20
 */
@ControllerAdvice
public class DemoConfig {

    /************************************  方法一 ***************************************/

    @ModelAttribute(value = "demo")
    public String demoStr() {
        return "this is demo";
    }

    @ModelAttribute(value = "demo")
    public Demo demoObj() {
        return new Demo().setUsername("piao").setPassword("123");
    }

    /************************************  方法二 ***************************************/

    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("msg", "this is demo");

        Demo demo = new Demo().setUsername("piao").setPassword("123");
        model.addAttribute("demo", demo);
    }

}

二、獲取全局數據 

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping("/1")
    public String hello(@ModelAttribute("msg") String msg, @ModelAttribute("demo") Demo demo) {
        return "msg：">

三、驗證結果

@InitBinder 請求參數預處理

結合 @InitBinder 還能實現請求參數預處理，即將表單中的數據綁定到實體類上時進行一些額外處理。

一、請求問題

1、編寫兩個實體類，用來接收參數

@Data
@Accessors(chain = true)
public class Demo {

    private String username;

    private String password;

}

@Data
@Accessors(chain = true)
public class User {

    private String username;

    private Integer age;
}

2、編寫 Controller 請求接口

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping()
    public String demo(Demo demo, User user) {
        return "demo username：" + demo.getUsername() + " | user username：" + user.getUsername();
    }
}

3、請求測試，拋出問題

我們傳遞了兩個username值，希望被demo和user對象分別接收，最終卻被兩個對象一起接收并拼接了。

二、編寫解放方法

1、使用 @InitBinder 即可解決上面的問題，這里我們創建一個全局的參數預處理配置

@ControllerAdvice
public class DemoConfig {

    @InitBinder("user")
    public void init1(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("user.");
    }

    @InitBinder("demo")
    public void init2(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("demo.");
    }

}

在 WebDataBinder 對象中，除了可以設置前綴，還可以設置允許、禁止的字段、必填字段以及驗證器等等。

2、編寫 Controller 代碼

@RestController
@RequestMapping("/demo")
public class DemoController {

    @GetMapping()
    public String demo(@ModelAttribute("demo") Demo demo, @ModelAttribute("user") User user) {
        return "demo username：" + demo.getUsername() + " <br/> user username：" + user.getUsername();
    }

}

三、驗證結果

關于SpringBoot 中如何使用@ControllerAdvice問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注億速云行業資訊頻道了解更多相關知識。