Locale+Jackson导致Controller接口StackOverflowError异常解决

问题

由于参与的项目有出海需求，即需要给外国人使用，即：需要支持i18n（Internationalization的缩写，共20个字母，除去首尾两个字母，中间有18个，故简称i18n）。

本来是好的，非常简单的Controller接口，在增加字段后，突然爆出StackOverflowError异常：

org.springframework.web.util.NestedServletException: Handler dispatch failed; nested exception is java.lang.StackOverflowErrorat org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1087)at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:965)at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)at javax.servlet.http.HttpServlet.service(HttpServlet.java:555)

排查

直接请教ChatGPT，给出如下几种可能导致Controller层接口StackOverflowError异常的场景：

Controller方法导致无限递归：直接或间接调用自己
JSON序列化导致无限递归：Controller返回的对象包含双向引用，Jackson序列化时可能会陷入无限递归。

@Data
@Entity
public class User {@Idprivate Long id;private String name;@OneToMany(mappedBy = "user")private List<Order> orders;
}@Data
@Entity
public class Order {@Idprivate Long id;private String product;@ManyToOneprivate User user; // 双向引用
}

当User关联Order，Order也关联User，Jackson解析时会无限嵌套，导致StackOverflowError。

解决方案
使用@JsonManagedReference和@JsonBackReference解决循环引用：

@Data
@Entity
public class User {@Idprivate Long id;private String name;@OneToMany(mappedBy = "user")@JsonManagedReferenceprivate List<Order> orders;
}@Data
@Entity
public class Order {@Idprivate Long id;private String product;@ManyToOne@JsonBackReferenceprivate User user;
}

或使用@JsonIgnore：

@ManyToOne
@JsonIgnore
private User user;

AOP拦截器陷入无限调用：错误使用Spring AOP或拦截器，可能会导致方法被无限调用；
错误的toString()方法：实体类toString()方法递归调用自身字段。

四种可能性，第二种可能性最大；于是将问题定位到JSON序列化上。

我的Controller层接口，返回对象（即responseBody）并没有包含双向引用；于是将注意力转移到接口的requestBody上。

定位

经过分析，是我在@RequestBody标注的Dto实体类里新增一个Locale字段：

@EqualsAndHashCode(callSuper = true)
@Data
@AllArgsConstructor
@NoArgsConstructor
@Slf4j
@ApiModel(description = "消息创建请求体")
public class MessageCreateDto {private Locale locale;
}

去掉这个字段，就不再有StackOverflowError异常。

方案

定位到问题后，怎么解决问题呢？

还是直接请教ChatGPT，给出的分析：

Locale本身不是一个普通的Java Bean，它没有默认的无参构造方法，并且Jackson可能无法正确解析它，导致JSON反序列化时进入递归调用，最终导致StackOverflowError。

给出的几种解决方案：

方案一：使用@JsonCreator和@JsonValue

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;public class MessageCreateDto {private Locale locale;@JsonCreatorpublic static Locale fromString(String value) {// 解析 "en_US" => Locale("en", "US")return Locale.forLanguageTag(value.replace('_', '-'));}@JsonValuepublic String toJson() {// 让 Jackson 以 "en-US" 格式序列化return locale.toLanguageTag();}
}

经过验证：并没有解决问题。

方案二：自定义Jackson反序列化器

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;public class LocaleDeserializer extends JsonDeserializer<Locale> {@Overridepublic Locale deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {String localeStr = p.getText();return Locale.forLanguageTag(localeStr.replace('_', '-'));}
}

然后在实体类加上注解：

	@JsonDeserialize(using = LocaleDeserializer.class)@JsonSerialize(using = LocaleSerializer.class)private Locale locale;

经过验证：并没有解决问题。

再加上序列化器，还是有StackOverflowError异常。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;public class LocaleSerializer extends JsonSerializer<Locale> {@Overridepublic void serialize(Locale locale, JsonGenerator gen, SerializerProvider serializers) throws IOException {if (locale != null) {// 格式化为 "en-US" 这种形式，而不是 "en_US"gen.writeString(locale.toLanguageTag());} else {gen.writeNull();}}
}

方案三：手动转换String

public class MessageCreateDto {private String projectId;// 直接使用Locale类型，Jackson反序列化报错StackOverflowErrorprivate String locale;public Locale getLocale() {return Locale.forLanguageTag(locale.replace('_', '-'));}
}