如何处理 Findbugs“可序列化类中的非瞬态不可序列化实例字段”？

Question

考虑下面的课程。如果我对它运行 Findbugs，它会在第 5 行但不在第 7 行给我一个错误（“可序列化类中的非瞬态非可序列化实例字段”）。

1 public class TestClass implements Serializable {
2
3  private static final long serialVersionUID = 1905162041950251407L;
4
5  private Set<Integer> mySet;      // Findbugs error
6
7  private HashSet<Integer> myOtherSet;
8
9 }

这是正确的，因为 java.util.Set 从未在其层次结构中实现 Serializable 而 java.util.HashSet 实现了。 但是，最佳实践是针对接口而不是具体实现进行编码。

我怎样才能最好地处理这个问题？

我可以在第 3 行添加一个 @Suppresswarnings(justification="No bug", values="SE_BAD_FIELD")。我的实际代码中有很多集合和列表，我担心它会乱扔我的代码太多了。

有更好的方法吗？

Answer 1

我对可序列化类中的受保护字段发出高警告。为该字段添加瞬态解决了我的问题：

 protected transient Object objectName;

Answer 2

如果您使用 findbugs-maven-plugin 并且必须持久化一个字段，并且该字段是一个未实现 Serializable 接口的类，例如，一个具有在第 3 方中定义的类的字段。您可以手动为 findbugs 配置排除文件，

如果这是唯一的情况，请将其添加到排除文件中： pom：

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>findbugs-maven-plugin</artifactId>
    <version>3.0.3</version>
    <configuration>
          <xmlOutput>true</xmlOutput>
          <xmlOutputDirectory>target/findbugs/</xmlOutputDirectory>
          <excludeFilterFile>findbugs-exclude.xml</excludeFilterFile>
          <includeFilterFile>findbugs-include.xml</includeFilterFile>
          <failOnError>true</failOnError>
    </configuration>
...

exclude.xml：

<?xml version="1.0" encoding="UTF-8"?>
<FindBugsFilter>
    <Match>
        <Class name="com.xxx.Foo" /> 
        <Field type="org.springframework.statemachine.StateMachineContext"/>
    </Match>

实体：

@Entity
public class Foo extends Boo {
    StateMachineContext<A, B> stateMachineContext;

虽然我不明白为什么添加<Bug category="SE_BAD_FIELD"/> 不起作用。另外我不赞成@edu.umd.cs.findbugs.annotations.SuppressWarnings(justification="No bug", values="SE_BAD_FIELD")这种在字段上加注解的方案，因为构建工具最好不要穿透业务代码。maven plugin usage&findbugs filters both include and exclude

关于SE_BAD_FIELD: Non-transient non-serializable instance field in serializable class，我认为它不应该检查实体。因为，javax.persistence.AttributeConverter 提供了外部序列化字段的方法（实现 Serializable 是内部序列化方法）。

Answer 3

为您的内部表示使用具体的可序列化集，但让任何公共接口都使用 Set 接口。

public class TestClass implements Serializable {
    private static final long serialVersionUID = 1905162041950251407L;

    private HashSet<Integer> mySet;

    public TestClass(Set<Integer> s) {
        super();
        setMySet(s);
    }

    public void setMySet(Set<Integer> s) {
        mySet = (s == null) ? new HashSet<>() : new HashSet<>(s);
    }
}

Answer 4

不过，最好的做法是编写代码 反对接口而不是具体 实现。

我认为不，在这种情况下不是。 Findbugs 非常正确地告诉您，一旦您在该字段中具有不可序列化的Set 实现，您就有可能遇到NotSerializableException。这是你应该处理的事情。如何，这取决于你的类的设计。

• 如果这些集合在类中初始化并且从未从外部设置，那么我认为声明该字段的具体类型绝对没有问题，因为无论如何字段都是实现细节。请务必在公共接口中使用接口类型。
• 如果集合通过公共接口传递到类中，您必须确保它们实际上是Serializable。为此，请创建一个接口 SerializableSet extends Set, Serializable 并将其用于您的领域。然后，要么：
  • 在公共接口中使用SerializableSet，并提供实现它的实现类。
  • 检查通过instanceof Serializable 传递给类的集合，如果不是，则将它们复制到存在的东西中。

Answer 5

您可以通过将以下方法添加到您的类中来摆脱那些Critical 警告消息：

private void writeObject(ObjectOutputStream stream)
        throws IOException {
    stream.defaultWriteObject();
}

private void readObject(ObjectInputStream stream)
        throws IOException, ClassNotFoundException {
    stream.defaultReadObject();
}

Answer 6

我对集合字段使用 findbugs-exclude 过滤器：

<Match>
    <Field type="java.util.Map" />
    <Bug pattern="SE_BAD_FIELD" />
</Match>
<Match>
    <Field type="java.util.Set" />
    <Bug pattern="SE_BAD_FIELD" />
</Match>
<Match>
    <Field type="java.util.List" />
    <Bug pattern="SE_BAD_FIELD" />
</Match>

见http://findbugs.sourceforge.net/manual/filter.html

Answer 7

您可以使用捕获助手来确保传入的 Set 支持两个接口：

private static class SerializableTestClass<T extends Set<?> & Serializable> implements Serializable
{
    private static final long serialVersionUID = 1L;
    private final T serializableSet;

    private SerializableTestClass(T serializableSet)
    {
        this.serializableSet = serializableSet;
    }
}

public static class PublicApiTestClass
{
    public static <T extends Set<?> & Serializable> Serializable forSerializableSet(T set)
    {
        return new SerializableTestClass<T>(set);
    }
}

通过这种方式，您可以拥有一个强制执行 Serializable 的公共 API，而无需检查/要求特定的实现细节。

Answer 8

我知道这是一个已经回答的老问题，但其他人知道，如果您对序列化将修复您的 FindBugs 错误的特定字段不感兴趣，您可以将 Set<Integer> 字段设置为瞬态。

public class TestClass implements Serializable {

    private static final long serialVersionUID = 1905162041950251407L;
    private transient Set<Integer> mySet;

}

我更喜欢这种方法，而不是强制你的 API 的用户强制转换为你的具体类型，除非它只是内部的，那么 Michael Borgwardt 的回答更有意义。