快捷導(dǎo)航

SpringMVC中的@ControllerAdvice使用場景詳解

更新時間：2024年01月03日 08:31:52 作者：it_lihongmin

這篇文章主要介紹了SpringMVC中的@ControllerAdvice使用場景詳解,在Spring?MVC進行調(diào)用的過程中,會有很多的特殊的需求,比如全局異常,分頁信息和分頁搜索條件,請求時帶來返回時還得回顯頁面,需要的朋友可以參考下

@ControllerAdvice使用場景

在Spring MVC進行調(diào)用的過程中，會有很多的特殊的需求。比如全局異常，分頁信息和分頁搜索條件，請求時帶來返回時還得回顯頁面。

Spring提供@ControllerAdvice對需要處理的范圍進行配置。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
    // 控制的掃描包范圍
    @AliasFor("basePackages")
    String[] value() default {};
    // 控制的掃描包范圍
    @AliasFor("value")
    String[] basePackages() default {};
    // 控制的包類
    Class<?>[] basePackageClasses() default {};
    // @Controller或者@RestController的類 的數(shù)據(jù)
    Class<?>[] assignableTypes() default {};
    // 控制范圍可以用注解進行配置
    Class<? extends Annotation>[] annotations() default {};
}

1、ExceptionHandler

系統(tǒng)比較龐大時很多的異常是不能控制，或者未知的，不能將所有的sql異常，反射異常，類不存在等拋到頁面上展示給用戶。

則需要一個全局的攔截器處理，Spring 提供了@ExceptionHandler處理方式。

1）、全局異常處理定義

@ControllerAdvice(basePackages = "com.kevin.tool")
public class ExceptionHandlerController {
    /**
     * 錯誤后返回json
     * 如果想跳轉(zhuǎn)到專門的異常界面，則可以返回{@link org.springframework.web.servlet.ModelAndView}
     *
     * @return 標準異常json
     */
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public Map<String, String> handler() {
        Map<String, String> errorMap = new HashMap<String, String>(16);
        errorMap.put("code", "500");
        errorMap.put("msg", "系統(tǒng)異常，請稍后重試");
        return errorMap;
    }
}

2）、控制器方法調(diào)用異常

@RestController
public class ControllerAdviceDemoController {
    @ResponseBody
    @RequestMapping("bindException")
    public String bindException() {
        getMessage();
        return "ok";
    }
    private void getMessage() {
        throw new RuntimeException("未知異常！");
    }
}

3）、訪問效果

2、InitBinder

數(shù)據(jù)綁定有很多的場景，當前比如前端傳入的日期為字符串類型，后端按照Format進解析為日期。

1）、全局日期綁定定義

@ControllerAdvice(basePackages = "com.kevin.tool")
public class ExceptionHandlerController {
    @InitBinder("date")
    public void globalInitBinder(WebDataBinder binder) {
        binder.addCustomFormatter(new DateFormatter("yyyy-MM-dd"));
    }
}

2）、控制器方法調(diào)用日期轉(zhuǎn)換

@RestController
public class ControllerAdviceDemoController {
    @ResponseBody
    @RequestMapping(value = "/initBind", method = RequestMethod.GET)
    public String detail(@RequestParam("id") long id, Date date) {
        System.out.println(date);
        System.out.println(id);
        return "ok";
    }
}

3）、收到的日期類型效果

訪問地址為：//127.0.0.1:9999/initBind?id=123&date=2019-12-30

3、ModelAttribute

先看看@ModelAttribute的注解信息，元注解@Target指定可以修飾方法參數(shù)和方法（全局）。當前模擬一種常見，就是將所有輸出的信息都加上當前的平臺信息（比如版本等公共信息，這種需求還是比較多的）。

@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ModelAttribute {
    
    @AliasFor("name")
    String value() default "";
    
    @AliasFor("value")
    String name() default "";
 
    boolean binding() default true;
}

1）、全局返回屬性添加

@ControllerAdvice(basePackages = "com.kevin.tool")
public class ExceptionHandlerController {
 
    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("msg", "hello");
 
        HashMap<String, String> map = new HashMap<>(16);
        map.put("version", "1.0.0");
        map.put("name", "XXX平臺");
        model.addAttribute("platform", map);
    }
}

2）、控制器方法訪問

@RestController
public class ControllerAdviceDemoController {
 
    @GetMapping("/modelAttributeTest")
    private String modelAttributeTest(@ModelAttribute("msg") String msg,
        @ModelAttribute("platform") Map<String, String> platform) {
 
        String result = "msg：" + msg + "<br>" + "info：" + platform;
        return result;
    }
 
}

3）、輸出效果