Spring Boot非生产环境API栈追踪响应换行显示实现求助

Got it, let's break this down and fix your stack trace formatting issue for dev/QA environments. The core problems here are twofold: ensuring the feature only runs in non-production environments, and making sure line breaks/tabs in your stack trace string aren't escaped in the JSON response.

1. Restrict the Feature to Dev/QA Only #

First, we need to make sure we don't expose stack traces in production—they contain sensitive code details that shouldn't be public. Here are two straightforward ways to handle this with Spring Boot:

Option 1: Check Active Profiles via Environment #

Inject Spring's Environment bean to check which profiles are active, then use that to conditionally add the stack trace:

@Autowired
private Environment env;

private boolean isNonProductionEnvironment() {
    Set<String> activeProfiles = new HashSet<>(Arrays.asList(env.getActiveProfiles()));
    return activeProfiles.contains("dev") || activeProfiles.contains("qa");
}

Option 2: Use @Profile for Exception Handlers #

If you're using a global exception handler (like @ControllerAdvice), annotate it or the specific method with @Profile({"dev", "qa"}) to ensure it only registers in those environments:

@ControllerAdvice
@Profile({"dev", "qa"})
public class DevQaExceptionHandler {
    // Your exception handling logic here
}

2. Fix the Escaped Line Breaks in JSON #

The reason your \n and \t are showing up as plain text is because Jackson (Spring's default JSON serializer) escapes control characters by default. You have two great options to fix this:

Option A: Return a Structured Stack Trace Array (Recommended) #

Instead of concatenating stack trace elements into a single string, return the raw StackTraceElement[] directly. Jackson will serialize this into a clean, readable array of objects with all the stack trace details:

// In your exception response builder
if (isNonProductionEnvironment()) {
    errorResponse.setApiStackTrace(throwable.getStackTrace());
} else {
    errorResponse.setApiStackTrace(null); // Omit for production
}

Your response will look like this (easy to parse in Postman's "Pretty" view):

{
  "status": "failure",
  "apiStackTrace": [
    {
      "className": "xxx.xxx.Controller",
      "methodName": "getxxxxx",
      "fileName": "ABC.java",
      "lineNumber": 56
    },
    {
      "className": "xxx.xxx.xxxController$$FastClassBySpringCGLIB$$fd2ed167",
      "methodName": "invoke",
      "fileName": "<generated>",
      "lineNumber": -1
    }
  ]
}

Option B: Disable Control Character Escaping in Jackson #

If you prefer to keep the stack trace as a formatted string, configure Jackson to stop escaping \n and \t—but only in dev/QA. Create a conditional configuration:

@Configuration
@Profile({"dev", "qa"})
public class DevQaJacksonConfig {
    @Bean
    public Jackson2ObjectMapperBuilderCustomizer jacksonCustomizer() {
        return builder -> {
            // Disable escaping of control characters like \n, \t
            builder.featuresToDisable(JsonGenerator.Feature.ESCAPE_CONTROL_CHARS);
        };
    }
}

With this setup, your existing ExceptionUtils.getStackTrace(ex) output will retain line breaks and tabs, and Postman's "Pretty" view will render them properly instead of showing \n\t.

3. Bonus: Stick with Apache Commons for Stack Trace Strings #

Your custom stack trace method works, but ExceptionUtils.getStackTrace(ex) from Apache Commons Lang is more robust—it handles nested exceptions, suppressed exceptions, and edge cases your custom code might miss. Keep using that instead of rolling your own.

Verify the Fix #

Start your app with spring.profiles.active=dev or qa, trigger an exception, and check Postman's "Pretty" JSON view. The stack trace should now display with proper line breaks and indentation, no more escaped characters cluttering the output.

内容的提问来源于stack exchange，提问作者GAURAV PANT