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

jackson(测试版本2.9.5)

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

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

依赖:

    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.5</version>
    </dependency>

    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.9.5</version>
    </dependency>

    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.9.5</version>
    </dependency>

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<Double> {

    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;

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342