Java中 Fastjson2 自定义注解怎么结合 Filter 实现字段过滤

千晨同学_6332

千晨同学_6332

2026-07-14

366人浏览

原创

fastjson2 中通过自定义注解(如 @jsonignoreif)结合 objectwriterfilter 实现字段动态过滤:定义运行时保留的字段级注解,继承 objectwriterfilter 并在 accept 方法中反射解析注解条件,支持集成 jexl 等表达式引擎或简单规则判断,可通过 writerconfig 局部注册或全局配置,并利用 jsonwritercontext 传入上下文参数实现线程安全的运行时状态感知。

java中 fastjson2 自定义注解怎么结合 filter 实现字段过滤

Fastjson2 中自定义注解结合 Filter 实现字段过滤,核心是通过实现 ObjectWriterFilter 或 PropertyPreFilter,并在其中解析自定义注解(如 @JsonIgnoreIf)来动态决定是否序列化某个字段。

定义自定义注解

先创建一个运行时保留、作用于字段的注解,比如控制“在特定条件下忽略序列化”:

  • 注解需标注 @Retention(RetentionPolicy.RUNTIME) 和 @Target(ElementType.FIELD)
  • 可携带参数,例如布尔开关、条件表达式或环境标识
示例:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface JsonIgnoreIf {
    String value() default ""; // 如 "userRole == 'GUEST'"
    boolean condition() default true;
}

编写 Filter 解析注解逻辑

继承 ObjectWriterFilter,重写 accept 方法,在其中获取字段的注解并判断是否跳过:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • 通过 context.getObjectClass() 和 context.getFieldName() 定位当前字段
  • 用反射获取该字段上的 @JsonIgnoreIf 注解
  • 根据注解值(如表达式或简单布尔)执行判断,返回 false 表示过滤该字段
注意:Fastjson2 不内置表达式引擎,若需复杂条件(如 userRole == 'GUEST'),需集成 JEXL、Aviator 等轻量表达式库,或只支持简单规则(如枚举值匹配、环境变量判断)。

注册 Filter 到 Writer 配置

Filter 需绑定到 JSONWriter 或全局配置中:

  • 局部使用:调用 JSON.toJSONString(obj, writerConfig),其中 writerConfig.setObjectWriterFilter(yourFilter)
  • 全局设置:通过 JSONFactory.getDefaultWriterContext().setObjectWriterFilter(...)
  • 也可在 @JSONType 中指定 writerFilter 类,但仅对标注类生效

配合 JSONWriterContext 实现上下文感知

如果过滤逻辑依赖运行时状态(如当前用户权限、请求场景),可通过 JSONWriterContext 传入上下文参数:

  • 在序列化前,用 writerConfig.setAttribute("currentUserRole", "GUEST")
  • Filter 中通过 context.getAttribute("currentUserRole") 获取并参与判断
  • 避免静态变量或 ThreadLocal,保持线程安全和可测试性

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9837

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6962

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6152

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1064

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

888

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1296

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2569

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19911

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1155

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习