Creating a new Spring WebSocket application (Java WebSocket sends a message to the JavaScript WebSocket) | Java, Spring WebSocket, Spring Boot, Maven
last updated: 20 April 2025
Download an example:
Note! You must have Java JDK installed. If you don't have it, then need to download and install Java JDK ... Note! You must have IntelliJ IDEA Ultimate installed. If you don't have it, then need to download and install IntelliJ IDEA Ultimate ... Note! You must have Tomcat Web Server installed. If you don't have it, then need to download and install Tomcat Web Server ...
Step 1. Create a new project with the type Spring Boot
Spring Boots
Step 2. Add the spring-boot-starter-web and spring-websocket libraries to the pom.xml file
spring-boot-starter-web spring-websocket
<?xml version="1.0" encoding="UTF-8" ?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
"http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" >
<modelVersion> 4.0.0</modelVersion>
<parent>
<groupId> org.springframework.boot</groupId>
<artifactId> spring-boot-starter-parent</artifactId>
<version> 3.4.4</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId> org.example</groupId>
<artifactId> MySpringWebSocket</artifactId>
<version> 0.0.1-SNAPSHOT</version>
<name> MySpringWebSocket</name>
<description> MySpringWebSocket</description>
<url/>
<licenses>
<license/>
</licenses>
<developers>
<developer/>
</developers>
<scm>
<connection/>
<developerConnection/>
<tag/>
<url/>
</scm>
<properties>
<java.version> 17</java.version>
</properties>
<dependencies>
<dependency>
<groupId> org.springframework.boot</groupId>
<artifactId> spring-boot-starter</artifactId>
</dependency>
<!-- web starter -->
<dependency>
<groupId> org.springframework.boot</groupId>
<artifactId> spring-boot-starter-web</artifactId>
</dependency> <!-- web socket -->
<dependency>
<groupId> org.springframework</groupId>
<artifactId> spring-websocket</artifactId>
</dependency> <dependency>
<groupId> org.springframework.boot</groupId>
<artifactId> spring-boot-starter-test</artifactId>
<scope> test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId> org.springframework.boot</groupId>
<artifactId> spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
Step 3. Create a new MyWebSocketHandler.java file
Right-click on my package folder and create a new java
MyWebSocketHandler Class
Press Enter
MyWebSocketHandler.java file, add the code:
Java
package org.example.myspringwebsocket;
import java.io.IOException;
import org.springframework.stereotype.Component;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;
@Component
public class MyWebSocketHandler extends TextWebSocketHandler {
@Override
public void handleTextMessage (WebSocketSession session, TextMessage message)
throws InterruptedException, IOException {
"Today weather is good" ));
Step 4. Create a new MyWebSocketConfig.java file
Right-click on my package folder and create a new java
MyWebSocketConfig Class
Press Enter
MyWebSocketConfig.java file, add the code:
package org.example.myspringwebsocket;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
@Configuration
@EnableWebSocket
public class MyWebSocketConfig implements WebSocketConfigurer {
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
"/mysocket1" ).setAllowedOrigins("*" );
Step 5. Launch the project and see how it works
Spring Boot Spring Boot Tomcat <dependency> ... spring-boot-starter-web ... </dependency> was added to the pom.xml file)
Our web server is running, here is its address:
http://localhost:8080
Since we started the program, the web server created a web socket.
To check, create a new file
D:/1.html on your disk
Html
<script>
webSocket = new WebSocket('ws://localhost:8080/mysocket1'); // connect to server
webSocket .onopen = function(event) {
alert ("Connection open" );
webSocket .send("My name is Evgen" ); // send message to server
webSocket .onmessage = function(event) {
alert ("message from server: " + event.data); // message from server
</script>
Let's run this file 1.html
Афишу
Your feedback ... Comments ...