SpringBoot异常统一处理方式: @ControllerAdvice

Love The Way You Lie 2024-04-18 22:13 80阅读 0赞

先上代码:

package com.gdd.videos.mini_api.common;
    
    import com.gdd.videos.common.GddResult;
    import lombok.extern.slf4j.Slf4j;
    import org.apache.tomcat.util.http.fileupload.FileUploadBase;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.multipart.MultipartException;
    
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * @author zhangh     
     * @version V1.0.0
     * @projectName parent
     * @title     ControllerExceptionAdvice   
     * @package    com.gdd.videos.mini_api.common  
     * @date   2019/9/12 15:28  
     * @explain
     */
    @Slf4j
    @ControllerAdvice
    public class ControllerExceptionAdvice {
    
        /**
         * 全局异常捕捉处理
         * @param ex
         * @return
         */
        @ResponseBody
        @ExceptionHandler(value = Exception.class)
        public GddResult errorHandler(Exception ex) {
    
            // 处理上传文件发生的错误
            if (ex instanceof MultipartException){
                // 文件大小超出限制时抛出错误信息
                if (ex.getMessage().contains("FileSizeLimitExceededException")){
                    return GddResult.errorMsg("文件大小超出10M限制!");
                }
            }
            return GddResult.errorMsg(ex.getMessage());
        }
    
    }

**@ControllerAdvice:** 代表该类是对Controller层的增强类  
**@ExceptionHandler(value = Exception.class):** 该注解表明的是对发生指定异常的方法进行增强,其中value代表指定的异常(Exception是大类)  
**@ResponseBody:** 表示将数据以JSON格式返回

这个异常处理的是小编今天遇到的一个向服务器上传文件大小超出限制的异常,MultipartFile类的默认大小限制是1M左右,超出了就会抛出MultipartException,信息中打印FileSizeLimitExceededException,  
这里小编对这个异常进行了处理,给客户端友好提示。

附上MultipartFile设置文件大小方式（Springboot中）：[MultipartFile设置文件大小][MultipartFile]

谢谢

[MultipartFile]: https://blog.csdn.net/weixin_43464964/article/details/100775064