FastJson中@JSONField注解使用

àì夳堔傛蜴生んèń 2022-08-21 06:57 189阅读 0赞

最近做项目中，使用了json格式在服务器之间进行数据传输。但是发现json格式数据不符合JAVA中的变量定义规则，并且难以理解，因此需要在后台中做二次处理，将数据处理成我们系统中定义的格式。

思路：

  1. 1. 定义需要返回的bean,bean中定义需要返回的数据
  3.  2. 获取到需要处理的JSON字符串
  5. 3. 将JSON字符串转换为bean, 再将转换后的bean返回给客户端。

由于json中的key与bean中的属性不能匹配，因此在转换过程中出现了部分属性为null的情况。经过查看官方文档，发现可以使用@JSONField进行解释，但是并没有详细的使用说明。

@JSONField的作用对象:

  1. Field

    1. Setter 和 Getter方法

注：FastJson在进行操作时，是根据getter和setter的方法进行的，并不是依据Field进行。

介绍完@JSONField之后，针对以上场景,给出JAVA代码

一、作用Field

  1.    @JSONField作用在Field时，其name不仅定义了输入key的名称，同时也定义了输出的名称。代码如下:
  3. package org.java.json.fastjson.bean;
  5. import com.alibaba.fastjson.JSONObject;
  6. import com.alibaba.fastjson.annotation.JSONField;
  8. public class Person {
  10.     @JSONField(name="name")
  11.     private String name;
  13.     @JSONField(name="age")
  14.     private String age;
  16.     @JSONField(name="desc")
  17.     private String desc;
  19.     public String getName() {
  20.         return name;
  21.     }
  22.     public void setName(String name) {
  23.         this.name = name;
  24.     }
  25.     public String getAge() {
  26.         return age;
  27.     }
  28.     public void setAge(String age) {
  29.         this.age = age;
  30.     }
  31.     public String getDesc() {
  32.         return desc;
  33.     }
  34.     public void setDesc(String desc) {
  35.         this.desc = desc;
  36.     }
  38.     public void setNAME(String NAME) {
  39.         this.name = NAME;
  40.     }
  42.     public void setAGE(String AGE) {
  43.         this.age = AGE;
  44.     }
  46.     public void setDESC(String DESC) {
  47.         this.desc = DESC;
  48.     }
  50.     public String toString() {
  51.         return JSONObject.toJSONString(this);
  52.     }
  53. }
  58. package org.java.json.fastjson.json;
  60. import org.java.json.fastjson.bean.Person;
  61. import org.junit.Before;
  62. import org.junit.Test;
  64. import com.alibaba.fastjson.JSONObject;
  66. public class PersonTest {
  68.     private Person person;
  70.     /**
  71.      * 初始化对象
  72.      */
  73.     @Before
  74.     public void setUp() {
  75.         person = new Person();
  76.         person.setName("xianglj");
  77.         person.setAge("20");
  78.         person.setDesc("只是一个测试");
  79.     }
  81.     @Test
  82.     public void test() {
  83.         String jsonStr = JSONObject.toJSONString(person);
  84.         System.out.println("bean to json:" + jsonStr);
  86.         //改变json的key为大写
  87.         jsonStr = jsonStr.toUpperCase();
  89.         System.out.println("需要转换的json:" + jsonStr);
  90.         person = JSONObject.toJavaObject(JSONObject.parseObject(jsonStr), Person.class);
  91.         System.out.println("json to bean:" + person.getName());
  92.     }
  93. }

输出如下:

  1. bean to json:{"age":"20","desc":"只是一个测试","name":"xianglj"}
  2. 需要转换的json:{"AGE":"20","DESC":"只是一个测试","NAME":"XIANGLJ"}
  3. json to bean:null

从上面我们可以看出，当@JSONField作用在Fileld上时，定义了输入和输出，如果我们传输过来的json格式不符合这个格式时，则不能够正确转换。

二、作用在setter和getter方法上

顾名思义，当作用在setter方法上时，就相当于根据 name 到 json中寻找对应的值，并调用该setter对象赋值。

当作用在getter上时，在bean转换为json时，其key值为name定义的值。实例如下：

  1. <pre name="code" class="java">package org.java.json.fastjson.bean;
  3. import com.alibaba.fastjson.JSONObject;
  4. import com.alibaba.fastjson.annotation.JSONField;
  6. public class Product {
  8.     private String productName;
  9.     private String desc;
  10.     private String price;
  12.     @JSONField(name="name")
  13.     public String getProductName() {
  14.         return productName;
  15.     }
  17.     @JSONField(name="NAME")
  18.     public void setProductName(String productName) {
  19.         this.productName = productName;
  20.     }
  22.     @JSONField(name="desc")
  23.     public String getDesc() {
  24.         return desc;
  25.     }
  27.     @JSONField(name="DESC")
  28.     public void setDesc(String desc) {
  29.         this.desc = desc;
  30.     }
  32.     @JSONField(name="price")
  33.     public String getPrice() {
  34.         return price;
  35.     }
  37.     @JSONField(name="PRICE")
  38.     public void setPrice(String price) {
  39.         this.price = price;
  40.     }
  42.     public String toString() {
  43.         return JSONObject.toJSONString(this);
  44.     }
  46. }
  52. package org.java.json.fastjson.json;
  54. import org.java.json.fastjson.bean.Product;
  55. import org.junit.Test;
  57. import com.alibaba.fastjson.JSONObject;
  59. /**
  60.  * 对fastjson中的JSON转换做一个测试
  61.  * @author xianglj
  62.  */
  63. public class JsonObjectTest {
  65.     public static void main(String[] args) {
  66.         Product product = new Product();
  67.         product.setProductName("产品");
  68.         product.setDesc("这是一个产品");
  69.         product.setPrice("22.3");
  71.         String jsonStr = JSONObject.toJSONString(product);
  72.         System.out.println("转换为json:" + JSONObject.toJSONString(product));
  74.         //jsonStr = jsonStr.toUpperCase();
  75.         System.out.println(jsonStr);
  77.         product = JSONObject.toJavaObject(JSONObject.parseObject(jsonStr), Product.class);
  78.         System.out.println(product.toString());
  79.     }
  81.     @Test
  82.     public void test() {
  83.         Product product = new Product();
  84.         product.setProductName("产品");
  85.         product.setDesc("这是一个产品");
  86.         product.setPrice("22.3");
  88.         String jsonStr = JSONObject.toJSONString(product);
  89.         System.out.println("转换为json:" + JSONObject.toJSONString(product));
  91.         jsonStr = jsonStr.toUpperCase();
  92.         System.out.println(jsonStr);
  94.         product = JSONObject.toJavaObject(JSONObject.parseObject(jsonStr), Product.class);
  95.         System.out.println(product.toString());
  96.     }
  97. }

输出如下:

  1. 转换为json:{"desc":"这是一个产品","name":"产品","price":"22.3"}
  2. {"DESC":"这是一个产品","NAME":"产品","PRICE":"22.3"}
  3. {"desc":"这是一个产品","name":"产品","price":"22.3"}

有了这个注解之后，我们在转换bean时，就不需要在手工方式，为不能转换的属性进行赋值。即使以后返回数据反生变化，也能够快速的进行修改。不用修改大片代码。只需要修改注解name值就可以了。

这个注解使用就到这里，希望大家喜欢，支持。

发表评论

表情：
评论列表 （有 0 条评论，189人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Fastjson @JsonField注解使用

    【引言】 在开发中，不论是前后端联调，还是与第三方对接，有时候难免会遇到对方定义的json数据中的key值与自己后端定义的实体字段不一致的情况，也有时候会遇到前端传的日期数据

    清疚清疚/ 0 赞/ 487 阅读