当前位置: 首页 > java >正文

深入理解 @JsonGetter:精准掌控前端返回数据格式!

在 Java 后端开发中,我们常常会遇到这样一个问题:

💭 某个字段在后端需要保留原始格式进行业务处理,但返回给前端时希望转为另一种格式展示。

比如:你在数据库中保存的是 tokens = 12500(整型),但希望返回给前端的时候是 12.500(千分制,小数点后保留 3 位)。

这时候,Jackson 提供的注解 —— @JsonGetter 💡 就能大显身手!

🔍 什么是 @JsonGetter

@JsonGetter 是 Jackson 提供的序列化注解之一,作用是:

指定某个方法用于序列化字段时的 JSON 值获取逻辑

📌 也就是说,默认情况下 Jackson 会调用字段的 getter 方法(如 getTokens()),但如果你加上了 @JsonGetter("tokens"),它会优先使用你标注的方法作为序列化输出。

🛠 实际用法:原始字段用于业务,自定义方法用于 JSON 序列化

下面是一个实际场景示例:

public class TokenUsage {// 原始字段:单位是“个”,如 12500 个private String tokens;// 原始 getter 方法,供后端业务逻辑使用public String getTokens() {return tokens;}public void setTokens(String tokens) {this.tokens = tokens;}// 自定义 JSON 输出格式:返回千分单位,并保留 3 位小数@JsonGetter("tokens")public String getTokenRaw() {if (tokens == null) {return null;}// 精确计算,避免浮点误差BigDecimal value = new BigDecimal(tokens).divide(new BigDecimal(1000), 3, RoundingMode.HALF_UP);return value.setScale(3, RoundingMode.HALF_UP).toString();}
}

✅ 效果如下:

场景返回结果
后端使用 getTokens()返回 "12500"(字符串)
前端收到 JSON 响应返回 "12.500"

🚀 优势总结

优势 💡描述
🔄 保留后端原始数据不影响业务逻辑处理,原始 getter 可照常使用
🧪 精准控制前端格式自定义方法决定序列化样式
🧼 避免字段冗余无需新增冗余字段,仅通过注解控制输出
💥 与 @JsonIgnore@JsonProperty 兼容可组合使用,控制更灵活


❗注意事项

  • 方法名不一定要以 get 开头,只要加上 @JsonGetter("xxx"),序列化时就会使用它作为 xxx 字段的值。

  • 千万不要和原始字段名冲突,否则会出现双字段或冲突序列化的问题。

  • 一般只用于输出,如需控制输入格式,需配合 @JsonSetter@JsonProperty 使用。

📎 小贴士:增强阅读体验的小工具建议

为了让这个字段在 Swagger 或 OpenAPI 接口文档中也显示为处理后的格式,可考虑:

@ApiModelProperty(value = "令牌数(单位:千,保留3位小数)", example = "12.500")
@JsonGetter("tokens")
public String getTokenRaw() {// ...
}

 

🧩 总结一句话:

使用 @JsonGetter,你可以在不影响后端原始逻辑的前提下,优雅地控制前端 JSON 的展示格式


如果你想继续优化返回结构,比如返回对象中的多个字段进行统一格式转换,甚至封装公共转换器,我也可以为你提供完整的方案和代码模板!欢迎继续提问 🤝💬

http://www.xdnf.cn/news/14062.html

相关文章:

  • cpp 绑定方案大比拼
  • SpringBoot实现权限管理系统完整指南(附源码)
  • 【Code】COP FOR THE STRUCTURAL USE OF STEEL 2011 (2023 Edition)
  • SDPA(Scaled Dot-Product Attention)详解
  • CE 标志新门槛:智能门锁 EN 18031 认证合规路径与成本分析
  • 分布式锁模板工具类
  • 2025企业级BI产品评测和推荐
  • 在 WinForms 中制作无边框窗体通过鼠标拖动移动和调整大小,难点是我窗体上被标题栏和状态栏dock之后很难选中
  • 短视频矩阵系统开发实战:PHP实现SaaS独立部署
  • deepimagej-plugin开源程序是用于运行深度学习模型的 ImageJ 插件
  • 【解决方案】Kali 2022.3修复仓库密钥一键安装docker,docker compose
  • 开发环境与生产环境的 yml 文件与配置
  • 1分钟理解FreeRtos中的信号量知识
  • LeetCode - 387. 字符串中的第一个唯一字符
  • 一个简单的torch-cuda demo
  • Acrobat 首选项配置:从注册表到锁定机制
  • 【MPC】模型预测控制笔记 (2):约束MPC
  • C语言预处理命令详解
  • 第9章 表达式和运算符 笔记 待完善
  • 如何运营一个专业的体育比分网站
  • 2025年06月13日Github流行趋势
  • 【Photoshop】使用路径和形状制作印章
  • 基于51单片机的电机控制角度proteus仿真
  • 【IEEE/EI/Scopus检索】2025年第五届机器学习与大数据管理国际会议 (MLBDM 2025)
  • Streamlit 笔记
  • Google Drive·实现共享文件本地访问与编辑
  • sdk添加包,更新文件系统--万象奥科RK3506
  • 基于数字孪生的风光储一体化园区智能化管理解决方案
  • C++进阶—C++中的继承
  • 在云算力上使用Nginx对Gradio外链进行加速的方法