springboot访问不存在的URL时的处理方法

 更新时间:2024年12月12日 09:02:59   作者:Kwoky  
在前后端分离的模式下,当Spring Boot应用接收到一个不存在的URL请求时,通常希望返回一个固定的JSON字符串作为响应,以便前端能够据此进行相应的处理,本文给大家介绍了springboot访问不存在的URL时的处理方法,需要的朋友可以参考下

引言

在前后端分离的模式下,当Spring Boot应用接收到一个不存在的URL请求时,通常希望返回一个固定的JSON字符串作为响应,以便前端能够据此进行相应的处理。

最初的思路是自定义一个错误控制器来处理404错误,并返回一个JSON格式的响应体。让错误控制器实现ErrorController接口,并重写getErrorPath()方法以指定错误处理的路径。然后,你可以在这个控制器中创建一个处理404错误的方法。

然而却发现springboot3.3.5中ErrorController没有任何接口方法,只能另辟蹊径,考虑使用ErrorPageRegistrar。

ErrorPageRegistrar

ErrorPageRegistrar是Spring Boot中用于注册错误页面的接口。通过实现这个接口,可以自定义不同HTTP状态码对应的错误页面。

ErrorPageRegistrar接口定义在Spring Boot的Web模块中,它包含一个方法registerErrorPages(ErrorPageRegistry registry)。这个方法用于注册错误页面,其中ErrorPageRegistry是一个用于添加错误页面的注册表。

实现接口

创建一个类实现ErrorPageRegistrar接口,并重写registerErrorPages方法。在这个方法中,可以使用ErrorPageRegistry的addErrorPages方法来添加多个错误页面。

import org.springframework.boot.web.server.ErrorPage;
import org.springframework.boot.web.server.ErrorPageRegistrar;
import org.springframework.boot.web.server.ErrorPageRegistry;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpStatus;


/**
 * @基本功能:
 * @program:ecconfigcenter
 * @author:Jet
 * @create:2024-11-07 17:29:58
 **/

@Configuration
public class ErrorPageConfig implements ErrorPageRegistrar {

    @Override
    public void registerErrorPages(ErrorPageRegistry registry) {
        // 注册404错误页面
        ErrorPage error404 = new ErrorPage(HttpStatus.NOT_FOUND, "/ec/error/404");
        // 注册500错误页面
        ErrorPage error500 = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/ec/error/500");
        // 将错误页面添加到注册表中
        registry.addErrorPages(error404, error500);
    }
}

这里使用@Configuration注解标记ErrorPageConfig为配置类,以便Spring Boot能够自动扫描并注册这个配置。
在registerErrorPages方法中,通过创建ErrorPage对象来指定HTTP状态码和对应的错误处理的路径。然后,将这些ErrorPage对象传递给addErrorPages方法。

注册错误处理

import cn.com.ec.eccommon.common.BaseController;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

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


/**
 * @基本功能:
 * @program:ecconfigcenter
 * @author:Jet
 * @create:2024-11-07 17:29:58
 **/


@Slf4j
@RequestMapping("/ec")
@Controller
public class CustomErrorController extends BaseController {

    /**
     * 404处理
     * @return
     */
    @RequestMapping(value = "/error/404",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> handle404() {
        Map<String,Object>result = new HashMap<>();
        result = this.setJson(404,"url is invalid.",null);
        return result;
    }

    /**
     * 500处理
     * @return
     */
    @RequestMapping(value = "/error/500",method = RequestMethod.POST)
    @ResponseBody
    public Map<String,Object> handle500() {
        Map<String,Object>result = new HashMap<>();
        result = this.setJson(500,"Server internal error.",null);
        return result;
    }
}

到此这篇关于springboot访问不存在的URL时的处理方法的文章就介绍到这了,更多相关SpringBoot访问不存在的URL内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Java中字符流与字节流的区别

    详解Java中字符流与字节流的区别

    这篇文章主要介绍了详解Java中字符流与字节流的区别的相关资料,需要的朋友可以参考下
    2017-03-03
  • SpringCloud 如何提取公共配置

    SpringCloud 如何提取公共配置

    这篇文章主要介绍了SpringCloud 提取公共配置的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • springboot项目中后端接收前端传参的方法示例详解

    springboot项目中后端接收前端传参的方法示例详解

    这篇文章主要介绍了springboot项目中一些后端接收前端传参的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-06-06
  • SpringBoot整合MybatisPlus的教程详解

    SpringBoot整合MybatisPlus的教程详解

    这篇文章主要介绍了SpringBoot整合MybatisPlus的方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • java实现模拟进度计量器

    java实现模拟进度计量器

    这篇文章主要为大家详细介绍了java实现模拟进度计量器,模拟血压计实例,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-07-07
  • Java字符串定义及常用方法

    Java字符串定义及常用方法

    这篇文章主要介绍了Java字符串定义及常用方法,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-08-08
  • java自动装箱拆箱深入剖析

    java自动装箱拆箱深入剖析

    基本数据(Primitive)类型的自动装箱(autoboxing)、拆箱(unboxing)是自J2SE 5.0开始提供的功能。java语言规范中说道:在许多情况下包装与解包装是由编译器自行完成的(在这种情况下包装成为装箱,解包装称为拆箱)
    2012-11-11
  • Elasticsearch mapping 概念及自动创建示例

    Elasticsearch mapping 概念及自动创建示例

    这篇文章主要为大家介绍了Elasticsearch mapping 概念及自动创建示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-11-11
  • SpringMVC事件监听ApplicationListener实例解析

    SpringMVC事件监听ApplicationListener实例解析

    这篇文章主要介绍了SpringMVC事件监听ApplicationListener实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • Mybatis分页插件PageHelper的分页原理剖析

    Mybatis分页插件PageHelper的分页原理剖析

    这篇文章主要介绍了Mybatis分页插件PageHelper的分页原理剖析,PageHelper作为一个启动器,那么就和其他启动器加载一样,先读取spring.factories文件里面配置的类,转成Bean加载本系统中,然后执行他的前置后置处理方法,完成初始化,需要的朋友可以参考下
    2023-08-08

最新评论