如何通过单元测试 exp serialVersionUID 覆盖私有静态最终类成员

Question

我正在添加单元测试以涵盖遗留的 java 项目（我无法更改），

我知道如何对这个类进行单元测试和覆盖，我通过在下面添加单元测试来做到这一点。

public class Thing implements Serializable {

    private static final long serialVersionUID = -1463850548670691860L;

    private String id;
}

举个例子：

class ThingTest {

    @Test
    void testShouldNotChangeSerialVersionUID() throws NoSuchFieldException {
        final Field serialVersionUID = Thing.class.getDeclaredField("serialVersionUID");
        serialVersionUID.setAccessible(true);

        assertEquals(-1463850548670691860L, getField(serialVersionUID, new Thing()));
    }
}

但 sonar 和 jacoco 将 serialVersionUID 显示为未涵盖。这是声音。

您能否提出一个解决方案，通过覆盖该领域来使声纳满意。

是的，我知道，我不应该遵循工具，而是遵循实践。

其他约束，我无法更改 serialVersionUID 的可见性。

谢谢

Answer 1

如果在您的 JUnit 中扩展 ObjectInputString，您可以在反序列化您序列化的对象时读取 serialVersionUID：

     private class MyObjectInputStream extends ObjectInputStream {

        public long uid;

        public MyObjectInputStream(InputStream in) throws IOException {
            super(in);
        }

        @Override
        protected ObjectStreamClass readClassDescriptor() throws IOException, ClassNotFoundException {
            ObjectStreamClass readClassDescriptor = super.readClassDescriptor(); //To change body of generated methods, choose Tools | Templates.
            uid = readClassDescriptor.getSerialVersionUID();
            return readClassDescriptor;
        }



    }

    @Test
    public void testSomeMethod() throws IOException, ClassNotFoundException {
        ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
        ObjectOutputStream oos = new ObjectOutputStream(byteArrayOutputStream);
        oos.writeObject(new Thing());
        MyObjectInputStream myObjectInputStream = new MyObjectInputStream(new ByteArrayInputStream(byteArrayOutputStream.toByteArray()));
        myObjectInputStream.readObject();
        assertEquals(-1463850548670691860L, myObjectInputStream.uid);
    }

Answer 2

您的测试覆盖率系统说“在您的单元测试期间没有人访问过这个字段”。这就是红条的意思。因此，要让它消失，您需要运行访问该字段的代码。使用反射访问字段来增加单元测试覆盖率是无稽之谈。尽管它可能会将字段变为绿色，但实际上并没有以有意义的方式使用该字段。

这样做的正确方法是以使用该字段的方式练习测试类。在序列化/反序列化期间使用 serialVersionUID 来确定正在读取的字节是否与您尝试实例化的对象匹配。

这是一个简单的示例，涵盖了您想要的内容。我在最后添加了一个相等测试，因为当您担心序列化/反序列化过程时，这真的应该测试。

package org.does.not.exist;

import org.junit.jupiter.api.Test;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;

import static org.assertj.core.api.Assertions.assertThat;

class Foo implements Serializable {
     private static final long serialVersionUID = 42L;

    public Foo(String value) {
        this.value = value;
    }

    private String value;

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Foo)) return false;

        Foo foo = (Foo) o;

        return value != null ? value.equals(foo.value) : foo.value == null;
    }

    @Override
    public int hashCode() {
        return value != null ? value.hashCode() : 0;
    }
}

class StackoverflowTest {

    @Test
    void test() throws Exception {
        Foo foo = new Foo("a string!");

        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        ObjectOutputStream out = new ObjectOutputStream(bos);
        out.writeObject(foo);

        ByteArrayInputStream bis = new ByteArrayInputStream(bos.toByteArray());
        ObjectInputStream in = new ObjectInputStream(bis);
        Foo copied = (Foo) in.readObject();

        assertThat(foo).isEqualTo(copied);
    }
}

按照上面的方法做，但是用你自己的类替换 Foo，你应该得到覆盖。