对于那里的所有Spring用户，这是我如今通常进行集成测试的方式，其中涉及到异步行为：
异步任务（例如I / O调用）完成后，在生产代码中触发应用程序事件。无论如何，在大多数情况下，必须使用此事件来处理生产中异步操作的响应。
有了此事件，您就可以在测试案例中使用以下策略：
- 执行被测系统
- 收听事件并确保事件已触发
- 做你的断言
为了解决这个问题，您首先需要触发某种域事件。我在这里使用UUID来标识已完成的任务，但是您当然可以随意使用其他东西，只要它是唯一的即可。
（请注意，以下代码段也使用Lombok注释来摆脱样板代码）
@RequiredArgsConstructor
class TaskCompletedEvent() {
private final UUID taskId;
// add more fields containing the result of the task if required
}
生产代码本身通常如下所示：
@Component
@RequiredArgsConstructor
class Production {
private final ApplicationEventPublisher eventPublisher;
void doSomeTask(UUID taskId) {
// do something like calling a REST endpoint asynchronously
eventPublisher.publishEvent(new TaskCompletedEvent(taskId));
}
}
然后，我可以使用Spring @EventListener在测试代码中捕获已发布的事件。事件侦听器会涉及更多一点，因为它必须以线程安全的方式处理两种情况：
- 生产代码比测试案例要快，并且在测试案例检查事件之前已经触发了该事件，或者
- 测试用例比生产代码快，并且测试用例必须等待事件。
CountDownLatch如此处其他答案中所述，A 用于第二种情况。还要注意，@Order事件处理程序方法上的注释可确保在生产中使用的任何其他事件侦听器之后调用此事件处理程序方法。
@Component
class TaskCompletionEventListener {
private Map<UUID, CountDownLatch> waitLatches = new ConcurrentHashMap<>();
private List<UUID> eventsReceived = new ArrayList<>();
void waitForCompletion(UUID taskId) {
synchronized (this) {
if (eventAlreadyReceived(taskId)) {
return;
}
checkNobodyIsWaiting(taskId);
createLatch(taskId);
}
waitForEvent(taskId);
}
private void checkNobodyIsWaiting(UUID taskId) {
if (waitLatches.containsKey(taskId)) {
throw new IllegalArgumentException("Only one waiting test per task ID supported, but another test is already waiting for " + taskId + " to complete.");
}
}
private boolean eventAlreadyReceived(UUID taskId) {
return eventsReceived.remove(taskId);
}
private void createLatch(UUID taskId) {
waitLatches.put(taskId, new CountDownLatch(1));
}
@SneakyThrows
private void waitForEvent(UUID taskId) {
var latch = waitLatches.get(taskId);
latch.await();
}
@EventListener
@Order
void eventReceived(TaskCompletedEvent event) {
var taskId = event.getTaskId();
synchronized (this) {
if (isSomebodyWaiting(taskId)) {
notifyWaitingTest(taskId);
} else {
eventsReceived.add(taskId);
}
}
}
private boolean isSomebodyWaiting(UUID taskId) {
return waitLatches.containsKey(taskId);
}
private void notifyWaitingTest(UUID taskId) {
var latch = waitLatches.remove(taskId);
latch.countDown();
}
}
最后一步是在一个测试用例中执行被测系统。我在这里使用带有JUnit 5的SpringBoot测试，但这对于使用Spring上下文的所有测试应该都一样。
@SpringBootTest
class ProductionIntegrationTest {
@Autowired
private Production sut;
@Autowired
private TaskCompletionEventListener listener;
@Test
void thatTaskCompletesSuccessfully() {
var taskId = UUID.randomUUID();
sut.doSomeTask(taskId);
listener.waitForCompletion(taskId);
// do some assertions like looking into the DB if value was stored successfully
}
}
请注意，与此处的其他答案相反，如果您并行执行测试并且多个线程同时执行异步代码，则该解决方案也将起作用。