IDEA + Spring Boot + Gradle + websocket 入门笔记

WebSocket是一种网络通讯协议,一个TCP连接的两端,可以同时给对方发送消息,即支持全双工通信。比较常见的应用场景就是服务端给客户端推送信息,相对于轮询,WebSocket减少了宽带资源浪费,实时性更强。

WebSocket利用了HTTP协议,建立连接之后,会先发一个特殊的HTTP请求过去,服务器发现这是个WebSocket的请求之后,就按照协议要求返回一个特殊的HTTP响应,告诉客户端“我知道你想用WebSocket了,我们按照它的协议来工作吧”。然后TCP链接就不会断开了,留着发消息。所以说WebSocket只利用你原来的80端口(ws://)和443端口(wss://)就可以工作,不需要再开个端口。

我们将使用以下框架 or 工具
IDEA 2021.1
Gradle 6.8.3
Spring Boot 2.3.10

1. 新建springboot项目

可以在 https://start.spring 生成springboot项目
image.png

2. build.gradle 添加 spring-boot-starter-websocket

plugins {
    id 'org.springframework.boot' version '2.3.10.RELEASE'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'java'
    id 'idea'
}

group = 'com.ben'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
    developmentOnly
    runtimeClasspath {
        extendsFrom developmentOnly
    }
    compileOnly {
        extendsFrom annotationProcessor
    }
}

repositories {
    maven{ url 'https://maven.aliyun.com/repository/public'}
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.springframework.boot:spring-boot-starter-websocket'
    implementation 'org.projectlombok:lombok:1.18.18'

    testImplementation('org.springframework.boot:spring-boot-starter-test') {
        exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
    }
}

test {
    useJUnitPlatform()
}

WebSocket HelloWorld版构建

1. configuration 配置

在src/main目录下创建websocketdemo目录,然后创建MyWebsocketConfig.java

package com.ben.websocketdemo;

import org.springframework.beans.factory.annotation.Autowired;
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 {

    @Autowired
    MyWebsocketHandler myWebsocketHandler;

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(myWebsocketHandler,"/bensocket").setAllowedOrigins("*");
    }
}

注意上面的配置文件,两点

  • 添加注解 @EnableWebSocket 表示开启了webocket服务
  • registerWebSocketHandlers 这个方法用来注册websocket服务,上面表示将路径 /bensocket 的请求转发到 myWebsocketHandler

2. WebSocketHandler 处理类

myWebsocketHandler 可以实现WebSocketHandler接口,在WebSocket连接建立或者断开、收到消息或者收到错误的时候这些方法会被调用( 这里就不示范了 )。如果你感觉回调太多或者不好用,可以继承AbstractWebSocketHandler类,只实现自己想要的方法:

在src/main/websocketdemo目录创建MyWebsocketHandler.java

package com.ben.websocketdemo;

import org.springframework.stereotype.Component;
import org.springframework.web.socket.BinaryMessage;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;

import java.nio.ByteBuffer;

@Component
public class MyWebsocketHandler extends AbstractWebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        System.out.println("afterConnectionEstablished");
    }

    // 发送文本消息
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
         String msg = message.getPayload();

        // 向客户端发送数据
        session.sendMessage(new TextMessage("你好哦: " + msg));
    }

    // 发送二进制消息
    @Override
    protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) throws Exception {
        ByteBuffer byteBuffer = message.getPayload();
        session.sendMessage(new BinaryMessage(byteBuffer));
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        System.out.println("afterConnectionClosed");
    }
}

返回数据则是借助WebSocketSession即与客户端之间的会话,来发送数据的

3. 测试

安装简易的命令行WebSocket客户端

npm install -g ws wscat

npm 需要安装下nodejs 官网下载安装即可

然后执行

wscat -c ws://127.0.0.1:8080/bensocket

如果遇到提示 系统禁止运行脚本(win10)
解决方法: 以管理员方式打开powershell 运行命令:set-ExecutionPolicy RemoteSigned

image.png

既然两边可以收发消息了,可以定义消息格式,比较简单的做法是使用文本消息,发送JSON对象。
也可使用 protobuf 来发送接受数据 后面有时间再写个demo

评论

暂无评论