Spring响应未遵循Gson字段命名策略的问题咨询

问题核心 #

你已配置Gson的LOWER_CASE_WITH_DASHES命名策略，能正常将传入的"tls-alias"映射到Java字段tlsAlias，但接口（包括正常响应和异常响应）返回的字段名仍是tlsAlias，未转换为预期的"tls-alias"。

解决方案 #

一、确保正常接口响应的Gson配置生效 #

1. 清理POJO注解：检查接口返回的实体类，移除@JsonProperty、@SerializedName这类指定字段名的注解——这类注解会覆盖全局Gson命名策略。
2. 自定义Gson Bean强化配置：
   Spring Boot自动配置可能存在优先级问题，手动定义Gson Bean可确保命名策略严格生效：

   @Configuration
   public class GsonConfig {
       @Bean
       public Gson gson() {
           return new GsonBuilder()
                   .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_DASHES)
                   .create();
       }
   }
   

二、修复异常处理器的字段名转换 #

异常处理器中FieldError.getField()返回的是Java属性名（如tlsAlias），直接存入Map序列化不会触发Gson的命名策略，需手动转换：

方式1：依赖Gson实例转换

@RestControllerAdvice
public class ValidationExceptionHandler {
    private final Gson gson;

    // 构造注入Gson实例
    public ValidationExceptionHandler(Gson gson) {
        this.gson = gson;
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<MyValidationErrorResponse> handleValidationExceptions(MethodArgumentNotValidException ex) {
        List<FieldError> errors = ex.getBindingResult().getFieldErrors();
        Map<String, List<String>> errorDetail = new HashMap<>();
        FieldNamingStrategy namingStrategy = gson.fieldNamingStrategy();

        errors.forEach(error -> {
            // 用Gson的命名策略转换字段名
            String jsonFieldName = namingStrategy.translateName(new Field() {
                @Override
                public String getName() { return error.getField(); }
                @Override public Class<?> getType() { return Object.class; }
                @Override public Object get(Object obj) { return null; }
                @Override public void set(Object obj, Object value) {}
                @Override public int getModifiers() { return 0; }
                @Override public String getGenericType() { return ""; }
                @Override public Annotation[] getAnnotations() { return new Annotation[0]; }
                @Override public Annotation[] getDeclaredAnnotations() { return new Annotation[0]; }
                @Override public boolean isSynthetic() { return false; }
                @Override public boolean isEnumConstant() { return false; }
            });
            errorDetail.computeIfAbsent(jsonFieldName, k -> new ArrayList<>()).add(error.getDefaultMessage());
        });

        var errorResponse = new MyValidationErrorResponse(errorDetail);
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

方式2：手动实现驼峰转横杠逻辑

若不想依赖Gson实例，可直接编写转换方法：

@RestControllerAdvice
public class ValidationExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<MyValidationErrorResponse> handleValidationExceptions(MethodArgumentNotValidException ex) {
        List<FieldError> errors = ex.getBindingResult().getFieldErrors();
        Map<String, List<String>> errorDetail = new HashMap<>();

        errors.forEach(error -> {
            // 驼峰转小写横杠格式
            String jsonFieldName = error.getField()
                    .replaceAll("([a-z])([A-Z])", "$1-$2")
                    .toLowerCase();
            errorDetail.computeIfAbsent(jsonFieldName, k -> new ArrayList<>()).add(error.getDefaultMessage());
        });

        var errorResponse = new MyValidationErrorResponse(errorDetail);
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }
}

三、额外检查项 #

• 若项目同时引入Jackson依赖，确认spring.mvc.converters.preferred-json-mapper: gson配置已生效，避免Spring默认使用Jackson序列化。
• 测试正常接口：返回一个包含tlsAlias字段的POJO，验证响应字段是否为"tls-alias"。

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