Spring Boot(五):webSocket组件的入门简单使用

在这里想先做一个WebSocket广播式的运用,供大家对webSocket入门学习;
首先,让大家在页面先看下效果:


图片.png

为什么说这是一个简单的WebSocket广播式的运用;请看网页调试:

图片.png

理由:
1.101状态码:101是websocket协议状态码, 101表示协议切换成功;
2.当你不断输入不同的名字进行发送时,不会有新的连接出现,之前有一个101的连接也一直没有断开;
所以说这是一个简单的WebSocket广播式运用!

声明:

现在以及之后的springboot开发都是在我原有的环境已布置好的项目上进行开发的;
可参考我之前的几篇文章:
Spring Boot(一):入门篇
Spring Boot(二):简单的初始配置
这里简单展示下项目工程的结构,如下图:

图片.png

步骤:

一、在项目maven配置中添加依赖:

<!-- websocket -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>

二、创建WebSocketConfig类,代码如下

package com.example.demo.config;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.StompWebSocketEndpointRegistration;

/**
 * Created by AxeLai on 2019/04/29 0011.
 */
@Configuration
@EnableWebSocketMessageBroker//(1),@EnableWebSocketMessageBroker注解用于开启使用STOMP协议来传输基于代理(MessageBroker)的消息,这时候控制器(controller)开始支持@MessageMapping,就像是使用@requestMapping一样。
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/stomp").withSockJS(); //(2),注册一个Stomp的节点(endpoint),并指定使用SockJS协议。
        //stomp就是websocket的端点,客户端需要注册这个端点进行链接,withSockJS允许客户端利用sockjs进行浏览器兼容性处理
    }
    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        registry.enableSimpleBroker("/topic");//(3),配置消息代理(MessageBroker)。
        //设置服务器广播消息的基础路径
//        registry.setApplicationDestinationPrefixes("/app");//设置客户端订阅消息的基础路径
    }
}

三、创建WiselyMessage类(浏览器向服务器传送消息,用该类进行接收),代码如下:

package com.example.demo.model;

/**
 * @author AxeLai
 * @date 2019-04-29 09:06
 * 浏览器向服务器传送消息,用该类进行接收
 */
public class WiselyMessage {
    private String name;
    public String getName(){
        return name;
    }
}

四、创建WiselyResponse类(服务器向浏览器传送消息,用该类进行传送),代码如下:

package com.example.demo.model;

/**
 * @author AxeLai
 * @date 2019-04-29 09:06
 * 服务器向浏览器传送消息,用该类进行传送
 */
public class WiselyResponse {
    private String responseMessage;
    public WiselyResponse(String responseMessage){
        this.responseMessage = responseMessage;
    }
    public String getResponseMessage(){
        return responseMessage;
    }

}

五、创建WsController类,代码如下:

package com.example.demo.controller;

import com.example.demo.model.WiselyMessage;
import com.example.demo.model.WiselyResponse;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;

/**
 * @author AxeLai
 * @date 2019-04-29 09:08
 */
@Controller
public class WsController {
    @MessageMapping("/welcome")//1@MessageMapping和@RequestMapping功能类似,用于设置URL映射地址,浏览器向服务器发起请求,需要通过该地址。
    @SendTo("/topic/getResponse")//2如果服务器接受到了消息,就会对订阅了@SendTo括号中的地址传送消息
    public WiselyResponse say(WiselyMessage message) throws Exception {
        return new WiselyResponse("你好, " + message.getName() + "!");
    }

}

六、创建IndexPageConfig配置类,(该类的作用是可以把websocket1.html设为首页,只需要在地址栏里面输入localhost:8080,就会找到websocket1.html),代码如下:

package com.example.demo.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.view.RedirectView;

/**
 * @author AxeLai
 * @date 2019-04-29 09:31
 */
@Controller
public class IndexPageConfig {

    @RequestMapping("/")
    public RedirectView ws() {
        return new RedirectView("/websocket1.html");
    }
}

七、网页html编写

首先先加入三个JS:如图:


图片.png

其实是要导入三个包,其他两个我们直接从外网导入;如下:

<script src="js/jquery-2.1.1.min.js"></script>
<script src="https://cdn.bootcss.com/sockjs-client/1.1.4/sockjs.min.js"></script>
<script src="https://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>

创建前端页面websocket1.html,代码如下:

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8" />
    <title>Spring Boot+WebSocket+广播式</title>

</head>
<body onload="disconnect()">
<noscript><h2 style="color: #ff0000">貌似你的浏览器不支持websocket</h2></noscript>
<div>
    <div>
        <button id="connect" onclick="connect();">连接</button>
        <button id="disconnect" disabled="disabled" onclick="disconnect();">断开连接</button>
    </div>
    <div id="conversationDiv">
        <label>请输入你的名字:</label><input type="text" id="name" />
        <button id="sendName" onclick="sendName();">发送</button>
        <p id="response"></p>
    </div>
</div>
<script src="js/jquery-2.1.1.min.js"></script>
<script src="//cdn.bootcss.com/angular.js/1.5.6/angular.min.js"></script>
<script src="https://cdn.bootcss.com/sockjs-client/1.1.4/sockjs.min.js"></script>
<script src="https://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>
<script type="text/javascript">
    var stompClient = null;

    function setConnected(connected) {
        document.getElementById('connect').disabled = connected;
        document.getElementById('disconnect').disabled = !connected;
        document.getElementById('conversationDiv').style.visibility = connected ? 'visible' : 'hidden';
        $('#response').html();
    }

    function connect() {
        var socket = new SockJS('/stomp'); //1<!--(1)连接SockJS的endpoint是“stomp”,与后台代码中注册的endpoint要一样。-->
        stompClient = Stomp.over(socket);//2<!--(2)创建STOMP协议的webSocket客户端。-->
        stompClient.connect({}, function(frame) {//3<!--(3)连接webSocket的服务端。-->
            setConnected(true);
            console.log('开始进行连接Connected: ' + frame);
            stompClient.subscribe('/topic/getResponse', function(respnose){ //4<!--(4)通过stompClient.subscribe()订阅服务器的目标是'/topic/getResponse'发送过来的地址,与@SendTo中的地址对应。-->
                showResponse(JSON.parse(respnose.body).responseMessage);
            });
        });
    }
    function disconnect() {
        if (stompClient != null) {
            stompClient.disconnect();
        }
        setConnected(false);
        console.log("Disconnected");
    }

    function sendName() {
        var name = $('#name').val();
        stompClient.send("/welcome", {}, JSON.stringify({ 'name': name }));//5<!--(5)通过stompClient.send()向地址为"/welcome"的服务器地址发起请求,与@MessageMapping里的地址对应。-->
    }

    function showResponse(message) {
        var response = $("#response");
        response.html(message);
    }
</script>
</body>
</html>

运行程序,浏览器打开http://localhost:8080/,就可以进行测试了·······

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容