首页 > Java > java教程 > 正文

Java API中隐藏关联对象敏感数据:@JsonProperty与序列化策略

DDD
发布: 2025-10-26 10:05:02
原创
750人浏览过

Java API中隐藏关联对象敏感数据:@JsonProperty与序列化策略

本文旨在探讨在java restful api中如何有效隐藏嵌套关联对象中的敏感数据。我们将重点介绍利用jackson库的`@jsonproperty`注解,特别是结合`jsonproperty.access.write_only`属性,在数据传输对象(dto)层面上实现精确的序列化控制。同时,也将讨论在父级dto中定制子级dto序列化的替代方案及其潜在风险,并给出最佳实践建议。

在构建RESTful API时,返回给客户端的数据通常涉及多个关联对象。例如,一个账单(BillsDto)可能包含用户信息(UserDto)。然而,并非所有关联对象的字段都适合直接暴露给客户端,尤其是像用户密码、年龄等敏感信息。如何在不修改业务逻辑的前提下,有效控制这些嵌套敏感字段的序列化,是API设计中的一个重要考量。

核心策略:在嵌套DTO中应用@JsonProperty

Jackson是Spring Boot等框架中常用的JSON处理库,它提供了强大的注解机制来控制对象的序列化和反序列化行为。对于隐藏嵌套对象中的敏感数据,最推荐且最直接的方法是在嵌套对象本身的DTO类中应用@JsonProperty注解。

当一个UserDto被其他DTO(如BillsDto)引用时,UserDto中定义的序列化策略会直接影响其作为嵌套对象时的行为。@JsonProperty注解的access属性允许我们精细控制字段的读写权限。通过设置access = JsonProperty.Access.WRITE_ONLY,我们可以指定该字段在反序列化(写入)时可用,但在序列化(读取/输出)时被忽略。

以下是UserDto应用此策略的示例:

立即学习Java免费学习笔记(深入)”;

import com.fasterxml.jackson.annotation.JsonProperty;

public class UserDto {

    private String number_id;
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    private String username;
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    private String password;
    private String firstName;
    private String lastName;
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    private String age;

    // Getters and Setters
    public String getNumber_id() { return number_id; }
    public void setNumber_id(String number_id) { this.number_id = number_id; }
    public String getUsername() { return username; }
    public void setUsername(String username) { this.username = username; }
    public String getPassword() { return password; }
    public void setPassword(String password) { this.password = password; }
    public String getFirstName() { return firstName; }
    public void setFirstName(String firstName) { this.firstName = firstName; }
    public String getLastName() { return lastName; }
    public void setLastName(String lastName) { this.lastName = lastName; }
    public String getAge() { return age; }
    public void setAge(String age) { this.age = age; }
}
登录后复制

在上述UserDto中,username、password和age字段被标记为WRITE_ONLY。这意味着当UserDto对象被序列化为JSON时(例如,在BillsDto中作为嵌套字段),这些字段将不会出现在JSON输出中。而当从JSON反序列化为UserDto时,这些字段仍然可以被解析并设置。

BillsDto示例:

import java.util.Date;

public class BillsDto {

    private String numberBills;
    private double amount;
    private Date deadlinePayment;
    private UserDto user; // UserDto中的敏感字段将自动隐藏

    // Getters and Setters
    public String getNumberBills() { return numberBills; }
    public void setNumberBills(String numberBills) { this.numberBills = numberBills; }
    public double getAmount() { return amount; }
    public void setAmount(double amount) { this.amount = amount; }
    public Date getDeadlinePayment() { return deadlinePayment; }
    public void setDeadlinePayment(Date deadlinePayment) { this.deadlinePayment = deadlinePayment; }
    public UserDto getUser() { return user; }
    public void setUser(UserDto user) { this.user = user; }
}
登录后复制

当BillsDto被序列化时,user字段内部的username、password和age将不会出现在最终的JSON输出中。

替代方案:通过父级DTO定制序列化

有时,由于某些限制,可能无法直接修改嵌套DTO(如UserDto)。在这种情况下,可以考虑在父级DTO(如BillsDto)中通过自定义序列化器来控制嵌套对象的序列化行为。这通常涉及使用@JsonSerialize注解,并为其指定一个自定义的JsonSerializer实现。

序列猴子开放平台
序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

序列猴子开放平台0
查看详情 序列猴子开放平台

实现思路:

  1. 创建一个UserDtoSerializer类,继承JsonSerializer<UserDto>。
  2. 在serialize方法中,手动构建UserDto的JSON表示,只包含需要暴露的字段。
  3. 在BillsDto的user字段上使用@JsonSerialize(using = UserDtoSerializer.class)。

示例(概念性,不推荐):

// 自定义UserDto序列化器 (概念性代码,不推荐作为首选方案)
public class UserDtoSerializer extends JsonSerializer<UserDto> {
    @Override
    public void serialize(UserDto user, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartObject();
        gen.writeStringField("number_id", user.getNumber_id());
        gen.writeStringField("firstName", user.getFirstName());
        gen.writeStringField("lastName", user.getLastName());
        // 敏感字段不写入
        gen.writeEndObject();
    }
}

// BillsDto中应用自定义序列化器
public class BillsDto {
    // ... 其他字段
    @JsonSerialize(using = UserDtoSerializer.class)
    private UserDto user;
    // ... Getters and Setters
}
登录后复制

注意事项:

尽管这种方法在技术上可行,但它存在显著的缺点和潜在风险:

  • 维护成本高: 如果UserDto在多个父级DTO中被引用,每个父级DTO都需要单独配置或实现自定义序列化器,容易造成代码冗余和不一致。
  • 易出错: 开发者可能忘记在某个引用UserDto的地方应用自定义序列化器,从而导致敏感数据意外泄露。
  • 职责不清: 对象的序列化策略应尽可能地由对象本身定义,而不是由其消费者定义。将序列化逻辑分散到父级DTO中,违反了单一职责原则。

因此,除非有非常特殊的理由,否则不建议将此方法作为首选。

最佳实践与总结

在Java API中处理嵌套关联对象的敏感数据序列化问题时,以下是推荐的最佳实践:

  1. 在源头控制: 始终优先在数据源头(即嵌套DTO本身,如UserDto)上应用序列化策略。使用@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)是实现此目标的简洁高效方法。这确保了无论UserDto在哪里被引用,其敏感字段都不会被序列化输出。
  2. 明确职责: 让DTO类自身负责定义其字段的序列化行为,这符合面向对象设计的原则,提高了代码的可维护性和可预测性。
  3. 考虑视图(Views)或投影(Projections): 对于更复杂的场景,如果同一个DTO在不同API或不同用户角色下需要暴露不同的字段集,可以考虑使用Jackson的@JsonView或Spring Data REST的投影(Projections)机制。这允许您定义不同的“视图”,并根据需要切换序列化规则,而无需修改DTO本身。
  4. 避免过度暴露: 始终秉持“最小权限原则”,只暴露客户端真正需要的数据。

综上所述,当需要在Java API中隐藏嵌套关联对象的敏感数据时,在嵌套DTO类中使用@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)是最高效、最安全且最易于维护的解决方案。它将序列化控制逻辑集中在数据定义处,有效避免了敏感数据泄露的风险,并提升了代码的健壮性。

以上就是Java API中隐藏关联对象敏感数据:@JsonProperty与序列化策略的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习
PHP中文网抖音号
发现有趣的

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号