如何让XStream在解析XML时跳过未映射的标签？

Question

我有一个大型 XML 文档，想要将其转换为 Java bean。它有很多标签和属性，但我只对其中的一小部分感兴趣。不幸的是，XStream 似乎强制您在该 bean 中为该 XML 中可能存在的每个标签声明一个属性。有办法解决这个问题吗？

Answer 1

如下所示初始化 XStream 以忽略 Bean 中未定义的字段。

XStream xstream = new XStream() {
    @Override
    protected MapperWrapper wrapMapper(MapperWrapper next) {
        return new MapperWrapper(next) {
            @Override
            public boolean shouldSerializeMember(Class definedIn, String fieldName) {
                if (definedIn == Object.class) {
                    return false;
                }
                return super.shouldSerializeMember(definedIn, fieldName);
            }
        };
    }
};

Answer 2

XStream 1.4.5让您轻松处理未知标签。使用 ignoreUnknownElements() 对于尚未实现或已被删除的标签，并且您正在处理旧的 xml。您还可以指定要忽略的特定标签。

---

Answer 3

自 XStream 1.4.5 起，在编组器声明期间使用ignoreEnknownElements() 方法就足够了：

XStreamMarshaller marshaller = new XStreamMarshaller();
marshaller.getXStream().ignoreUnknownElements();
...

忽略不必要的元素。

Answer 4

我今天一直在解决这个问题，我发现使用 return this.realClass(fieldName) != null; 并不是（总是）一个可行的解决方案 然而实际上 XStream 有一种方法可以跳过未映射的标签并同时使用隐式集合。

为什么realClass(fieldName)事情不起作用

事实上，使用的技巧是

try {
    return this.realClass(fieldName) != null;
} catch (Throwable t) {
    return false;
}

有效的。它的作用是尝试通过标签名称猜测类型，看看是否成功，如果不成功，则返回 false。因此，它会完美地跳过像

<someUnknownTag>someContent</someUnknownTag>

BUT 这样的标签，但它只会在某些“不需要的”标签碰巧有一个有意义的名称时起作用（！），而 realClass(fieldName ) 实际上能够返回不等于 null 的内容，并且该标记不会是您的任何 ImplicitCollection 的成员。在这种情况下，如果知道可以定义 xml 元素的类，并且用户类型 XStream 中没有映射此类字段，则将决定“也许该元素来自某个隐式集合”。如果你的类中既没有这样的集合，也没有这样的字段，它很快就会失败。就我而言，有问题的 xml 片段是这样的：

<url>http://somewhere.com</url>

当然，既没有 Url url; 也没有 @XStreamImplicit List; url 在我的班级上。拥有这样的 XML 并使用“realClass”事物的结果如下：

com.thoughtworks.xstream.converters.ConversionException: Element url of type java.net.URL is not defined as field in type org.sample.xstream.SomeBean

正确的方法

正确的方法是从 shouldSerializeMemberfalse > 如果 defineIn == Object.class （不使用 realClass(fieldName) 东西）。

但仅使用 return false 是不够的。在这种形式下，它将导致 XStream 将隐式集合留空。

这里的技巧是确保使用 @XStreamImplicit(itemFieldName = "something") 而不是仅仅使用不带参数的 @XStreamImplicit，即使在标签名称和集合的情况下也是如此。通用参数类型具有相同的名称。

因此，正确的代码将如下所示：

    xstream = new XStream() {
        @Override
        protected MapperWrapper wrapMapper(MapperWrapper next) {
            return new MapperWrapper(next) {
                @Override
                public boolean shouldSerializeMember(Class definedIn, String fieldName) {
                    if (definedIn == Object.class) {
                        //This is not compatible with implicit collections where item name is not defined
                        return false;
                    } else {
                        return super.shouldSerializeMember(definedIn, fieldName);
                    }
                }
            };
        }
    };
    xsteam.processAnnotations(SomeRootEntry.class);

并且您需要确保在您的类中，您的隐式集合被标记为如下所示：

@XStreamImplicit(itemFieldName = "something")
private List <Something> somethingList;

请注意，即使 List 的泛型类型参数具有相同的名称，itemFieldName 也是显式指定的。这一点至关重要。

在这种情况下，遇到 标签时，XStream 甚至不会使用该 fieldName 访问您的 shouldSerializeMember。它只是提前知道该元素来自隐式集合。

当它再次遇到http://somewhere.com时将访问您的方法。但在这里我们是安全的，因为我们只是返回 false。

对我有用！尝试一下。

Answer 5

在 XStream 实例中使用 ignoreUnknownElements() 方法：

XStream xstream = new XStream();
xstream.ignoreUnknownElements();