mirror of
https://github.com/spring-projects/spring-boot.git
synced 2026-09-30 06:09:14 +00:00
Traditionally, a @ServerEndpoint-annotated bean is found by a servlet container initialiser, however Boot does not run servlet container initialisers when an embedded container is being used. To be able to use @ServerEndpoint in a Boot app that uses embedded Tomcat a ServerEndpointExporter bean must be declared. This commit updates the documentation to describe this requirement and also updates the WebSockets sample to illustrate the use of ServerEndpointExporter. The version of Spring Framework has been updated to 4.0.8.BUILD-SNAPSHOT. This picks up the fix for SPR-12340. Closes gh-1722
139 lines
4.9 KiB
Java
139 lines
4.9 KiB
Java
/*
|
|
* Copyright 2012-2014 the original author or authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package samples.websocket;
|
|
|
|
import java.util.concurrent.CountDownLatch;
|
|
import java.util.concurrent.TimeUnit;
|
|
import java.util.concurrent.atomic.AtomicReference;
|
|
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.junit.Test;
|
|
import org.junit.runner.RunWith;
|
|
import org.springframework.beans.factory.annotation.Value;
|
|
import org.springframework.boot.CommandLineRunner;
|
|
import org.springframework.boot.autoconfigure.PropertyPlaceholderAutoConfiguration;
|
|
import org.springframework.boot.builder.SpringApplicationBuilder;
|
|
import org.springframework.boot.test.IntegrationTest;
|
|
import org.springframework.boot.test.SpringApplicationConfiguration;
|
|
import org.springframework.context.ConfigurableApplicationContext;
|
|
import org.springframework.context.annotation.Bean;
|
|
import org.springframework.context.annotation.Configuration;
|
|
import org.springframework.test.annotation.DirtiesContext;
|
|
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
|
|
import org.springframework.test.context.web.WebAppConfiguration;
|
|
import org.springframework.web.socket.client.WebSocketConnectionManager;
|
|
import org.springframework.web.socket.client.standard.StandardWebSocketClient;
|
|
|
|
import samples.websocket.client.GreetingService;
|
|
import samples.websocket.client.SimpleClientWebSocketHandler;
|
|
import samples.websocket.client.SimpleGreetingService;
|
|
import samples.websocket.config.SampleWebSocketsApplication;
|
|
|
|
import static org.junit.Assert.assertEquals;
|
|
|
|
@RunWith(SpringJUnit4ClassRunner.class)
|
|
@SpringApplicationConfiguration(classes = SampleWebSocketsApplication.class)
|
|
@WebAppConfiguration
|
|
@IntegrationTest("server.port:0")
|
|
@DirtiesContext
|
|
public class SampleWebSocketsApplicationTests {
|
|
|
|
private static Log logger = LogFactory.getLog(SampleWebSocketsApplicationTests.class);
|
|
|
|
@Value("${local.server.port}")
|
|
private int port = 1234;
|
|
|
|
@Test
|
|
public void echoEndpoint() throws Exception {
|
|
ConfigurableApplicationContext context = new SpringApplicationBuilder(
|
|
ClientConfiguration.class, PropertyPlaceholderAutoConfiguration.class)
|
|
.properties(
|
|
"websocket.uri:ws://localhost:" + this.port + "/echo/websocket")
|
|
.run("--spring.main.web_environment=false");
|
|
long count = context.getBean(ClientConfiguration.class).latch.getCount();
|
|
AtomicReference<String> messagePayloadReference = context
|
|
.getBean(ClientConfiguration.class).messagePayload;
|
|
context.close();
|
|
assertEquals(0, count);
|
|
assertEquals("Did you say \"Hello world!\"?", messagePayloadReference.get());
|
|
}
|
|
|
|
@Test
|
|
public void reverseEndpoint() throws Exception {
|
|
ConfigurableApplicationContext context = new SpringApplicationBuilder(
|
|
ClientConfiguration.class, PropertyPlaceholderAutoConfiguration.class)
|
|
.properties("websocket.uri:ws://localhost:" + this.port + "/reverse")
|
|
.run("--spring.main.web_environment=false");
|
|
long count = context.getBean(ClientConfiguration.class).latch.getCount();
|
|
AtomicReference<String> messagePayloadReference = context
|
|
.getBean(ClientConfiguration.class).messagePayload;
|
|
context.close();
|
|
assertEquals(0, count);
|
|
assertEquals("Reversed: !dlrow olleH", messagePayloadReference.get());
|
|
}
|
|
|
|
@Configuration
|
|
static class ClientConfiguration implements CommandLineRunner {
|
|
|
|
@Value("${websocket.uri}")
|
|
private String webSocketUri;
|
|
|
|
private final CountDownLatch latch = new CountDownLatch(1);
|
|
|
|
private final AtomicReference<String> messagePayload = new AtomicReference<String>();
|
|
|
|
@Override
|
|
public void run(String... args) throws Exception {
|
|
logger.info("Waiting for response: latch=" + this.latch.getCount());
|
|
if (this.latch.await(10, TimeUnit.SECONDS)) {
|
|
logger.info("Got response: " + this.messagePayload.get());
|
|
}
|
|
else {
|
|
logger.info("Response not received: latch=" + this.latch.getCount());
|
|
}
|
|
}
|
|
|
|
@Bean
|
|
public WebSocketConnectionManager wsConnectionManager() {
|
|
|
|
WebSocketConnectionManager manager = new WebSocketConnectionManager(client(),
|
|
handler(), this.webSocketUri);
|
|
manager.setAutoStartup(true);
|
|
|
|
return manager;
|
|
}
|
|
|
|
@Bean
|
|
public StandardWebSocketClient client() {
|
|
return new StandardWebSocketClient();
|
|
}
|
|
|
|
@Bean
|
|
public SimpleClientWebSocketHandler handler() {
|
|
return new SimpleClientWebSocketHandler(greetingService(), this.latch,
|
|
this.messagePayload);
|
|
}
|
|
|
|
@Bean
|
|
public GreetingService greetingService() {
|
|
return new SimpleGreetingService();
|
|
}
|
|
}
|
|
|
|
}
|