当前位置:

首页 > 编程开发 > Jackson字段仅反序列化不序列化方法

Jackson字段仅反序列化不序列化方法

本文详细介绍了在Jackson库中如何实现对特定JSON字段的单向处理。通过利用@JsonProperty(access=JsonProperty.Access.WRITE_ONLY)注解,开发者可以确保某个字段在从JSON字符串反序列化为Java对象时被正确读取,而在将Java对象序列化回JSON字符串时则被自动忽略。这在处理RESTAPI响应与请求体中字段行为差异时尤为实用,避免了手动干预,提升了代码的简洁性和健壮性。

本文目录

    Jackson库中实现字段的单向处理:仅反序列化不序列化

    本文详细介绍了在Jackson库中如何实现对特定JSON字段的单向处理。通过利用@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)注解,开发者可以确保某个字段在从JSON字符串反序列化为Java对象时被正确读取,而在将Java对象序列化回JSON字符串时则被自动忽略。这在处理REST API响应与请求体中字段行为差异时尤为实用,避免了手动干预,提升了代码的简洁性和健壮性。

    Jackson中字段序列化与反序列化挑战

    在构建基于RESTful API的应用程序时,我们经常会遇到这样的场景:从服务器接收的JSON数据中包含某个标识符(如id),我们需要将其反序列化到Java对象中进行业务逻辑处理。然而,在将该Java对象作为请求体发送回服务器时,这个id字段可能需要被忽略,因为服务器通常会在创建或更新资源时自动生成或管理id。

    例如,当获取一个产品信息时,JSON可能包含id和name:

    {
      "id": "1",
      "name": "Product1"
    }

    但在创建或更新产品时,我们通常只发送name,而id则不应出现在请求体中:

    {
      "name": "Product1"
    }

    Jackson库默认的序列化和反序列化行为是双向的,即一个字段如果能被反序列化,通常也能被序列化。如果直接使用@JsonIgnore,则该字段在序列化和反序列化时都会被忽略,这不符合我们的需求。我们需要一种机制,让id字段在反序列化时有效,而在序列化时无效。

    解决方案:@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)

    Jackson库提供了@JsonProperty注解的access属性,可以精确控制字段的序列化和反序列化行为。针对上述需求,我们可以使用JsonProperty.Access.WRITE_ONLY。

    JsonProperty.Access.WRITE_ONLY的含义是:

    • 反序列化(Deserialization):当JSON字符串转换为Java对象时,Jackson会读取对应的JSON字段并将其值写入Java对象的该属性中。
    • 序列化(Serialization):当Java对象转换为JSON字符串时,Jackson会忽略该属性,不会将其包含在生成的JSON中。

    简而言之,对于Jackson处理器而言,这个字段是“只写”的,即只能从JSON写入到Java对象,而不能从Java对象读取并写入到JSON。

    实战示例

    下面通过一个具体的Product类示例来演示如何使用@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)来实现单向处理。

    首先,定义Product类:

    import com.fasterxml.jackson.annotation.JsonProperty;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.SerializationFeature;
    
    public class Product {
    
        // id 字段在反序列化时可读(从JSON写入对象),但在序列化时将被忽略(不从对象写入JSON)
        @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
        private String id;
        private String name;
    
        // 构造函数
        public Product() {}
    
        public Product(String id, String name) {
            this.id = id;
            this.name = name;
        }
    
        // Getter 和 Setter 方法
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "Product{id='" + id + "', name='" + name + "'}";
        }
    
        public static void main(String[] args) throws Exception {
            ObjectMapper mapper = new ObjectMapper();
            // 启用美化输出,方便查看
            mapper.enable(SerializationFeature.INDENT_OUTPUT);
    
            // 1. 从包含id的JSON字符串反序列化为Java对象
            String incomingJson = """
                {
                    "id": "123",
                    "name": "Laptop Pro"
                }
                """;
    
            System.out.println("--- 反序列化测试 ---");
            Product product = mapper.readValue(incomingJson, Product.class);
            System.out.println("反序列化后的Java对象: " + product);
            // 验证id是否被正确读取
            System.out.println("Java对象中的ID: " + product.getId()); 
    
            // 2. 将Java对象序列化回JSON字符串
            // 此时,product对象中的id值为"123"
            System.out.println("\n--- 序列化测试 ---");
            String resultJson = mapper.writeValueAsString(product);
            System.out.println("序列化后的JSON字符串:\n" + resultJson);
        }
    }

    运行结果:

    --- 反序列化测试 ---
    反序列化后的Java对象: Product{id='123', name='Laptop Pro'}
    Java对象中的ID: 123
    
    --- 序列化测试 ---
    序列化后的JSON字符串:
    {
      "name" : "Laptop Pro"
    }

    从输出结果可以看到,当我们将包含id的JSON字符串反序列化为Product对象时,id字段被成功读取并赋值给Java对象的id属性。然而,当我们将这个Product对象序列化回JSON字符串时,id字段被自动忽略,生成的JSON中只包含name字段。这完美地实现了我们对字段的单向处理需求。

    JsonProperty.Access 枚举详解

    JsonProperty.Access枚举提供了四种模式,用于更细粒度地控制字段的访问权限:

    • READ_WRITE (默认):字段在序列化和反序列化时都有效。这是Jackson的默认行为。
    • READ_ONLY:字段只在序列化时有效(从Java对象读取到JSON),在反序列化时会被忽略(不从JSON写入到Java对象)。
      • 例如,一个计算属性,只希望在输出JSON中显示,而不允许外部通过JSON修改。
    • WRITE_ONLY:字段只在反序列化时有效(从JSON写入到Java对象),在序列化时会被忽略(不从Java对象读取到JSON)。
      • 本文示例中使用的就是这种模式,适用于API请求体中包含、响应体中不包含的字段。
    • AUTO:Jackson根据字段的可见性、是否存在Getter/Setter方法等自动推断访问权限。在大多数情况下,AUTO的行为与READ_WRITE相似,但提供了更大的灵活性,尤其是在与@JsonAutoDetect等注解配合使用时。

    与@JsonIgnore的区别:@JsonIgnore注解会使Jackson在序列化和反序列化时都完全忽略该字段,除非通过其他方式(如@JsonInclude、@JsonSetter等)明确覆盖。而@JsonProperty(access = ...)则提供了更精细的控制,允许在序列化和反序列化之间选择性地启用或禁用字段。当只需要在单向操作中忽略字段时,access属性是更优的选择。

    应用场景与注意事项

    1. REST API设计:
      • 创建/更新资源:请求体中可能包含一些只用于写入(如密码、临时ID)的字段,这些字段不应在响应中返回。
      • 响应体优化:响应体中可能包含一些只用于读取(如服务器生成的ID、状态)的字段,这些字段不应在客户端发送的请求体中出现。
    2. 数据模型差异处理:当一个Java对象模型需要适应不同外部系统(如数据库、消息队列、不同版本的API)对JSON字段的不同期望时,access属性非常有用。
    3. 与其他Jackson注解的协同:@JsonProperty(access = ...)可以与其他Jackson注解(如@JsonFormat, @JsonInclude等)协同工作,共同构建复杂的数据映射逻辑。
    4. 可读性与维护性:明确使用access属性可以提高代码的可读性,清晰地表达字段的预期行为,减少因默认行为误解而导致的错误。

    总结

    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)是Jackson库中一个强大且实用的特性,它为开发者提供了对JSON字段序列化和反序列化行为的精细控制。通过合理利用此注解,我们可以优雅地处理API设计中常见的字段单向处理需求,避免了手动干预和复杂的自定义序列化器/反序列化器,从而提升了代码的简洁性、健壮性和可维护性。在设计和实现与JSON交互的Java应用程序时,深入理解并善用JsonProperty.Access枚举将大大提高开发效率。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    AG2 1.3.2的输入Token为何变多,旧ACP版本还能用吗
    AG2 1.3.2的输入Token为何变多,旧ACP版本还能用吗

    AG2 1.3.2统一缓存Token统计并更新ACP1.x依赖;解释预算提前触达、报表口径与Python3.15构建限制。

    llama.cpp b12433怎样为AMD奇数列保留MUL_MAT_ID回退路径
    llama.cpp b12433怎样为AMD奇数列保留MUL_MAT_ID回退路径

    llama.cpp b12433避免AMD设备将奇数src0列送入需要偶数列的MMVF路径:满足偶数条件才保留MMVF,其他形状沿用既有回退。对应改动发生在MUL_MAT_ID处理和相关同步判断中,范围限定于代码说明中的类型与token条件。

    Ducter 0.0.58如何区分下一步消息、完成后消息与后台会话
    Ducter 0.0.58如何区分下一步消息、完成后消息与后台会话

    Ducter 0.0.58调整任务阅读、执行中消息和后台会话,区分下一步发送与做完再说,并说明tailnet HTTPS辅助的条件。

    Unlimited OCR 2在TextMind能否直接使用,账号权限与模型示例如何区分
    Unlimited OCR 2在TextMind能否直接使用,账号权限与模型示例如何区分

    Unlimited OCR 2官方确认百度智能云TextMind渠道;区分云端入口、账号权限配额与本地模型部署,避免混淆接口和计费条件。

    TensorFold 1.2.9的Ollama接口和服务配置文件怎么用
    TensorFold 1.2.9的Ollama接口和服务配置文件怎么用

    TensorFold 1.2.9的服务配置文件用于保存和复用启动参数,Ollama兼容API则在同一推理路径上提供聊天、生成和模型查询等接口。理解配置优先级及后端限制,比只看到“兼容”就直接迁移全部流量更有用。

    如何理解Univer 1.5.2的二次混淆移除与构建边界?
    如何理解Univer 1.5.2的二次混淆移除与构建边界?

    理解Univer 1.5.2的关键,是把额外混淆与构建压缩分开。本版删除二次混淆插件及相关配置,同时保留Pro模块的minify设置;它解释的是产物处理方式的变化,不代表增加了表格或公式能力。

    Open Code Review 1.13.10的续跑和比较侧代码访问怎么用
    Open Code Review 1.13.10的续跑和比较侧代码访问怎么用

    Open Code Review 1.13.10新增工作区模式的--resume支持,并在仅指定--from时把--to默认设为HEAD。它还支持访问比较侧代码,改进Markdown摘要和进度输出;这些变化分别涉及会话延续、比较范围、代码上下文与终端展示。

    browser-use 1.0.6默认模型费用为何变化,如何保留原配置
    browser-use 1.0.6默认模型费用为何变化,如何保留原配置

    browser-use 1.0.6更换未传llm时的默认模型和推理档位;显式选择bu-fast并按任务读取真实用量费用。

    Claude Sonnet 5.5与Claude Fable 5.2错误恢复后,四类产品影响范围怎么看
    Claude Sonnet 5.5与Claude Fable 5.2错误恢复后,四类产品影响范围怎么看

    Claude Sonnet 5.5与Claude Fable 5.2错误升高事故的恢复覆盖claude.ai、Claude API、Claude Code和Claude Cowork,影响窗口为2026年11月16日北京时间15:32至16:45。这份恢复结论针对事故r1b4f9bbnsx1,不表示每位用户都曾中断,也不表示其他独立事故全部恢复。

    llama.cpp b12432测试构建改善了哪些KV缓存管理行为?
    llama.cpp b12432测试构建改善了哪些KV缓存管理行为?

    llama.cpp b12432预发布构建利用位置索引减少KV序列删除扫描;解释官方函数微基准、删除边界测试及生产评估限制。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。