在 gRPC JUnit 测试中优雅地清理
最佳实践是，在不再需要 gRPC 资源（如客户端通道、服务器以及之前附加的 Context）时，始终进行清理。
即使是 JUnit 测试，也是如此，否则泄漏的资源不仅会永久停留在您的机器上，还会干扰后续测试。一个不那么糟糕的情况是，由于前一个测试泄漏的资源，后续测试无法通过。最糟糕的情况是，如果前一个通过的测试没有泄漏资源，某些本不应通过的后续测试反而通过了。
所以，清理、清理、再清理…… 如果任何清理不成功，则使测试失败。
一个典型示例是
public class MyTest {
private Server server;
private ManagedChannel channel;
...
@After
public void tearDown() throws InterruptedException {
// assume channel and server are not null
channel.shutdownNow();
server.shutdownNow();
// fail the test if cleanup is not successful
assert channel.awaitTermination(5, TimeUnit.SECONDS) : "channel failed to shutdown";
assert server.awaitTermination(5, TimeUnit.SECONDS) : "server failed to shutdown";
}
...
}
或者更优雅地处理
public class MyTest {
private Server server;
private ManagedChannel channel;
...
@After
public void tearDown() throws InterruptedException {
// assume channel and server are not null
channel.shutdown();
server.shutdown();
// fail the test if cannot gracefully shutdown
try {
assert channel.awaitTermination(5, TimeUnit.SECONDS) : "channel cannot be gracefully shutdown";
assert server.awaitTermination(5, TimeUnit.SECONDS) : "server cannot be gracefully shutdown";
} finally {
channel.shutdownNow();
server.shutdownNow();
}
}
...
}
然而，必须将所有这些代码添加到每个测试中以使其优雅关闭，会给您带来额外的工作，因为您需要自己编写关闭的样板代码。因此，gRPC 测试库提供了辅助规则来简化这项工作。
最初，引入了 JUnit 规则 GrpcServerRule 以消除关闭的样板代码。该规则在测试开始时创建一个 In-Process 服务器和通道，并在测试结束时自动将其关闭。然而，用户发现此规则限制过多，它不支持除 In-Process 传输之外的传输方式、到服务器的多个通道、自定义通道或服务器构建器选项，以及在各个测试方法内部进行配置。
在 gRPC v1.13 版本中引入了一个更灵活的 JUnit 规则 GrpcCleanupRule，它也消除了关闭的样板代码。然而，与 GrpcServerRule 不同，GrpcCleanupRule 不会自动创建任何服务器或通道。用户可以像在普通测试中一样，自己创建和启动服务器，并自己创建通道。使用此规则，用户只需注册需要在测试结束时关闭的每个资源（通道或服务器），该规则随后将自动优雅地将其关闭。
您可以在运行测试方法之前注册资源
public class MyTest {
@Rule
public GrpcCleanupRule grpcCleanup = new GrpcCleanupRule();
...
private String serverName = InProcessServerBuilder.generateName();
private Server server = grpcCleanup.register(InProcessServerBuilder
.forName(serverName).directExecutor().addService(myServiceImpl).build().start());
private ManagedChannel channel = grpcCleanup.register(InProcessChannelBuilder
.forName(serverName).directExecutor().build());
...
}
或在每个单独的测试方法内部注册
public class MyTest {
@Rule
public GrpcCleanupRule grpcCleanup = new GrpcCleanupRule();
...
private String serverName = InProcessServerBuilder.generateName();
private InProcessServerBuilder serverBuilder = InProcessServerBuilder
.forName(serverName).directExecutor();
private InProcessChannelBuilder channelBuilder = InProcessChannelBuilder
.forName(serverName).directExecutor();
...
@Test
public void testFooBar() {
...
grpcCleanup.register(
serverBuilder.addService(myServiceImpl).build().start());
ManagedChannel channel = grpcCleanup.register(
channelBuilder.maxInboundMessageSize(1024).build());
...
}
}
现在使用 GrpcCleanupRule，您无需担心 JUnit 测试中 gRPC 服务器和通道的优雅关闭。所以快来试试并在您的测试中进行清理吧！