spring boot 学习笔记——使用webSocket

一、简介：

webSocket是基于TCP连接的全双工通信协议。它是最先出现在HTML5中，是类似于HTTP的一种传输协议，与HTTP不同的是，HTTP只能由客户端发起request请求然后由服务端返回response响应的一种协议。整个过程中都是由客户端发起，而服务端被动服务的。而webSocket则可以由服务端主动向客户端发起消息。
以前为了解决这种问题是利用ajax技术轮询向服务端发送请求直到收到想要的结果时才终止轮询。虽然也可以实现该目的，但是所需的服务器性能必须是非常好的。间接地影响了程序的性能。
适用场景：利用webSocket主要是为了解决高实时的场景，例如：GPS定位位置，视频弹幕，社交聊天...

二、搭建简单的例子

1.创建Spring boot工程，命名为：webSocket-spring-boot 并利用maven引入依赖，依赖配置如下：

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>webjars-locator-core</artifactId>
</dependency>
 
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>sockjs-client</artifactId>
    <version>1.0.2</version>
</dependency>
        
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>stomp-websocket</artifactId>
    <version>2.3.3</version>
</dependency>
        
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>bootstrap</artifactId>
    <version>3.3.7</version>
</dependency>
        
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.1.0</version>
</dependency>
		
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

2.传输消息建模，代码如下：

package com.example.demo;

public class HelloMessage {
    private String name;
	
    public HelloMessage() {
    }

    public HelloMessage(String name) {
        this.name = name;
    }
	
    //省略get,set方法
}

3.对返回的消息建模，代码如下：

package com.example.demo;

public class Greeting {
	private String content;
	
	public Greeting() {
	}
	
	public Greeting(String content) {
		this.content = content;
	}
	
	public String getContent() {
		return content;
	}
}

Spring 会使用JackSon Json库自动将类型实例封装到Json中去

4.构建控制器，创建java类命名为GreetingController .java。用于接受处理请求，代码如下：

package com.example.demo;

import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;
import org.springframework.web.util.HtmlUtils;

@Controller
public class GreetingController {

    @MessageMapping("/hello")
    @SendTo("/topic/greetings") 
    public Greeting greeting(HelloMessage message) throws InterruptedException {
        Thread.sleep(5000);
        return new Greeting("不知道你发送的啥，反正你发送的是： " + HtmlUtils.htmlEscape(message.getName()) + "!");
    }
	
}

@MessageMapping：与@requestMapping注解类似，用于设置url路径浏览器向服务器发送的请求地址。
@SendTo：重写了消息代理的目的地，如果不指定该注解，帧所发往的目的地与消息处理的目的地会相同，但是会添加 /topic 前缀。如果服务器接受了消息就会对该注解内的地址传输消息。

这里将程序等待5秒，是为了展示该请求发送后为异步处理。在处理期间并不会影响客户端的正常使用。

5.配置webSocket，创建java类，命名为WebSocketConfig .java。需要实现WebSocketMessageBrokerConfigurer接口，并重写里面的方法，代码如下：

package com.example.demo;

import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
	
	//配置消息代理选项
	@Override   
	public void configureMessageBroker(MessageBrokerRegistry config) {
		config.enableSimpleBroker("/topic");//配置使用消息代理，对应@SendTo注解
		config.setApplicationDestinationPrefixes("/app");//对应@MessageMapping注解
	}
	
	@Override
	public void registerStompEndpoints(StompEndpointRegistry registry) {
		//注册STOMP的节点，并指定使用SockeJs
		registry.addEndpoint("/gs-guide-websocket").withSockJS();
	}
	
	
}

@Configuration：当Spring启动时，创建该注解下类的实例与启动项类中的@Bean是一致的。
注意：启动类Appliction 需要在该配置类的上层包
@EnableWebSocketMessageBroker：开启使用STOMP协议传输基于代理的消息，这时候的控制器（controller）开始支持@MessageMapping注解。spring启动时，并按照一定的顺序调用重写的方法完成对WebSocket的初始化工作。

这里作者存在一个问题：当注解@Configuration 加载创建实例的时候，是如何控制加载顺序的。这里作者试用了@Order和@AutoConfigureBefore 都没有改变加载顺序。

6.创建前台页面建在\resources\static\index.html下，代码如下：

<!DOCTYPE html>
<html>
<head>
    <title>Hello WebSocket</title>
    <link href="/webjars/bootstrap/css/bootstrap.min.css" rel="stylesheet">
    <link href="/main.css" rel="stylesheet">
    <script src="/webjars/jquery/jquery.min.js"></script>
    <script src="/webjars/sockjs-client/sockjs.min.js"></script>
    <script src="/webjars/stomp-websocket/stomp.min.js"></script>
    <script src="/app.js"></script>
</head>
<body>
<noscript><h2 style="color: #ff0000">Seems your browser doesn't support Javascript! Websocket relies on Javascript being
    enabled. Please enable
    Javascript and reload this page!</h2></noscript>
<div id="main-content" class="container">
    <div class="row">
        <div class="col-md-6">
            <form class="form-inline">
                <div class="form-group">
                    <label for="connect">连接WebSocket:</label>
                    <button id="connect" class="btn btn-default" type="submit">连接</button>
                    <button id="disconnect" class="btn btn-default" type="submit" disabled="disabled">断开连接</button>
                </div>
            </form>
        </div>
        <div class="col-md-6">
            <form class="form-inline">
                <div class="form-group">
                    <label for="name">你要发送的内容?</label>
                    <input type="text" id="name" class="form-control" placeholder="Your message here...">
                </div>
                <button id="send" class="btn btn-default" type="submit">发送</button>
            </form>
        </div>
    </div>
    <div class="row">
        <div class="col-md-12">
            <table id="conversation" class="table table-striped">
                <thead>
                <tr>
                    <th>Greetings</th>
                </tr>
                </thead>
                <tbody id="greetings">
                </tbody>
            </table>
        </div>
    </div>
</div>
</body>
</html>

7.创建js，在/resources/static/app.js，代码如下：

var stompClient = null;

function setConnected(connected) {
    $("#connect").prop("disabled", connected);
    $("#disconnect").prop("disabled", !connected);
    if (connected) {
        $("#conversation").show();
    }
    else {
        $("#conversation").hide();
    }
    $("#greetings").html("");
}

function connect() {
    var socket = new SockJS('/gs-guide-websocket');
    stompClient = Stomp.over(socket);
    stompClient.connect({}, function (frame) {
        setConnected(true);
        console.log('Connected: ' + frame);
        stompClient.subscribe('/topic/greetings', function (greeting) {
            showGreeting(JSON.parse(greeting.body).content);
        });
    });
}

function disconnect() {
    if (stompClient !== null) {
        stompClient.disconnect();
    }
    setConnected(false);
    console.log("Disconnected");
}

function sendName() {
    stompClient.send("/app/hello", {}, JSON.stringify({'name': $("#name").val()}));
}

function showGreeting(message) {
    $("#greetings").append("<tr><td>" + message + "</td></tr>");
}

$(function () {
    $("form").on('submit', function (e) {
        e.preventDefault();
    });
    $( "#connect" ).click(function() { connect(); });
    $( "#disconnect" ).click(function() { disconnect(); });
    $( "#send" ).click(function() { sendName(); });
});

8.启动项目,访问http://localhost:8080,然后点击连接socket，之后输入信息点击发送，即可观察到效果

三、参考来源：

https://spring.io/guides/gs/messaging-stomp-websocket/

spring boot 学习笔记——使用webSocket

猜你喜欢