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

 更新时间:2020年09月17日 10:38:56   作者:luo_yu_1106  
为什么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建议采用下划线形式,不要用驼峰就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • springboot swagger不显示接口的问题及解决

    springboot swagger不显示接口的问题及解决

    这篇文章主要介绍了springboot swagger不显示接口的问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • SpringBoot初始教程之统一异常处理详解

    SpringBoot初始教程之统一异常处理详解

    本篇文章主要介绍了SpringBoot初始教程之统一异常处理详解,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04
  • java自己手动控制kafka的offset操作

    java自己手动控制kafka的offset操作

    这篇文章主要介绍了java自己手动控制kafka的offset操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • java向es中写入数据报错org.elasticsearch.action.ActionReque问题

    java向es中写入数据报错org.elasticsearch.action.ActionReque问题

    这篇文章主要介绍了java向es中写入数据报错org.elasticsearch.action.ActionReque问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-11-11
  • SpringMVC编程使用Controller接口实现控制器实例代码

    SpringMVC编程使用Controller接口实现控制器实例代码

    这篇文章主要介绍了SpringMVC编程使用Controller接口实现控制器实例代码,具有一定参考价值,需要的朋友可以参考下。
    2017-11-11
  • Java DirectByteBuffer堆外内存回收详解

    Java DirectByteBuffer堆外内存回收详解

    这篇文章主要为大家详细介绍了Java中发DirectByteBuffer堆外内存回收,文中的示例代码讲解详细,具有一定的借鉴价值,需要的可以参考一下
    2022-10-10
  • Java中的SecretKeyFactory类使用详解

    Java中的SecretKeyFactory类使用详解

    这篇文章主要介绍了Java中的SecretKeyFactory类使用详解,SecretKeyFactory表示私密密钥的工厂,密钥工厂用来将密钥(类型 Key 的不透明加密密钥)转换为密钥规范(底层密钥材料的透明表示形式),需要的朋友可以参考下
    2024-01-01
  • Spring配置类源码分析详解

    Spring配置类源码分析详解

    这篇文章主要介绍了Spring配置类解析源码解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-09-09
  • idea中Java实体类怎样生成序列化的版本号的方法

    idea中Java实体类怎样生成序列化的版本号的方法

    这篇文章主要介绍了idea中Java实体类怎样生成序列化的版本号的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-11-11
  • 隐藏idea的.idea和.mvn文件的解决方案

    隐藏idea的.idea和.mvn文件的解决方案

    这篇文章主要介绍了隐藏idea的.idea和.mvn文件的解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07

最新评论