使用Gson反序列化带短横线属性名的JSON时，配置@SerializedName后取值为null怎么办

核心排查流程 #

• 逐一对齐实体类与JSON结构的映射关系
  从提供的代码片段来看，当前实体类定义是截断不完整的，优先核对以下常见结构问题：
  1. 最外层ErrResponse类必须定义对应JSON顶级error键的字段，类型为自定义的Error类，且配套实现getError()方法（代码中已经判断data.getError()!=null，说明这部分结构是正常的）。
  2. 核对嵌套实体的可实例化要求：如果Error类、IrpErr类是其他类内部没有加static修饰的非静态嵌套类，Gson会因为无法调用无参构造（非静态内部类必须持有外部类实例才能初始化，Gson的反射机制不支持这类结构），直接把irpErr字段赋值为null，触发空指针。
  3. 核对构造函数定义：如果在实体类中手动写了带参构造方法，Java编译器不会自动生成默认无参构造，Gson会因为找不到无参实例化入口，导致嵌套对象反序列化失败赋值为null。
• 校验@SerializedName注解的配置正确性
  Gson的@SerializedName会直接绑定Java字段和JSON键名，无额外的模糊匹配逻辑，常见配置错误包括：
  1. 注解内填写的键名和JSON实际键名存在大小写、空格、连接符差异，比如把"irp-err"错写为"irp_err"、"irp-Err"，会直接导致映射失败。
  2. 字段同时配置了@Expose注解，但初始化Gson时没有开启对应字段暴露规则，导致该字段被Gson的过滤器跳过，不参与反序列化。
• 定位实际反序列化节点
  不要直接猜测问题，将待解析的JSON字符串作为测试常量，逐节点打印反序列化结果：

  String testJson = "{\"error\":{\"message\":\"irp-return-error\",\"irp-err\":{\"ErrorCode\":\"1015\",\"ErrorMessage\":\"Invalid Data for this user\"}}}";
  Gson testGson = new Gson();
  ErrResponse testData = testGson.fromJson(testJson, ErrResponse.class);
  // 打印节点值定位哪个环节返回了null
  System.out.println("Error实例：" + testData.getError());
  System.out.println("irpErr实例：" + testData.getError().getIrpErr());
  

标准化解决方案 #

• 补全所有实体类的可实例化配置：
  1. 所有嵌套实体（Error、IrpErr）必须定义为独立公共类，或类内加static修饰的静态嵌套类，禁止使用非静态内部类作为Gson的反序列化实体。
  2. 实体类中如果自定义了带参构造，必须手动补写无参构造方法；字段不要用final修饰，避免Gson反射赋值失败。
• 完整可运行的映射代码参考

  // 最外层响应类
  public class ErrResponse {
      private Error error;
      public Error getError() { return error; }
  }
  
  // 错误信息类
  public class Error {
      // 精准匹配带短横线的JSON键
      @SerializedName("irp-err")
      private IrpErr irpErr;
      private String message;
      // 无参构造（自定义带参构造时必须显式声明）
      public Error() {}
      public IrpErr getIrpErr() { return irpErr; }
      public String getMessage() { return message; }
  }
  
  // IRP错误详情类
  public class IrpErr {
      @SerializedName("ErrorCode")
      private String errorCode;
      @SerializedName("ErrorMessage")
      private String errorMessage;
      public IrpErr() {}
      public String getErrorCode() { return errorCode; }
      public String getErrorMessage() { return errorMessage; }
  }
  

• 避坑提示
  Gson初始化时配置的FieldNamingPolicy不会覆盖@SerializedName的显式映射配置，仅对没有加注解的字段生效，不要混淆两类映射逻辑的优先级。

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