@SerializedName注解的使用

清疚 2024-03-26 22:56 63阅读 0赞

最近遇到了一个很傻的问题，我们公司的项目遇到了一个需要对接金蝶接口的需求，谁曾想金蝶接口的返回值命名一塌糊涂，各种大小写不规范，各种魔法数字命名。

例如:

> \{  
> "Result":\{  
> "ResponseStatus":\{  
> "IsSuccess":true  
> \},  
> "Result":\{  
> "Id":107114,  
> "msterID":107114,  
> "DocumentStatus":"C",  
> "ForbidStatus":"A",  
> "MultiLanguageText":\[  
> \{  
> "PkId":100204,  
> "LocaleId":2052,  
> "Name":"UAT Test ",  
> "Description":" ",  
> "ShortName":" "  
> \}  
> \],  
> "Name":\[  
> \{  
> "Key":2052,  
> "Value":"UAT Test "  
> \}  
> \],  
> "Number":"00001",  
> "Description":\[  
> \{  
> "Key":2052,  
> "Value":" "  
> \}  
> \],  
> "CreateOrgId\_Id":1,  
> "CreateOrgId":\{  
> "Id":1,  
> "MultiLanguageText":\[  
> \{  
> "PkId":1,  
> "LocaleId":2052,  
> "Name":"德斯嘉宝(上海)贸易有限公司"  
> \},  
> \{  
> "PkId":100001,  
> "LocaleId":1033,  
> "Name":"Descours & Cabaud "  
> \}  
> \],

那么我在第一版map的时候为了偷懒，就在java代码中搞了和金蝶一模一样的命名，就为了map上，但是缺忽略了这种不规范的命名方式上sonar肯定是各种爆红的，领导也说了，金蝶可以不规范，但我们一定要规范。正当我一筹莫展之际。@SerializedName注解闪亮登场！以下为代码：

package com.google.gson.annotations;
    
    import java.lang.annotation.Documented;
    import java.lang.annotation.ElementType;
    import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.FIELD, ElementType.METHOD})
    public @interface SerializedName {
        String value();
    
        String[] alternate() default {};
    }

@Retention （生命周期）

@Target（作用域）

**首先**说一下SerializedName的主要作用：属性重命名，可以将json中的属性名转为我们自己自定义的属性名  
**其次**@SerializedName注解提供了两个属性，上面用到了其中一个'value'，别外还有一个属性'alternate'：接收一个String数组。alternate的意思就是就是可以让这个java字段map到多个不同json的值 alternate数组中出现任意一个属性名都可以转换为自定义的属性，如果出现多个则以最后一个为准  例如

@SerializedName(value = "ModifyDate", alternate = { "MOdifyDate", "FModifyDate" })
        private String modifyDate;

这个的意思就是我们首先让ModifyDate映射上，同时alternate数组中的字符串也可以映射到modifyDate中。

常规使用如下

@SerializedName("SupplierBase")
        private List<SupplierBaseDTO> supplierBase;
    
        @SerializedName("SupplierFinance")
        private List<SupplierFinanceDTO> supplierFinance;
    
        @SerializedName("F_WRUO_MulBase")
        private List<OperationSiteDTO> operationSite;
    
        @SerializedName("OldNumber")
        private String oldNumber;
    
        @SerializedName("MaterialGroup")
        private MaterialGroupDTO materialGroup;
    
        @SerializedName("SupplierContact")
        private List<SupplierContactDTO> supplierContact;

谢谢大家，喜欢的可以持续关注哦！