{"id":4198,"date":"2024-03-13T08:06:40","date_gmt":"2024-03-13T08:06:40","guid":{"rendered":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/"},"modified":"2025-07-31T04:38:17","modified_gmt":"2025-07-31T04:38:17","slug":"how-to-use-websocket-in-spring-boot","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/","title":{"rendered":"Spring Boot WebSocket Setup Guide"},"content":{"rendered":"<p>WebSocket can be implemented in Spring Boot by following these steps:<\/p>\n<ol>\n<li>First, add the WebSocket dependency:<br \/>\nAdd the following dependency in the pom.xml file:<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-tag\">&lt;<span class=\"hljs-name\">dependency<\/span>&gt;<\/span>\r\n    <span class=\"hljs-tag\">&lt;<span class=\"hljs-name\">groupId<\/span>&gt;<\/span>org.springframework.boot<span class=\"hljs-tag\">&lt;\/<span class=\"hljs-name\">groupId<\/span>&gt;<\/span>\r\n    <span class=\"hljs-tag\">&lt;<span class=\"hljs-name\">artifactId<\/span>&gt;<\/span>spring-boot-starter-websocket<span class=\"hljs-tag\">&lt;\/<span class=\"hljs-name\">artifactId<\/span>&gt;<\/span>\r\n<span class=\"hljs-tag\">&lt;\/<span class=\"hljs-name\">dependency<\/span>&gt;<\/span>\r\n<\/code><\/pre>\n<ol>\n<li>Create a WebSocket configuration class:<br \/>\nSet up a class specifically for configuring WebSocket-related parameters and handlers. You can refer to the following example for guidance.<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-meta\">@Configuration<\/span>\r\n<span class=\"hljs-meta\">@EnableWebSocket<\/span>\r\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">WebSocketConfig<\/span> <span class=\"hljs-keyword\">implements<\/span> <span class=\"hljs-title class_\">WebSocketConfigurer<\/span> {\r\n\r\n    <span class=\"hljs-meta\">@Override<\/span>\r\n    <span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">void<\/span> <span class=\"hljs-title function_\">registerWebSocketHandlers<\/span><span class=\"hljs-params\">(WebSocketHandlerRegistry registry)<\/span> {\r\n        registry.addHandler(<span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">WebSocketHandler<\/span>(), <span class=\"hljs-string\">\"\/ws\"<\/span>).setAllowedOrigins(<span class=\"hljs-string\">\"*\"<\/span>);\r\n    }\r\n}\r\n<\/code><\/pre>\n<ol>\n<li>Create a WebSocket handler:<br \/>\nDevelop a WebSocket handler class for handling events and messages related to WebSocket connections. You can refer to the following example for guidance.<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-meta\">@Component<\/span>\r\n<span class=\"hljs-keyword\">public<\/span> <span class=\"hljs-keyword\">class<\/span> <span class=\"hljs-title class_\">WebSocketHandler<\/span> <span class=\"hljs-keyword\">extends<\/span> <span class=\"hljs-title class_\">TextWebSocketHandler<\/span> {\r\n\r\n    <span class=\"hljs-meta\">@Override<\/span>\r\n    <span class=\"hljs-keyword\">protected<\/span> <span class=\"hljs-keyword\">void<\/span> <span class=\"hljs-title function_\">handleTextMessage<\/span><span class=\"hljs-params\">(WebSocketSession session, TextMessage message)<\/span> <span class=\"hljs-keyword\">throws<\/span> Exception {\r\n        <span class=\"hljs-comment\">\/\/ \u5904\u7406\u6536\u5230\u7684\u6d88\u606f<\/span>\r\n        <span class=\"hljs-type\">String<\/span> <span class=\"hljs-variable\">payload<\/span> <span class=\"hljs-operator\">=<\/span> message.getPayload();\r\n        session.sendMessage(<span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">TextMessage<\/span>(<span class=\"hljs-string\">\"\u6536\u5230\u6d88\u606f\uff1a\"<\/span> + payload));\r\n    }\r\n}\r\n<\/code><\/pre>\n<ol>\n<li>Create a WebSocket client:<br \/>\nUse JavaScript to establish a WebSocket connection, send and receive messages on the front-end webpage. Refer to the following example:<\/li>\n<\/ol>\n<pre class=\"post-pre\"><code><span class=\"hljs-keyword\">var<\/span> socket = <span class=\"hljs-keyword\">new<\/span> <span class=\"hljs-title class_\">WebSocket<\/span>(<span class=\"hljs-string\">\"ws:\/\/localhost:8080\/ws\"<\/span>);\r\n\r\nsocket.<span class=\"hljs-property\">onopen<\/span> = <span class=\"hljs-keyword\">function<\/span>(<span class=\"hljs-params\"><\/span>) {\r\n    <span class=\"hljs-variable language_\">console<\/span>.<span class=\"hljs-title function_\">log<\/span>(<span class=\"hljs-string\">\"\u8fde\u63a5\u6210\u529f\"<\/span>);\r\n};\r\n\r\nsocket.<span class=\"hljs-property\">onmessage<\/span> = <span class=\"hljs-keyword\">function<\/span>(<span class=\"hljs-params\">event<\/span>) {\r\n    <span class=\"hljs-variable language_\">console<\/span>.<span class=\"hljs-title function_\">log<\/span>(<span class=\"hljs-string\">\"\u6536\u5230\u6d88\u606f\uff1a\"<\/span> + event.<span class=\"hljs-property\">data<\/span>);\r\n};\r\n\r\nsocket.<span class=\"hljs-title function_\">send<\/span>(<span class=\"hljs-string\">\"Hello, WebSocket!\"<\/span>);\r\n<\/code><\/pre>\n<ol>\n<li>Run the application:<br \/>\nStart the Spring Boot application, access the front-end page, and test the WebSocket connection and message transmission functionality.<\/li>\n<\/ol>\n<p>These are the basic steps to use WebSocket in Spring Boot, which allows for real-time communication and message push functionality.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>WebSocket can be implemented in Spring Boot by following these steps: First, add the WebSocket dependency: Add the following dependency in the pom.xml file: &lt;dependency&gt; &lt;groupId&gt;org.springframework.boot&lt;\/groupId&gt; &lt;artifactId&gt;spring-boot-starter-websocket&lt;\/artifactId&gt; &lt;\/dependency&gt; Create a WebSocket configuration class: Set up a class specifically for configuring WebSocket-related parameters and handlers. You can refer to the following example for guidance. @Configuration @EnableWebSocket [&hellip;]<\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[1],"tags":[3530,3529,2522,3531,3528],"class_list":["post-4198","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-java-websocket","tag-real-time-communication","tag-spring-boot","tag-spring-websocket","tag-websocket"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v21.5 (Yoast SEO v21.5) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Spring Boot WebSocket Setup Guide - Blog - Silicon Cloud<\/title>\n<meta name=\"description\" content=\"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Spring Boot WebSocket Setup Guide\" \/>\n<meta property=\"og:description\" content=\"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\" \/>\n<meta property=\"article:published_time\" content=\"2024-03-13T08:06:40+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-07-31T04:38:17+00:00\" \/>\n<meta name=\"author\" content=\"Olivia Parker\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:site\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Olivia Parker\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\"},\"author\":{\"name\":\"Olivia Parker\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/3ff7b3da0e45ac5dbbef2502f3cea8d9\"},\"headline\":\"Spring Boot WebSocket Setup Guide\",\"datePublished\":\"2024-03-13T08:06:40+00:00\",\"dateModified\":\"2025-07-31T04:38:17+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\"},\"wordCount\":147,\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"keywords\":[\"Java WebSocket\",\"Real-time Communication\",\"Spring Boot\",\"Spring WebSocket\",\"WebSocket\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\",\"name\":\"Spring Boot WebSocket Setup Guide - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\"},\"datePublished\":\"2024-03-13T08:06:40+00:00\",\"dateModified\":\"2025-07-31T04:38:17+00:00\",\"description\":\"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.\",\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.silicloud.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Spring Boot WebSocket Setup Guide\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"name\":\"Silicon Cloud Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\",\"name\":\"Silicon Cloud Blog\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"contentUrl\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"width\":1024,\"height\":1024,\"caption\":\"Silicon Cloud Blog\"},\"image\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\",\"https:\/\/twitter.com\/SiliCloudGlobal\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/3ff7b3da0e45ac5dbbef2502f3cea8d9\",\"name\":\"Olivia Parker\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/56c66f189ba32a6f9eb50f31a38fe774e2a725c213d4070835ccc51b8fbbc54b?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/56c66f189ba32a6f9eb50f31a38fe774e2a725c213d4070835ccc51b8fbbc54b?s=96&d=mm&r=g\",\"caption\":\"Olivia Parker\"},\"url\":\"https:\/\/www.silicloud.com\/blog\/author\/oliviaparker\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Spring Boot WebSocket Setup Guide - Blog - Silicon Cloud","description":"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/","og_locale":"en_US","og_type":"article","og_title":"Spring Boot WebSocket Setup Guide","og_description":"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.","og_url":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/","og_site_name":"Blog - Silicon Cloud","article_publisher":"https:\/\/www.facebook.com\/SiliCloudGlobal\/","article_published_time":"2024-03-13T08:06:40+00:00","article_modified_time":"2025-07-31T04:38:17+00:00","author":"Olivia Parker","twitter_card":"summary_large_image","twitter_creator":"@SiliCloudGlobal","twitter_site":"@SiliCloudGlobal","twitter_misc":{"Written by":"Olivia Parker","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#article","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/"},"author":{"name":"Olivia Parker","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/3ff7b3da0e45ac5dbbef2502f3cea8d9"},"headline":"Spring Boot WebSocket Setup Guide","datePublished":"2024-03-13T08:06:40+00:00","dateModified":"2025-07-31T04:38:17+00:00","mainEntityOfPage":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/"},"wordCount":147,"publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"keywords":["Java WebSocket","Real-time Communication","Spring Boot","Spring WebSocket","WebSocket"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/","url":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/","name":"Spring Boot WebSocket Setup Guide - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/#website"},"datePublished":"2024-03-13T08:06:40+00:00","dateModified":"2025-07-31T04:38:17+00:00","description":"Learn to implement WebSocket in Spring Boot: add dependencies, configure handlers, and build real-time apps easily.","breadcrumb":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-websocket-in-spring-boot\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.silicloud.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Spring Boot WebSocket Setup Guide"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/blog\/#website","url":"https:\/\/www.silicloud.com\/blog\/","name":"Silicon Cloud Blog","description":"","publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.silicloud.com\/blog\/#organization","name":"Silicon Cloud Blog","url":"https:\/\/www.silicloud.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","contentUrl":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","width":1024,"height":1024,"caption":"Silicon Cloud Blog"},"image":{"@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/SiliCloudGlobal\/","https:\/\/twitter.com\/SiliCloudGlobal"]},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/3ff7b3da0e45ac5dbbef2502f3cea8d9","name":"Olivia Parker","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/56c66f189ba32a6f9eb50f31a38fe774e2a725c213d4070835ccc51b8fbbc54b?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/56c66f189ba32a6f9eb50f31a38fe774e2a725c213d4070835ccc51b8fbbc54b?s=96&d=mm&r=g","caption":"Olivia Parker"},"url":"https:\/\/www.silicloud.com\/blog\/author\/oliviaparker\/"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/4198","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/comments?post=4198"}],"version-history":[{"count":2,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/4198\/revisions"}],"predecessor-version":[{"id":148863,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/4198\/revisions\/148863"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/media?parent=4198"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/categories?post=4198"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/tags?post=4198"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}