百度360必应搜狗淘宝本站头条
mqtt服务器xftp6mybatiscollectionkeyerrorc#var
当前位置：网站首页 > 热门文章 > 正文

Fastjson妙用之@JSONField注解（fastjson中jsonpath）

bigegpt 2025-03-24 14:15 9 浏览

在开发的过程中使用json格式的地方非常多，现在前后端分离的项目中，前后端数据交换的格式一般为json，这种格式的优/缺点这里不再赘述，感兴趣的可以百度。把java中的实体类序列化为json的方式也有很多方式，今天来看看常用到的fastjson。

都知道fastjson是阿里开源的一个序列化/反序列化的jar包，在日常的开发过程中经常会碰到，也是使用频率较高的一款工具。

这里要了解一个概念，那就是序列化/反序列化，序列化是把一个java对象转化为其他的形式，如json、XML、对象字节；反序列化则是把json、XML、对象字节转化为java对象。

一、初识Fastjson

1、环境搭建

要想使用fastjson，首先需要引入fastjson的包，我这里使用的是maven工具，所以这里只要在pom文件中添加相应的依赖即可，


    
        com.alibaba
        fastjson
        1.2.78

2、一个小例子

有一个实体类，

package com.atssg.test;


import lombok.Data;

@Data
public class Student {
    private Integer id;
    private String name;
    private String address;
    private String phoneNumber;

}

下面看测试方法

package com.atssg.test;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class TestFastJson {
    public static void main(String[] args) {
        Student student=new Student();
        student.setId(1);
        student.setName("tom");
        student.setAddress("beijing");
        student.setPhoneNumber("010-6668899");

        //把对象转化为json串
        String jsonString=JSON.toJSONString(student);
        log.info("student序列化为：{}",jsonString);
    }
}

下面看测试结果

22:22:41.657 [main] INFO com.atssg.test.TestFastJson - student序列化为：{"address":"beijing","id":1,"name":"tom","phoneNumber":"010-6668899"}

Process finished with exit code 0

从上面可以看到打印除了序列化为json的字符串，这里是一个序列化的过程，当然也可以把一个字符串反序列化为java对象。

二、@JSONField注解

在上面的例子中，student被序列化为一个json字符串，字符串是键值对的形式，键是Student的属性名。

现在有这样的一个需求，要返回给前端Student的json字符串，但不想给前端phoneNumber字段，你要怎么做那？一个比较容易想到的方式是从字符串中把这个属性去掉，或者重新生成一个不包含phoneNumber的实体对象。难道没有更好的方式么

在fastjson提供了@JSONField这样一个注解。

1、@JSONField(serialize = false)

@JSONField注解中有seaialize这样一个属性，看名称应该和序列化有关，尝试下看看效果，

package com.atssg.test;


import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;

@Data
public class Student {
    private Integer id;
    private String name;
    private String address;
    @JSONField(serialize = false)
    private String phoneNumber;

}

再看上面的测试类的执行结果，

22:30:26.678 [main] INFO com.atssg.test.TestFastJson - student序列化为：{"address":"beijing","id":1,"name":"tom"}

Process finished with exit code 0

可以看到轻轻松松phoneNumber不见了，也就是说@JSONField(serialize=false)起作用了，该属性不会参与序列化，反之，不加该注解或serialize的值设为true，则会参与序列化。

2、@JSONField(name= "XXX")

在和前端的交互过程中，可能存在这样的情况，java类中定义的字段的形式为驼峰，但前端需要的是以_连接的形式，要怎么做那，在@JSONField中有name属性，

package com.atssg.test;


import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;

@Data
public class Student {
    private Integer id;
    private String name;
    private String address;
    @JSONField(name = "phone_number")
    private String phoneNumber;

}

在phoneNuber上注解@JSONField且name为phone_number，看测试结果，

21:47:48.766 [main] INFO com.atssg.test.TestFastJson - student序列化为：{"address":"beijing","id":1,"name":"tom","phone_number":"010-6668899"}

可以看到在序列化的json字符串中出现了phone_number，说明@JSONField起了作用，在序列化的时候指定序列化字段的名称，如果指定了使用指定的（@JSONField中name的值），如果不指定使用java类中属性的名字。

3、@JSONField注解

在上面，我们看了@JSONField的两种用法，还有很多用法，这里不一一列举，看下@JSONField这个注解的定义，

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package com.alibaba.fastjson.annotation;

import com.alibaba.fastjson.parser.Feature;
import com.alibaba.fastjson.serializer.SerializerFeature;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
public @interface JSONField {
    int ordinal() default 0;

    String name() default "";

    String format() default "";

    boolean serialize() default true;

    boolean deserialize() default true;

    SerializerFeature[] serialzeFeatures() default {};

    Feature[] parseFeatures() default {};

    String label() default "";

    boolean jsonDirect() default false;

    Class serializeUsing() default Void.class;

    Class deserializeUsing() default Void.class;

    String[] alternateNames() default {};

    boolean unwrapped() default false;

    String defaultValue() default "";
}

在这个注解上使用了@Target注解标注，@Target中的值为{ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}，也就是说@JSONField可以标注在方法上、字段、参数上。在上面的例子中，我们把@JSONField用在了字段上，下面看使用在方法上的例子，在一个类中有getXXX/setXXX方法，看@JSONField用在getXXX/setXXX的用法。

package com.atssg.test;


import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;

@Data
public class Student {
    private Integer id;
    private String name;
    private String address;

    private String phoneNumber;

    //getXXX方法用在序列化过程中
    @JSONField(serialize = false)
    public String getPhoneNumber() {
        return phoneNumber;
    }

    //setXXX方法用在反序列化过程中
    @JSONField(deserialize = false)
    public void setPhoneNumber(String phoneNumber) {
        this.phoneNumber = phoneNumber;
    }
}

看测试结果

21:59:28.334 [main] INFO com.atssg.test.TestFastJson - student序列化为：{"address":"beijing","id":1,"name":"tom"}

再来看反序列化的测试结果，测试类，

package com.atssg.test;

import com.alibaba.fastjson.JSON;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class TestFastJson {
    public static void main(String[] args) {
        Student student=new Student();
        student.setId(1);
        student.setName("tom");
        student.setAddress("beijing");
        student.setPhoneNumber("010-6668899");

        //把对象转化为json串
        String jsonString=JSON.toJSONString(student);
        log.info("student序列化为：{}",jsonString);
        //反序列化
        String str="{\"address\":\"beijing\",\"id\":1,\"name\":\"tom\",\"phoneNumber\":\"010-6668899\"}";
        Student stu=JSON.parseObject(str,Student.class);
        log.info("反序列化的结果：{}",stu);

    }
}

使用了含有phoneNumber的字符串，看反序列化的结果，

22:04:04.746 [main] INFO com.atssg.test.TestFastJson - student序列化为：{"address":"beijing","id":1,"name":"tom"}
22:04:04.776 [main] INFO com.atssg.test.TestFastJson - 反序列化的结果：Student(id=1, name=tom, address=beijing, phoneNumber=null)

可以看到phoneNumber的值为null，证明该属性未取得反序列化的值，证明了@JSONField用在setXXX方法上起到了反序列化的控制作用。

三、总结

本文分享了fastjson中@JSONField的用法，主要是在序列化/反序列化的过程中，主要体现在以下几个方面，

  • @JSONField用在字段上影响序列化/反序列化两个过程；
  • @JSONField用在setXXX、getXXX方法上，分别影响反序列化、序列化过程；

相关推荐

得物可观测平台架构升级:基于GreptimeDB的全新监控体系实践

一、摘要在前端可观测分析场景中，需要实时观测并处理多地、多环境的运行情况，以保障Web应用和移动端的可用性与性能。传统方案往往依赖代理Agent→消息队列→流计算引擎→OLAP存储...

warm-flow新春版:网关直连和流程图重构

本期主要解决了网关直连和流程图重构，可以自此之后可支持各种复杂的网关混合、多网关直连使用。-新增Ruoyi-Vue-Plus优秀开源集成案例更新日志[feat]导入、导出和保存等新增json格式支持...

扣子空间体验报告

在数字化时代，智能工具的应用正不断拓展到我们工作和生活的各个角落。从任务规划到项目执行，再到任务管理，作者深入探讨了这款工具在不同场景下的表现和潜力。通过具体的应用实例，文章展示了扣子空间如何帮助用户...

spider-flow:开源的可视化方式定义爬虫方案

spider-flow简介spider-flow是一个爬虫平台，以可视化推拽方式定义爬取流程，无需代码即可实现一个爬虫服务。spider-flow特性支持css选择器、正则提取支持JSON/XML格式...

solon-flow 你好世界!

solon-flow是一个基础级的流处理引擎（可用于业务规则、决策处理、计算编排、流程审批等......）。提供有“开放式”驱动定制支持，像jdbc有mysql或pgsql等驱动，可...

新一代开源爬虫平台:SpiderFlow

SpiderFlow：新一代爬虫平台，以图形化方式定义爬虫流程，不写代码即可完成爬虫。-精选真开源，释放新价值。概览Spider-Flow是一个开源的、面向所有用户的Web端爬虫构建平台，它使用Ja...

通过 SQL 训练机器学习模型的引擎

关注薪资待遇的同学应该知道，机器学习相关的岗位工资普遍偏高啊。同时随着各种通用机器学习框架的出现，机器学习的门槛也在逐渐降低，训练一个简单的机器学习模型变得不那么难。但是不得不承认对于一些数据相关的工...

鼠须管输入法rime for Mac

鼠须管输入法forMac是一款十分新颖的跨平台输入法软件，全名是中州韵输入法引擎，鼠须管输入法mac版不仅仅是一个输入法，而是一个输入法算法框架。Rime的基础架构十分精良，一套算法支持了拼音、...

Go语言 1.20 版本正式发布:新版详细介绍

Go1.20简介最新的Go版本1.20在Go1.19发布六个月后发布。它的大部分更改都在工具链、运行时和库的实现中。一如既往，该版本保持了Go1的兼容性承诺。我们期望几乎所...

iOS 10平台SpriteKit新特性之Tile Maps(上)

简介苹果公司在WWDC2016大会上向人们展示了一大批新的好东西。其中之一就是SpriteKitTileEditor。这款工具易于上手，而且看起来速度特别快。在本教程中，你将了解关于TileE...

程序员简历例句—范例Java、Python、C++模板

个人简介通用简介：有良好的代码风格，通过添加注释提高代码可读性，注重代码质量，研读过XXX，XXX等多个开源项目源码从而学习增强代码的健壮性与扩展性。具备良好的代码编程习惯及文档编写能力，参与多个高...

Telerik UI for iOS Q3 2015正式发布

近日，TelerikUIforiOS正式发布了Q32015。新版本新增对XCode7、Swift2.0和iOS9的支持，同时还新增了对数轴、不连续的日期时间轴等；改进TKDataPoin...

ios使用ijkplayer+nginx进行视频直播

上两节，我们讲到使用nginx和ngixn的rtmp模块搭建直播的服务器，接着我们讲解了在Android使用ijkplayer来作为我们的视频直播播放器，整个过程中，需要注意的就是ijlplayer编...

IOS技术分享|iOS快速生成开发文档(一)

前言对于开发人员而言，文档的作用不言而喻。文档不仅可以提高软件开发效率，还能便于以后的软件开发、使用和维护。本文主要讲述Objective-C快速生成开发文档工具appledoc。简介apple...

macOS下配置VS Code C++开发环境

本文介绍在苹果macOS操作系统下，配置VisualStudioCode的C/C++开发环境的过程，本环境使用Clang/LLVM编译器和调试器。一、前置条件本文默认前置条件是，您的开发设备已...

一周热门
最近发表
标签列表