如何使用Spring测试服务器发送的事件?

如何使用Spring测试服务器发送的事件?,spring,server-sent-events,mockmvc,Spring,Server Sent Events,Mockmvc,我已经实现了一个控制器,其中有一个返回SSEEmiter的方法,现在我想测试它。到目前为止,我唯一能找到的方法是: @RunWith(SpringJUnit4ClassRunner.class) @SpringApplicationConfiguration(classes = {SsePaymentReceivedController.class, AutomatBackendContextInitializer.class, EventBusImpl.class}) @WebAppConfi

我已经实现了一个控制器,其中有一个返回SSEEmiter的方法,现在我想测试它。到目前为止,我唯一能找到的方法是:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {SsePaymentReceivedController.class, AutomatBackendContextInitializer.class, EventBusImpl.class})
@WebAppConfiguration
public class SsePaymentReceivedControllerIntegrationTest {

@Inject
WebApplicationContext context;
@Inject
SsePaymentReceivedController sseCoinController;
@Inject
EventBusImpl eventBus;

MockMvc mockMvc;

@Before
public void setUpMockMvc() {
    this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
}

@Test
public void subscriptionToSseChannelIsFine() throws Exception {
    MvcResult result = mockMvc.perform(get("/sse/payment"))
            .andExpect(status().isOk())
            .andReturn();
    eventBus.fireNotification(new PaymentReceivedNotification("50", Currency.EURO));
    LinkedHashSet<ResponseBodyEmitter.DataWithMediaType> emitters =
            (LinkedHashSet<ResponseBodyEmitter.DataWithMediaType>)Whitebox.getInternalState(((SseEmitter)result.getModelAndView().getModel().get("sseEmitter")), "earlySendAttempts");
    final Iterator<ResponseBodyEmitter.DataWithMediaType> iterator = emitters.iterator();

    ResponseBodyEmitter.DataWithMediaType dataField = iterator.next();
    assertEquals("data:", dataField.getData());

    ResponseBodyEmitter.DataWithMediaType valueField = iterator.next();
    assertEquals("{\"remainingAmount\":\"50\",\"currency\":\"EURO\"}", valueField.getData());

    ResponseBodyEmitter.DataWithMediaType lastField = iterator.next();
    assertEquals("\n\n", lastField.getData());
}
}
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(类={SsePaymentReceivedController.class,AutomateBackendContextInitializer.class,EventBusImpl.class})
@WebAppConfiguration
公共类SsePaymentReceivedControllerIntegrationTest{
@注入
WebApplicationContext上下文;
@注入
SsePaymentReceivedController SSEConController;
@注入
EventBusImpl事件总线;
MockMvc-MockMvc;
@以前
public void setUpMockMvc(){
this.mockMvc=MockMvcBuilders.webAppContextSetup(this.context.build();
}
@试验
public void subscriptionToSseChannelIsFine()引发异常{
MvcResult result=mockMvc.perform(get(“/sse/payment”))
.andExpect(状态().isOk())
.andReturn();
事件总线。火灾通知(新付款收到通知(“50”,货币。欧元));
LinkedHashSet发射器=
(LinkedHashSet)Whitebox.getInternalState(((SSEEmiter)result.getModelAndView().getModel().get(“SSEEmiter”),“EarlysEndTests”);
final Iterator Iterator=emitters.Iterator();
ResponseByMitter.DataWithMediaType数据字段=迭代器.next();
assertEquals(“数据:,dataField.getData());
ResponseByMitter.DataWithMediaType valueField=iterator.next();
assertEquals(“{\'remainingAmount\”:“50\”,“currency\”:“EURO\”),valueField.getData());
ResponseBodyMitter.DataWithMediaType lastField=iterator.next();
assertEquals(“\n\n”,lastField.getData());
}
}

一定有一种方法比检查返回模型的内部更好,我正在寻找这种方法-有什么想法吗?

我找到的最佳选择是:

String event = result.getResponse().getContentAsString()
// remove data: and \n\n
String json = s1.substring(5, s1.length() - 2);
new JsonPathExpectationsHelper("$.remainingAmount").assertValue(json, "50");
new JsonPathExpectationsHelper("$.currency").assertValue(json, "EURO");

一个好主意可能是使用SSE客户端。您可以将JAX-WS-RS客户机与Jersey-EventSource一起使用来实现这一点

使用
javax.ws.rsapi
jersey media sse
,以下是如何打开sse连接:

Client client = ClientBuilder
        .newBuilder()
        .register(SseFeature.class)
        .build();

EventSource eventSource = EventSource
        .target(client.target("http://localhost:8080/feed/123456"))
        .reconnectingEvery(1, TimeUnit.SECONDS)
        .build();

EventListener listener = inboundEvent -> {

    log.info("Event received: id -> {}, name -> {}, data -> {}", inboundEvent.getId(),
             inboundEvent.getName(), inboundEvent.readData(String.class));

    // Process events ...
};
eventSource.register(listener);
eventSource.open();
因此,如果您想创建用于测试的工具,您可以编写一个类似以下的小助手类:

package org.demo.service.sse;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;

import org.glassfish.jersey.media.sse.EventListener;
import org.glassfish.jersey.media.sse.EventSource;
import org.glassfish.jersey.media.sse.InboundEvent;
import org.glassfish.jersey.media.sse.SseFeature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SseTestClient {

    private static final Logger log = LoggerFactory.getLogger(SseTestClient.class);

    private final String targetUrl;
    private final List<InboundEvent> receivedEvents = new ArrayList<>();

    private String clientName = "SSE client";
    private EventSource eventSource;
    private int currentEventPos = 0;

    public SseTestClient( String targetUrl ) {

        this.targetUrl = targetUrl;
    }

    public SseTestClient setClientName( String clientName ) {

        this.clientName = clientName;
        return this;
    }

    public SseTestClient connectFeed() {

        log.info("[{}] Initializing EventSource...", clientName);

        // Create SSE client and server

        Client client = ClientBuilder
                .newBuilder()
                .register(SseFeature.class)
                .build();

        eventSource = EventSource
                .target(client.target(targetUrl))
                .reconnectingEvery(300, TimeUnit.SECONDS) // Large number so that any disconnection will break tests
                .build();

        EventListener listener = inboundEvent -> {

            log.info("[{}] Event received: name -> {}, data -> {}",
                     clientName, inboundEvent.getName(), inboundEvent.readData(String.class));

            receivedEvents.add(inboundEvent);
        };
        eventSource.register(listener);
        eventSource.open();

        log.info("[{}] EventSource connection opened", clientName);

        return this;
    }

    public int getTotalEventCount() {

        return receivedEvents.size();
    }

    public int getNewEventCount() {

        return receivedEvents.size() - currentEventPos;
    }

    public boolean hasNewEvent() {

        return currentEventPos < receivedEvents.size();
    }

    public InboundEvent getNextEvent() {

        if (currentEventPos >= receivedEvents.size()) {
            return null;
        }
        InboundEvent currentEvent = receivedEvents.get(currentEventPos);
        ++currentEventPos;
        return currentEvent;
    }

    public SseTestClient closeFeed() {

        if (eventSource != null) {
            eventSource.close();
        }
        return this;
    }
}

希望有帮助

您可以在Spring Framework 5.0或更高版本上使用。

只能在反应式web堆栈()中使用
SseTestClient sseClient = new SseTestClient("http://localhost:8080/feed/123456").connectFeed();

Thread.sleep(1000);

assertTrue(sseClient.hasNewEvent());
assertEquals(2, sseClient.getNewEventCount());
// ...