为什么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建议采用下划线形式,不要用驼峰就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • 详解Spring Security 简单配置

    详解Spring Security 简单配置

    本篇文章主要介绍了详解Spring Security 简单配置,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • Java 注册时发送激活邮件和激活的实现示例

    Java 注册时发送激活邮件和激活的实现示例

    这篇文章主要介绍了Java 注册时发送激活邮件和激活的实现示例的相关资料,需要的朋友可以参考下
    2017-07-07
  • Mybatis-Plus BaseMapper的用法详解

    Mybatis-Plus BaseMapper的用法详解

    这篇文章主要介绍了Mybatis-Plus BaseMapper的用法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • 使用Java设置字型和颜色的方法详解

    使用Java设置字型和颜色的方法详解

    这篇文章主要介绍了使用Java设置字型和颜色的方法,在Java的绘图等图形化编程中较常用到,需要的朋友可以参考下
    2015-10-10
  • 浅谈Java代理(jdk静态代理、动态代理和cglib动态代理)

    浅谈Java代理(jdk静态代理、动态代理和cglib动态代理)

    下面小编就为大家带来一篇浅谈Java代理(jdk静态代理、动态代理和cglib动态代理)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-01-01
  • java中char对应的ASCII码的转化操作

    java中char对应的ASCII码的转化操作

    这篇文章主要介绍了java中char对应的ASCII码的转化操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • 基于JavaBean编辑器读取peroperties文件的实例

    基于JavaBean编辑器读取peroperties文件的实例

    下面小编就为大家带来一篇基于JavaBean编辑器读取peroperties文件的实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Java基础学习之标签

    Java基础学习之标签

    在Java中,标签必须在循环之前使用, 一个循环之中嵌套另一个循环的开关,从多重嵌套中continue或break,该文详细介绍了标签的相关知识,对正在学习java基础的小伙伴们还很有帮助,需要的朋友可以参考下
    2021-05-05
  • 详解使用@RequestBody取POST方式的json字符串

    详解使用@RequestBody取POST方式的json字符串

    这篇文章主要介绍了详解使用@RequestBody取POST方式的json字符串,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • 详解Spring加载Properties配置文件的四种方式

    详解Spring加载Properties配置文件的四种方式

    这篇文章主要介绍了详解Spring加载Properties配置文件的四种方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05

最新评论