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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • ConditionalOnProperty配置swagger不生效问题及解决

    ConditionalOnProperty配置swagger不生效问题及解决

    这篇文章主要介绍了ConditionalOnProperty配置swagger不生效问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Java注解(annotation)简述

    Java注解(annotation)简述

    这篇文章主要介绍了使用java的注解(用在java类的方法上的注解)方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-08-08
  • Spring boot实现数据库读写分离的方法

    Spring boot实现数据库读写分离的方法

    本篇文章主要介绍了Spring boot实现数据库读写分离的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • 详解如何把cmd黑窗口把java文件打包成jar

    详解如何把cmd黑窗口把java文件打包成jar

    本文主要介绍了如何把cmd黑窗口把java文件打包成jar,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • Spring的Bean容器介绍

    Spring的Bean容器介绍

    今天小编就为大家分享一篇关于Spring的Bean容器介绍,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • Java封装数组实现在数组中查询元素和修改元素操作示例

    Java封装数组实现在数组中查询元素和修改元素操作示例

    这篇文章主要介绍了Java封装数组实现在数组中查询元素和修改元素操作,结合实例形式分析了java针对数组元素查询、修改的封装操作实现技巧,需要的朋友可以参考下
    2020-03-03
  • java性能优化之编译器版本与平台对应关系

    java性能优化之编译器版本与平台对应关系

    这篇文章主要介绍了java性能优化--编译器版本与平台对应关系,本章节更加具体化的学习编译器还有哪些可以优化的方便,让你的应用展现出更好的性能,需要的朋友可以参考下
    2022-06-06
  • 解决maven没有打包xml文件的问题

    解决maven没有打包xml文件的问题

    这篇文章主要介绍了解决maven没有打包xml文件的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11
  • Java在PowerPoint幻灯片中创建散点图的方法

    Java在PowerPoint幻灯片中创建散点图的方法

    散点图是通过两组数据构成多个坐标点,考察坐标点的分布,判断两变量之间是否存在某种关联或总结坐标点的分布模式,这篇文章主要介绍了Java如何在PowerPoint幻灯片中创建散点图,需要的朋友可以参考下
    2023-04-04
  • javaDSL简单实现示例分享

    javaDSL简单实现示例分享

    DSL领域定义语言,用来描述特定领域的特定表达。比如画图从起点到终点;路由中的从A到B。这是关于画图的一个简单实现
    2014-03-03

最新评论