使用 JUnit 测试多线程代码的新方法

目前，当我们测试多线程 Java 时，我们会通过尽可能多的线程来调用被测类。由于测试不是确定性的，因此我们尽可能多地重复此测试。

这种方法的缺点是，大多数情况下，我们的错误测试会成功，这使得调试多线程错误成为一场噩梦。因此，我开发了一个开源工具 vmlens，使 JUnit 测试的多线程 Java 确定性。并使调试更容易。

这个想法是为给定的测试执行所有可能的线程交织。并报告失败的线程交错，这使得调试成为可能。

并发计数器的测试
以下示例演示如何使用 vmlens 为并发计数器编写测试。所有测试都位于包中的 GitHub 项目 vmlens-examples 中。 com.vmlens.examples.tutorial.counter

import com.vmlens.api.AllInterleavings;
public class TestCounterNonVolatile {
 int i = 0;
 @Test
 public void test() throws InterruptedException {
   try (AllInterleavings allInterleavings = 
     new AllInterleavings
        ("tutorial.counter.TestCounterNonVolatile");) {
     while (allInterleavings.hasNext()) {
      i = 0;
      Thread first = new Thread(() -> {
        i++;
      });
      Thread second = new Thread(() -> {
        i++;
      });
      first.start();
      second.start();
      first.join();
      second.join();
      assertEquals(2,i);
     }
   }
 }
}

我们从两个线程中递增字段。在两个线程都完成后，我们检查计数是否为 2。诀窍是通过使用 类 遍历所有线程交织的 while 循环来包围整个测试。iAllInterleavings

vmlens 作为 Java 代理运行，并使用字节码转换来计算所有线程交错。因此，您需要在 maven pom 中配置 vmlens，如此处所述。运行测试后，我们可以在文件 target/interleave/elements.html 的交错报告中看到所有测试运行的结果。

我们的测试编号 5 名为 tutorial.counter.TestCounterVolatile，在数据争用中失败。数据争用意味着对共享字段的读取和写入未正确同步。JIT 编译器或 CPU 可以对错误同步的读取和写入重新排序。这里可以很重要。通常，错误同步的读取和写入会返回正确的结果。只有在非常特殊的情况下，通常特定 CPU 架构、特定 JVM 和特定线程交织的组合会导致不正确的值。

VMLens会检查每个字段访问是否正确同步以检测数据争用。

并发易失性计数器的测试
为了解决数据争用问题，我们将该字段声明为易失性：

public class TestCounterVolatile {
 volatile int i = 0;
 @Test
 public void test() throws InterruptedException {
   try (AllInterleavings allInterleavings = 
      new AllInterleavings
        ("tutorial.counter.TestCounterVolatile");) {
      while (allInterleavings.hasNext()) {
       i = 0;
       Thread first = new Thread(() -> {
         i++;
       });
       Thread second = new Thread(() -> {
         i++;
       });
       first.start();
       second.start();
       first.join();
       second.join();
       assertEquals(2,i);
      }
   }
 }
}

这修复了数据争用，但现在断言失败：

TestCounterVolatile.test:22 expected:<2> but was:<1>

要查看出了什么问题，我们单击交错报告中的 test tutorial.counter.TestCounterVolatile。这向我们展示了出错的交错：

错误是两个线程都首先读取变量，然后都更新变量。因此，第二个线程将覆盖第一个线程的值。i

使用原子计数器的测试
为了编写正确的并发计数器，我们使用类：AtomicInteger

public class TestCounterAtomic {
 AtomicInteger i = new AtomicInteger();
 @Test
 public void test() throws InterruptedException {
   try (AllInterleavings allInterleavings = 
      new AllInterleavings
         ("tutorial.counter.TestCounterAtomic");) {
      while (allInterleavings.hasNext()) {
       i.set(0);
 Thread first = new Thread(() -> {
        i.incrementAndGet();
       });
       Thread second = new Thread(() -> {
        i.incrementAndGet();
       });
       first.start();
       second.start();
       first.join();
       second.join();
       assertEquals(2,i.get());
      }
   }
  }
}

现在我们计数器的增量是原子的，我们的测试终于成功了。

结论
正如我们所看到的，为多线程测试执行所有线程交织使多线程测试具有确定性。它使失败测试的调试成为可能。为了测试所有线程交织，我们用一个 while 循环来包围我们的测试，该循环使用类遍历所有线程交织。VMLens使用字节码转换来计算所有线程交错。因此，您还需要在 maven pom 中配置 vmlens，如此处所述。如果测试失败，您可以查看失败的线程交错以调试我们的测试。AllInterleavings