Spring MVC的@RestControllerAdvice注解的使用

深碍√TFBOYSˉ_ 2021-07-25 01:36 1193阅读 0赞

**一 视图**

<%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"  "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html;  charset=UTF-8">
    <title>异常处理示例</title>
    <script type="text/javascript"  src="js/jquery-1.11.0.min.js"></script>
    <script type="text/javascript">
           $(function(){
             $("#search").click(function(){
                       $.post("${pageContext.request.contextPath}/search",null,
                                    function(data){
                          // 处理异常
                               if (data.message)
                               {
                                    alert("与服务器交互出现异常：" +  data.message);
                               }
                               else
                               {
                                    // 获取服务器响应，显示所有订单信息
                                    
                               }
                          },"json");
                          });
           })
         </script>
    </head>
    <body>
    
    <button id="search">查询订单（返回JSON）</button>
    </body>
    </html>

**二 控制器及其处理类**

1 OrderController

package org.fkit.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.PostMapping;
    
    @Controller
    public class OrderController {
    
        @PostMapping("/search")
        public String search() throws Exception{
            try {
                int i = 5/0;
                return "success";
            } catch (Exception e) {
                e.printStackTrace();
                throw new OrderException("订单查询失败!");
            }
            
        }
        
    }

2 OrderException

package org.fkit.controller;
    public class OrderException extends RuntimeException {
         public OrderException() {
               super();
               // TODO Auto-generated constructor stub
         }
         public OrderException(String message, Throwable cause,  boolean enableSuppression, boolean writableStackTrace) {
               super(message, cause, enableSuppression,  writableStackTrace);
               // TODO Auto-generated constructor stub
         }
         public OrderException(String message, Throwable cause) {
               super(message, cause);
               // TODO Auto-generated constructor stub
         }
         public OrderException(String message) {
               super(message);
               // TODO Auto-generated constructor stub
         }
         public OrderException(Throwable cause) {
               super(cause);
               // TODO Auto-generated constructor stub
         }
    }

3 GlobalExceptionHandler

package org.fkit.controller;
    
    
    import java.util.HashMap;
    import java.util.Map;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    
    /**
    * @RestController注解本身使用@ControllerAdvicer和@ResponseBody注解。
    * 使用了@RestControllerAdvice注解的类会被看作一个ControllerAdvicer，
    * 而该类中所有使用@ExceptionHandler注解的方法都默认使用了的@ResponseBody注解。
    * */
    @RestControllerAdvice
    public class GlobalExceptionHandler {
        
        // 处理OrderException自定义异常
        @ExceptionHandler(value = OrderException.class)
        public Object OrderErrorHandler(Exception e) throws Exception {
            // 创建返回对象Map并设置属性，会被@ResponseBody注解转换为JSON返回
            Map<String, Object> map = new HashMap<>();
            map.put("code", 100);
            map.put("message", e.getMessage());
            map.put("data", "请求失败");
            return map;
        }
        
    }

**三 配置文件**

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:p="http://www.springframework.org/schema/p"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
         xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="
            http://www.springframework.org/schema/beans
             http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/mvc
            http://www.springframework.org/schema/mvc/spring-mvc.xsd     
            http://www.springframework.org/schema/context
             http://www.springframework.org/schema/context/spring-context.xsd">
            
        
        <context:component-scan base-package="org.fkit.controller"/>
        
        <mvc:annotation-driven/>
         
        <mvc:default-servlet-handler/>
        
        
         <bean id="viewResolver"
               class="org.springframework.web.servlet.view.InternalResourceViewResolver"
              p:prefix="/WEB-INF/content/" p:suffix=".jsp"/>
        
    </beans>

**四 测试**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70]: /images/20210724/dfc43a1dbc5945d9b7bd5a500c975981.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW5ncWl1bWluZw_size_16_color_FFFFFF_t_70 1]: /images/20210724/f140436881684fdea17e08091c81d6a8.png