如何定制Spring的错误json信息

2024-06-19 23:04

本文主要是介绍如何定制Spring的错误json信息,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一,前言

相信很多同学都有遇到过这样的spring错误信息。

在我们没有做catch处理时或者做全局的exceptionHandle时,Spring遇到抛出向外的异常时,就会给我们封装返回这么个格式的异常信息。

那么问题来了,我们能否对这个返回增加错误信息呢。

答案肯定是可以的。下面博主为大家介绍如何增加。

二,spring 默认error信息配置说明

1. server.error.path

  • 属性: server.error.path
  • 描述: 设置错误页面的路径。默认值为 /error

2. server.error.include-stacktrace

  • 属性: server.error.include-stacktrace
  • 描述: 是否在错误响应中包含堆栈跟踪信息。默认为 never
  • 可选值:
    • never:从不包含堆栈跟踪信息。
    • always:总是包含完整的堆栈跟踪信息。
    • on_trace_param:当请求参数 trace 的值为 true 时包含堆栈跟踪信息。

3. server.error.whitelabel.enabled

  • 属性: server.error.whitelabel.enabled
  • 描述: 是否启用 Spring Boot 默认的错误页面(Whitelabel Error Page)。默认为 true

4. server.error.include-binding-errors

  • 属性: server.error.include-binding-errors
  • 描述: 是否在错误响应中包含数据绑定错误信息。默认为 never
  • 可选值:
    • never:从不包含数据绑定错误信息。
    • always:总是包含数据绑定错误信息。

5. server.error.include-message

  • 属性: server.error.include-message
  • 描述: 是否在错误响应中包含异常消息。默认为 always
  • 可选值:
    • always:总是包含异常消息。
    • on_param:当请求参数 message 的值为 true 时包含异常消息。
    • never:从不包含异常消息。

6. server.error.include-exception

  • 属性: server.error.include-exception
  • 描述: 是否在错误响应中包含异常类名。默认为 false
  • 可选值:
    • false:不输出错误类。
    • true:输出错误类信息。

三,部分效果展示

1,默认异常效果

2,打印堆栈信息

# 是否在错误响应中包含堆栈跟踪信息。默认为 never
server.error.include-stacktrace=always

3,打印异常msg信息

# 是否在错误响应中包含异常消息。默认为 always
server.error.include-message=always

4,打印异常类名

# 是否在错误响应中包含异常类名。默认为 false
server.error.include-exception=true

希望对各位大佬有帮助。麻烦加个关注点个赞谢谢!

这篇关于如何定制Spring的错误json信息的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1076396

相关文章

Spring Security常见问题及解决方案

《SpringSecurity常见问题及解决方案》SpringSecurity是Spring生态的安全框架,提供认证、授权及攻击防护,支持JWT、OAuth2集成,适用于保护Spring应用,需配置... 目录Spring Security 简介Spring Security 核心概念1. ​Securit

MySQL 8 中的一个强大功能 JSON_TABLE示例详解

《MySQL8中的一个强大功能JSON_TABLE示例详解》JSON_TABLE是MySQL8中引入的一个强大功能,它允许用户将JSON数据转换为关系表格式,从而可以更方便地在SQL查询中处理J... 目录基本语法示例示例查询解释应用场景不适用场景1. ‌jsON 数据结构过于复杂或动态变化‌2. ‌性能要

SpringBoot+EasyPOI轻松实现Excel和Word导出PDF

《SpringBoot+EasyPOI轻松实现Excel和Word导出PDF》在企业级开发中,将Excel和Word文档导出为PDF是常见需求,本文将结合​​EasyPOI和​​Aspose系列工具实... 目录一、环境准备与依赖配置1.1 方案选型1.2 依赖配置(商业库方案)二、Excel 导出 PDF

SpringBoot改造MCP服务器的详细说明(StreamableHTTP 类型)

《SpringBoot改造MCP服务器的详细说明(StreamableHTTP类型)》本文介绍了SpringBoot如何实现MCPStreamableHTTP服务器,并且使用CherryStudio... 目录SpringBoot改造MCP服务器(StreamableHTTP)1 项目说明2 使用说明2.1

spring中的@MapperScan注解属性解析

《spring中的@MapperScan注解属性解析》@MapperScan是Spring集成MyBatis时自动扫描Mapper接口的注解,简化配置并支持多数据源,通过属性控制扫描路径和过滤条件,利... 目录一、核心功能与作用二、注解属性解析三、底层实现原理四、使用场景与最佳实践五、注意事项与常见问题六

Spring的RedisTemplate的json反序列泛型丢失问题解决

《Spring的RedisTemplate的json反序列泛型丢失问题解决》本文主要介绍了SpringRedisTemplate中使用JSON序列化时泛型信息丢失的问题及其提出三种解决方案,可以根据性... 目录背景解决方案方案一方案二方案三总结背景在使用RedisTemplate操作redis时我们针对

Java中Arrays类和Collections类常用方法示例详解

《Java中Arrays类和Collections类常用方法示例详解》本文总结了Java中Arrays和Collections类的常用方法,涵盖数组填充、排序、搜索、复制、列表转换等操作,帮助开发者高... 目录Arrays.fill()相关用法Arrays.toString()Arrays.sort()A

Spring Boot Maven 插件如何构建可执行 JAR 的核心配置

《SpringBootMaven插件如何构建可执行JAR的核心配置》SpringBoot核心Maven插件,用于生成可执行JAR/WAR,内置服务器简化部署,支持热部署、多环境配置及依赖管理... 目录前言一、插件的核心功能与目标1.1 插件的定位1.2 插件的 Goals(目标)1.3 插件定位1.4 核

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4