为什么rest接口返回json建议采用下划线形式,不要用驼峰

今天被数据大神说了，对接第三方接口返回的json字段我想用驼峰形式，他说我这样不专业。所以就改了，认怂。

记住以后再次对接rest接口，返回的字段用下划线形式

记录一下改的内容

1.使用fastjson的@JSONField(name = "is_member")

如果没有fastjson的包，要先引入

 <!-- fastjson start -->
 <dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>fastjson</artifactId>
   <version>1.2.54</version>
 </dependency>
    <!-- fastjson end -->

实体参数：

  /**
 * 是否会员
 */
 @JSONField(name = "is_member")
 private String isMember;

将需要转换的实体都标注好后，在通过JSONObject转jsonString的时候，就可以得到字段为下户线的json了

String json = JSONObject.toJSONString(new Entity());

tips:可以写个单元测试，测试一下这个转换是否成功

另外，还可以设置json转换时去掉某个字段，只需要这么写

@JSONField(serialize = false)

private String name;

自己写单元测试试一下吧

2.为了统一，csv文件的header字段我也用了下划线，但是由于这个不是转换json,所以上面的方法行不通，所以我自己转换了一下。

  public static final char UNDERLINE = '_';
   /**
 * @Description 驼峰式转下划线
 */
public static String camelToUnderline(String param) {
 if (param == null || "".equals(param.trim())) {
  return "";
 }
 int len = param.length();
 StringBuilder sb = new StringBuilder(len);
 for (int i = 0; i < len; i++) {
  char c = param.charAt(i);
  if (Character.isUpperCase(c)) {
  sb.append(UNDERLINE);
  sb.append(Character.toLowerCase(c));
  } else {
  sb.append(c);
  }
 }
 return sb.toString();
 }

好了，统一下划线格式就改好了。

补充知识：@JsonProperty注解和 @Colume注解 -- 驼峰式和下划线之间的自动转换

变量名为appid，希望jackson在把对象转换为json串时变为 AppId。可以使用@JsonProperty注解

@JsonProperty("user_name")

private String userName;

变量名为 createTime, 希望JPA自动对应到数据库的 create_time 字段，可以使用

@Column 注解。
  @Column(name = "create_time")
  public Timestamp getCreateTime() {
    return createTime;
  }

以上这篇为什么rest接口返回json建议采用下划线形式,不要用驼峰就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持自学编程网。

编程技巧