SpringMVC过滤器修改Long类型字段为String后,前端JSON解析失败的解决方法
本文探讨了在SpringMVC过滤器中将Long类型字段转换为String类型后,前端无法正常解析JSON响应的问题,并提供两种解决方案。
问题描述:
一个过滤器旨在将响应体中的Long类型ID字段转换为String类型,但修改后的JSON响应导致前端解析异常。
问题代码 (过滤器):
public class LongTypeFilter extends OncePerRequestFilter {
private final ObjectMapper objectMapper = new ObjectMapper();
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
ContentCachingResponseWrapper responseWrapper = new ContentCachingResponseWrapper(response);
filterChain.doFilter(request, responseWrapper);
byte[] responseBody = responseWrapper.getContentAsByteArray();
String charset = response.getCharacterEncoding();
if (contentType != null && contentType.startsWith(MediaType.APPLICATION_JSON_VALUE)) {
JsonNode rootNode = objectMapper.readTree(new String(responseBody, charset));
if (rootNode.has("code") && rootNode.has("msg") && rootNode.has("result")) {
JsonNode resultNode = rootNode.get("result");
checkAndConvertLongToString(resultNode);
}
String modifiedResponse = rootNode.toString();
responseWrapper.setContentType(MediaType.APPLICATION_JSON_VALUE + ";charset=" + charset);
byte[] modifiedBytes = modifiedResponse.getBytes(charset);
responseWrapper.setContentLength(modifiedBytes.length);
responseWrapper.getWriter().write(modifiedResponse);
responseWrapper.copyBodyToResponse();
} else {
responseWrapper.copyBodyToResponse();
}
}
private void checkAndConvertLongToString(JsonNode node) {
// ... (递归转换Long到String的逻辑,与原代码相同) ...
}
}
问题原因:
过滤器直接修改了响应体,这种方式效率低且容易出错。 ObjectMapper
重新序列化JSON会丢失原始的序列化配置,例如日期格式等,可能导致前端解析失败。
解决方案一:使用Jackson2ObjectMapperBuilderCustomizer
这是更推荐的解决方案,它直接修改Jackson的序列化配置,避免了在过滤器中手动处理响应体。
@Bean
public Jackson2ObjectMapperBuilderCustomizer addLongConverter() {
return builder -> {
builder.serializerByType(Long.class, new JsonSerializer() {
@Override
public void serialize(Long value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
gen.writeString(String.valueOf(value));
}
});
};
}
此配置告诉Jackson将所有Long类型都序列化为String类型。 这样,无需过滤器修改响应体,直接在SpringMVC的JSON序列化过程中完成转换。
解决方案二:改进过滤器 (不推荐)
如果必须在过滤器中处理,可以改进过滤器,避免重新序列化整个JSON:
(此方法不推荐,因为它效率较低且容易出错,建议使用方案一)
结论:
使用Jackson2ObjectMapperBuilderCustomizer
是解决此问题的最佳方法,它简洁高效,避免了直接操作响应体的风险。 直接修改Jackson的序列化配置比在过滤器中手动处理响应体更优雅、更可靠。 改进的过滤器方法虽然可行,但效率低且容易出错,不推荐使用。