当前位置：首页 > article >正文

JsonAutoDetect.Visibility

article 2025/3/23 11:23:16

JsonAutoDetect.Visibility 是 Jackson 库中的一个枚举类型，用于控制哪些 Java 对象的属性或方法可以被自动检测并序列化或反序列化。以下是 JsonAutoDetect.Visibility 中各个参数的用法与作用：

1. ANY

作用：允许任何访问修饰符（包括 private 、 protected 、 default 和 public ）的属性和方法被自动检测。
示例 :

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)
class Example {
    private String privateField;
    // 其他代码
}

在这个例子中， privateField 会被自动检测并序列化。

2. NON_PRIVATE

作用：允许非 private 访问修饰符（ protected 、 default 和 public ）的属性和方法被自动检测。
示例：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NON_PRIVATE)
class Example {
    private String privateField; // 不会被检测
    protected String protectedField; // 会被检测
    // 其他代码
}

3. PROTECTED_AND_PUBLIC

作用：允许 protected 和 public 访问修饰符的属性和方法被自动检测。
示例：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC)
class Example {
    private String privateField; // 不会被检测
    protected String protectedField; // 会被检测
    public String publicField; // 会被检测
    // 其他代码
}

4. PUBLIC_ONLY

作用：只允许 public 访问修饰符的属性和方法被自动检测。
示例：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.PUBLIC_ONLY)
class Example {
    private String privateField; // 不会被检测
    protected String protectedField; // 不会被检测
    public String publicField; // 会被检测
    // 其他代码
}

5. NONE

作用：不允许任何属性和方法被自动检测。需要使用 @JsonProperty 等注解来明确指定哪些属性或方法需要序列化或反序列化。
示例：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
class Example {
    @JsonProperty("field")
    private String privateField; // 需要 @JsonProperty 注解才能被检测
    // 其他代码
}

6. DEFAULT

作用：使用默认的可见性规则，通常等同于 PUBLIC_ONLY 。
示例：

@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.DEFAULT)
class Example {
    private String privateField; // 不会被检测
    public String publicField; // 会被检测
    // 其他代码
}