编组为 XML/JSON 时是否可以使用 Jersey/JAX-RS 注释跳过类成员？

Question

很简单的问题。我正在使用 Jersey 来构建一个 REST 系统。如果我有一个类，其值在处理期间需要使用，但不想在编组类时作为 XML 或 JSON 输出的一部分发送，有没有办法忽略它？比如：

@XmlRootElement(name="example")
class Example {
    private int a;
    private String b;
    private Object c;

    @XmlElement(ignore=true)
    public int getA() { return a; }
    @XmlElement
    public String getB() { return b; }
    @Ignore
    public Object getC() { return c; }
    ... //setters, constructors, etc.
}

我希望像 ignore=true over getA() 或 @Ignore over getC() 这样的东西可以工作，但我找不到任何文档。

Answer 1

根据您要忽略的字段/属性的数量，有几个选项。

选项 #1 - @XmlTransient

如果您希望忽略不到一半的属性，那么我建议使用 @XmlTransient 注释它们。这会将它们从 XML 映射中排除。

@XmlRootElement
class Example {
    private int a;
    private String b;
    private Object c;

    @XmlTransient
    public int getA() { return a; } // UNMAPPED

    public String getB() { return b; } // MAPPED

    @XmlTransient    
    public Object getC() { return c; } // UNMAPPED

    ... //setters, constructors, etc.
}

选项 #2 - @XmlAccessorType(XmlAccessType.NONE)

如果您希望忽略一半以上的属性，我建议在类型级别使用@XmlAccessorType 注释来设置XmlAccessType.NONE。这将导致只有带注释的属性被映射到 XML。

@XmlRootElement
@XmlAccessorType(XmlAccessType.NONE)
class Example {
    private int a;
    private String b;
    private Object c;

    public int getA() { return a; } // UNMAPPED

    @XmlElement
    public String getB() { return b; } // MAPPED

    public Object getC() { return c; } // UNMAPPED

    ... //setters, constructors, etc.
}

更多信息

• http://blog.bdoughan.com/2012/04/jaxb-and-unmapped-properties.html