怎么利用 Jackson 的 JsonView 注解实现在同一个领域模型上针对不同接口的字段权限控制

大瑶小哥_5696

大瑶小哥_5696

2026-04-23

996人浏览

原创

不能。JsonView仅声明式控制序列化字段输出,不校验身份、不拦截非法访问、不阻止反序列化写入,需配合权限上下文才能实现真正的字段级权限控制。

怎么利用 jackson 的 jsonview 注解实现在同一个领域模型上针对不同接口的字段权限控制

JsonView 能不能直接控制字段权限? 不能。JsonView 本质是视图标记,不是权限系统——它只决定序列化时哪些字段参与输出,不校验调用方身份、不拦截非法访问、也不阻止反序列化阶段的字段写入。如果你期望“用户 A 调用 /api/user/profile 时看不到 email,但用户 B 调用 /api/admin/user/detail 时能看到”,@JsonView 可以配合 Spring MVC 的 @ResponseBody 实现前者(响应体裁剪),但后者需要额外的身份上下文判断,JsonView 本身不提供该能力。

它适合的场景是:同一 POJO 在不同接口返回不同子集,且视图划分与角色/权限存在稳定映射关系(例如所有管理员接口共用一个 View 类)。一旦权限逻辑变复杂(如“同为普通用户,VIP 用户可见 phone,非 VIP 不可见”),就该换策略了。

怎么定义和使用 JsonView 类? View 类只需是空的标记类(或接口),无需继承、实现任何东西,Jackson 只认类名和继承关系:
public class Views {
    public static class Public {}
    public static class Internal extends Public {}
    public static class Admin extends Internal {}
}

然后在字段或 getter 上标注:

public class User {
    @JsonView(Views.Public.class)
    private String username;

    @JsonView(Views.Internal.class)
    private String email;

    @JsonView(Views.Admin.class)
    private String lastLoginIp;
    
    // 注意:未标注 @JsonView 的字段默认不参与任何视图
}

控制器里通过 @JsonView 指定当前接口生效的视图:

@GetMapping("/profile")
@JsonView(Views.Public.class)
public User getProfile() { ... }

@GetMapping("/admin/detail")
@JsonView(Views.Admin.class)
public User getAdminDetail() { ... }

关键点:

  • 视图类之间用继承表达包含关系(Admin extends Internal 表示 Admin 视图会包含 Internal 标记的字段)
  • 一个字段可标注多个 @JsonView,用数组形式:@JsonView({Views.Public.class, Views.Internal.class})
  • 如果 controller 方法返回的是 ResponseEntity,@JsonView 依然生效;但若手动调用 ObjectMapper.writeValue(),必须显式传入 SerializationConfig 或用 objectMapper.writerWithView(Views.Public.class)

为什么有些字段没被序列化,但也没报错? 常见原因有三个:

一是字段没加任何 @JsonView,而方法级用了 @JsonView —— Jackson 默认只输出被该视图显式声明的字段,其余全过滤掉,不会警告也不会报错。

二是用了 @JsonIgnore 或 @JsonIgnoreProperties,它们优先级高于 @JsonView,一旦存在,该字段永远不出现在 JSON 中,无论视图如何设置。

三是 getter 方法和字段同时存在,但只在字段上加了 @JsonView,而 Jackson 默认按 getter 读取(除非配置 MapperFeature.USE_GETTERS_AS_SETTERS = false)。结果就是字段注解无效,getter 没注解 → 字段被忽略。

cn-json-diff
cn-json-diff

比较两个 JSON 文件并显示差异。支持嵌套结构、数组及值变更。纯 Python 标准库实现,无需 API 密钥。

下载

解决办法统一:统一在 getter 上标注 @JsonView,或关闭 getter 优先策略并确保字段注解存在。

JsonView 和 @JsonInclude(NON_NULL) 冲突吗? 不冲突,但行为有叠加效应。假设字段 email 为 null,且标注了 @JsonView(Views.Internal.class):

如果接口用 @JsonView(Views.Public.class),email 直接不出现(视图过滤优先);

如果接口用 @JsonView(Views.Internal.class),但全局配置了 @JsonInclude(JsonInclude.Include.NON_NULL),那么 email: null 不会出现——因为先过视图筛选,再过包含策略。

注意:视图筛选发生在序列化早期,@JsonInclude 是后期值判断,二者不在同一层。所以不要指望用 @JsonInclude 替代视图控制字段可见性。

真正容易被忽略的是:JsonView 对反序列化(JSON → Java 对象)默认不生效。也就是说,即使你用 @JsonView(Views.Public.class) 标记了 controller 方法,POST 进来的 JSON 里如果包含 email 字段,它仍可能被绑定到对象中——除非你额外配置 @JsonView 在参数上,并启用反序列化视图支持(需 DeserializationFeature.USE_VIEWS 开启,且较易出坑,一般不建议用于权限控制)。

相关专题

更多
java
java

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

2023.06.15

11877

6

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

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

2023.07.05

8962

9

java自学难吗
java自学难吗

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

2023.07.31

7672

8

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

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

2023.08.01

1264

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1516

5

java有什么用
java有什么用

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

2023.08.02

3109

5

java在线网站
java在线网站

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

2023.08.03

20351

3

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

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

2023.08.03

1355

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.3万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习