SpringBoot如何设置404、500返回统一格式json

 更新时间:2024年08月09日 09:45:38   作者:qykhhr  
这篇文章主要介绍了SpringBoot如何设置404、500返回统一格式json问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

SpringBoot默认访问不存在资源就会出现404

解决后:

主要是添加下面配置:

# 自定义
#出现错误时, 直接抛出异常
spring.mvc.throw-exception-if-no-handler-found=true
#不要为我们工程中的资源文件建立映射
spring.web.resources.add-mappings=false

全局处理异常:

package com.qykhhr.dujiaoshouservice.exceptionhandler;

import com.qykhhr.dujiaoshouservice.util.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.sql.SQLIntegrityConstraintViolationException;

/**
 * 异常处理机制
 * 先找到特定异常处理机制,如果没有就会调用Exception异常处理机制
 */
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

    /**
     * 指定出现什么异常来执行这个方法
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public R error(Exception e){
        e.printStackTrace();
        if (e instanceof SQLIntegrityConstraintViolationException){
            return R.error().message("数据库主键冲突,如是本人,请联系管理员");
        }else if (e instanceof org.springframework.web.servlet.NoHandlerFoundException){
            return R.error().message("找不到资源,/(ㄒoㄒ)/~~");
        }
        return R.error().message("内部服务器错误,/(ㄒoㄒ)/~~!");
    }

    /**
     * 自定义异常处理
     * @param e
     * @return
     */
    @ExceptionHandler(DujiaoshouException.class)
    @ResponseBody
    public R error(DujiaoshouException e){
        log.error(e.getMessage());
        e.printStackTrace();
        return R.error().code(e.getCode()).message(e.getMsg());
    }
}

统一结果返回:

package com.qykhhr.dujiaoshouservice.util;

import lombok.Data;

import java.util.HashMap;
import java.util.Map;

/**
 * 统一返回结果的类
 * @author 雨林
 */
@Data
public class R {

    private Boolean success;
    private Integer code;
    private String message;
    private Map<String,Object> data = new HashMap<>();

    // 把构造方法私有化,只能使用提供的静态方法
    private R(){

    }

    // 成功静态方法
    public static R ok(){
        R r = new R();

        r.setSuccess(true);
        r.setCode(ResultCode.SUCCESS);
        r.setMessage("成功");
        return r;
    }

    // 失败静态方法
    public static R error(){
        R r = new R();

        r.setSuccess(false);
        r.setCode(ResultCode.ERROR);
        r.setMessage("失败");
        return r;
    }

    public R message(String message){
        this.setMessage(message);
        return this;
    }

    public R code(Integer code){
        this.setCode(code);
        return this;
    }

    public R data(Map<String, Object> map){
        this.setData(map);
        return this;
    }

    public R data(String key, Object value){
        this.data.put(key, value);
        return this;
    }
}

我有发现了一个问题,因为我配置了映射,当我访问upload请求找不到文件时,依旧返回了SpingBoot的默认404页面。

我的理解就是访问/upload请求时,SpringBoot会自动到映射的文件夹里面去寻找文件,就会以为这个请求已经被处理了,就不会报找不到处理的异常。而是报除了/error请求的错误。

upload.image.path=/util/images/
upload.apk.path=/util/apk/
upload.crash.exception.file.path=/util/crash/
/**
 * 资源映射路径,只能配置一个映射
 */
@Configuration
public class MyWebMvcConfigurer extends WebMvcConfigurerAdapter {
    @Value("${upload.file.path}")
    private String uploadPath;

    @Value("${upload.image.path}")
    private String uploadImagePath;

    @Value("${upload.crash.exception.file.path}")
    private String uploadCrashExceptionFilePath;

    @Value("${upload.apk.path}")
    private String uploadApkPath;

    /**
     * 将D:\\upload下的文件映射到当前项目/upload/下
     * @param registry
     */
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        registry.addResourceHandler("/favicon.ico").addResourceLocations("classpath:/static/");

        //addResourceHandler()里配置需要映射的文件夹,此处代表映射文件夹user下的所有资源。
        //addResourceLocations()配置文件夹在系统中的路径,使用绝对路径,格式为“file:你的路径/” 后面的 / 必须加上,否则映射失效
//        registry.addResourceHandler("/upload/**").addResourceLocations("file:D:/dujiaoshouapp/");
//        registry.addResourceHandler("/upload/**").addResourceLocations("file:"+uploadPath);
        registry.addResourceHandler("/upload/images/**").addResourceLocations("file:"+uploadImagePath);
        registry.addResourceHandler("/upload/crash/**").addResourceLocations("file:"+uploadCrashExceptionFilePath);
        registry.addResourceHandler("/upload/apk/**").addResourceLocations("file:"+uploadApkPath);
    }
}

解决

可以看到SpringBoot最终保留了/error请求作为后备,未解决的请求都会走到/error路径里面,我们可以定义一个拦截器,拦截这个/error请求,转到我们自己定义的请求里面。

@Component
public class ExceptionInterceptor implements HandlerInterceptor {

    @Autowired
    private RedisTemplate redisTemplate;


    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (modelAndView != null){
            // 防止出现空指针
            // 请求转到 / 
            modelAndView.setViewName("/");
        }
    }
}

然后在WebConfig里面配置上拦截器

@Configuration
public class MyWebMvcConfigurer extends WebMvcConfigurerAdapter {
    @Autowired
    private ExceptionInterceptor exceptionInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(exceptionInterceptor);
        super.addInterceptors(registry);
    }

最后再定义一个Controller,处理 / 请求

package com.qykhhr.dujiaoshouservice.controller;

import com.qykhhr.dujiaoshouservice.util.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class ExceptionController {

    @RequestMapping("/")
    public R error() {
        log.info("处理 /error 请求");
        return R.error().message("访问资源无效!");
    }
}

可以看到访问的结果:

OK,我们现在完全是统一的返回格式了~!

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java经典用法总结

    Java经典用法总结

    这篇文章主要介绍了Java经典用法总结,在本文中,尽量收集一些java最常用的习惯用法,特别是很难猜到的用法,感兴趣的小伙伴们可以参考一下
    2016-02-02
  • 各种格式的编码解码工具类分享(hex解码 base64编码)

    各种格式的编码解码工具类分享(hex解码 base64编码)

    这篇文章主要介绍了各种格式的编码解码工具类,集成Commons-Codec、Commons-Lang及JDK提供的编解码方法
    2014-01-01
  • springboot自定义starter方法及注解实例

    springboot自定义starter方法及注解实例

    这篇文章主要为大家介绍了springboot自定义starter方法详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • java 接口回调实例详解

    java 接口回调实例详解

    这篇文章主要介绍了java 接口回调实例详解的相关资料,所谓回调就是使用java中的多态,需要的朋友可以参考下
    2017-07-07
  • Java中HashMap和HashSet的高效使用技巧分享

    Java中HashMap和HashSet的高效使用技巧分享

    这篇文章主要为大家详细介绍了Java中HashMap和HashSet的高效使用技巧,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-03-03
  • Java中Maven的打包方式和执行jar详解

    Java中Maven的打包方式和执行jar详解

    这篇文章主要介绍了Java中maven的打包方式和执行jar,文中有详细的代码示例,有需要的朋友可以借鉴一下
    2023-04-04
  • Java字段Stream排序常用方式

    Java字段Stream排序常用方式

    这篇文章主要给大家介绍了关于Java字段Stream排序常用方式的相关资料,我们在处理数据的时候经常会需要进行排序后再返回给前端调用,比如按照时间升序排序,前端展示数据就是按时间先后进行排序,需要的朋友可以参考下
    2023-09-09
  • Java项目自动生成接口文档教程

    Java项目自动生成接口文档教程

    本文主要介绍了Java项目自动生成接口文档教程,包含使用Apifox插件从IDEA生成的文档,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • Java设计模式之抽象工厂模式详解

    Java设计模式之抽象工厂模式详解

    这篇文章主要介绍了Java设计模式之抽象工厂模式详解,抽象工厂是一种为访问类提供一个创建一组相关或相互依赖对象的接口,且访问类无须指定所要产品的具体类就能得到同族的、不同等级的产品的模式结构,需要的朋友可以参考下
    2023-09-09
  • ActiveMQ持久化机制代码实例

    ActiveMQ持久化机制代码实例

    这篇文章主要介绍了ActiveMQ持久化机制代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02

最新评论