jackson使用(解决首字符小写问题)

jackson（测试版本2.9.5）

单纯解决首字母小写问题，在实体类上添加如下代码，可以按照属性名原名输出，原理在后面：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY,getterVisibility = JsonAutoDetect.Visibility.NONE)

依赖：

    
      com.fasterxml.jackson.core
      jackson-databind
      2.9.5
    

    
      com.fasterxml.jackson.core
      jackson-core
      2.9.5
    

    
      com.fasterxml.jackson.core
      jackson-annotations
      2.9.5
    

jackson是常用的json转换工具，比如springmvc以及springboot默认支持的json转换工具就是jackson。

jackson将json字符串装换成对象的规则

当将json字符串转换成对象的时候，默认识别public 修饰的属性和public 修饰的setter方法。但是如果private的属性使用了类似@JsonFormat，@JsonProperty注解，那么也能被识别。

识别优先级：
优先级的意思是，当有一个json字段值需要封装时，首先识别属性（前提时public修饰，或有@JsonProperty注解），然后才识别setter。
属性 >setter（对属性进行识别，然后才识别setter，以最后识别的值为准）

• 实体属性封装规则
  对于实体属性，直接原值匹配。

json字符串

实体

只有public修饰的属性才能被自动扫描并封装，如果希望private修饰的属性也能被封装，必须使用@JsonFormat，@JsonProperty注解对其进行修饰。另可以通过@JsonProperty让属性按照别名的值来封装。

• 实体setter方法的封装规则。

  
  
  

  json字符串

实体

对于一个setter方法，会先去掉get，然后再首字母小写，连续的首字母也小写，然后才让这个经过匹配的值去匹配json字段，如果匹配成功，就执行该setter方法。匹配例子为setName匹配json字符串里面的name字段，setNAME匹配name字段，setNaME匹配naME字段。

jackson将对象转换成json字符串的规则

当将对象转换成json字符串的时候，默认识别public 修饰的属性和public 修饰的getter方法。但是如果private的属性使用了类似@JsonFormat，@JsonProperty注解，那么也能被识别。

识别的优先级：

属性 >getter

• 实体属性转换规则：
  属性名不变，直接原值转换。

  
  
  

  实体

json字符串

只有public修饰的属性才能被自动扫描并转换，如果希望private修饰的属性也能被转换，必须使用@JsonFormat，@JsonProperty注解对其进行注释。另可以通过@JsonProperty定义json字段别名。

• 实体getter方法的转换规则。

实体

json字符串

使用public getter生成json字段名规则是，属性名默认是方法名去掉get，然后首字符小写（满足属性的驼峰命名），如果首字母大写，后面有连续的大写，也转换成小写，例子如下：getName->name，getNName->nname，getNaName->naName。由优先级可知，如果同时扫描了实体属性与getter方法，如果getter转换后的json字段名与实体属性名一样（注意不是别名是实体属性名），则实体属性名的值会被替换掉。例子如下（ps：这里只是举个例子，不会真的有这种需求吧，手动滑稽）：

实体：
public class User {

@JsonProperty("names")
private String name = "zyb";

public String getNAME() {
    return "456";
}

public User(String NAME) {
    this.name = NAME;
}

}
转换成的json字符串

{"names":"456"}

简单解释一下转换结果为什么是这样，由于属性使用了@JsonProperty定义别名，所以属性也被扫描到了，别名names的值应该是zyb，但是继续识别getNAME，转换后的名称为name，与实体属性名称name完全一致，所以覆盖掉别名names的值，变为456。

到了这里，简单的说一下我研究jackson的原因：最近遇见了一个交互问题，要求所有的实体属性都是大写，然后使用时发现转换成json字符串时变成了小写，当时不是太知道原理，就使用了@JsonProperty定义别名，定义后发现生成的字段名多了一倍（产生原因是使用@JsonProperty，识别private属性，但是属性名与getter生成的字段名不一致，一个属性就生成了两个字段）。知道原理后，解决方法有两个，一个修改getter的方法名（当时是通过idea直接生成的），让其转换后名称与属性名一致，但是属性太多，直接pass，第二种方法就是只识别属性，不识别getter方法，设置代码如下，后面会详细说明jackson常用注解：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY,getterVisibility = JsonAutoDetect.Visibility.NONE)

jackson常用注解

@JsonAutoDetect：
该注解的作用是配置自动识别的类型：

有以下四个属性：

• getterVisibility：定义getter方法的识别范围。
• isGetterVisibility：定义is-getter方法的识别范围(boolean类型的getter，很少用)。
• setterVisibility：定义setter方法的识别范围。
• creatorVisibility：定义构造器识别范围。
• fieldVisibility：定义属性识别范围。

识别范围是一个枚举，包括：
Visibility.ANY：表示从 private 到 public 修饰，都可识别。
Visibility.NON_PRIVATE：表示除 private 修饰不可识别，其他都识别。
Visibility.PROTECTED_AND_PUBLIC：protected 和 public都识别。
Visibility.PUBLIC_ONLY：仅 public 可见。
Visibility.NONE：所有皆不可见。
Visibility.DEFAULT：缺省，所有被 public 修饰的属性、 getter 和所有 setter皆可见。

@JsonFormat：使用在日期属性上，指定封装与转换格式，例如输出日期格式为yyyy-MM-dd HH:mm:ss，可以设置为

@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")

@JsonIgnore：使用在属性上，也可以使用在set与get方法上，效果都一样，就是忽视。当我们不希望某些字段出现在json字符串上面时，就可以使用该注解忽视该属性
@JsonIgnoreProperties：使用在类上，当需要忽略的属性过多，可以通过该属性设置，该注解的值是一个字符串集合。
@JsonInclude：作用于类上，用于忽略指定值的字段，例如忽略null的字段

@JsonInclude(JsonInclude.Include.NON_NULL)

@JsonSerialize：可以用于属性上，一般用于指定某种类型属性使用自定义的序列化器，常用与限制Double类型保留指定小数位数。使用步骤如下：
1）自定义Double序列化器

//泛型传入Double类型
public class DoubleJsonExchange  extends JsonSerializer {

    private DecimalFormat decimalFormat = new DecimalFormat("0.00");

    @Override
    public void serialize(Double aDouble,
                          JsonGenerator jsonGenerator,
                          SerializerProvider serializerProvider) throws IOException {

        //保留两位小数（四舍五入）
        jsonGenerator.writeNumber(decimalFormat.format(aDouble));

    }


}

2）指定某个Double属性使用自定义序列器

    @JsonSerialize(using = DoubleJsonExchange.class)
    private Double pai = 3.145592654321;