WebSocket整合SpringBoot并传输JSON数据进行操作

1、引入依赖

	<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <springboot.version>2.2.1.RELEASE</springboot.version>
        <java.version>1.8</java.version>
        <swagger.version>2.7.0</swagger.version>
        <lombok.version>1.18.10</lombok.version>
    </properties>

<dependencies>
        <!--Springboot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <!--swagger ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.version}</version>
        </dependency>
        <!--lombok用来简化实体类：需要安装lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>${lombok.version}</version>
            <scope>provided</scope>
        </dependency>
        <!-- webSocket 集成 springboot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba/fastjson -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.75</version>
        </dependency>

    </dependencies>

2、创建Configuration配置类注入WebSocket

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {

    /**
     * 向spring容器中注入这个ServerEndpointExporter对象
     * @return
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter(){
        return new ServerEndpointExporter();
    }
}

3、编写WebSocketServer服务类

decoders = {OperatorDecoder.class},
encoders = {OperatorEncoder.class}
是进行webSocketMessage和实体类之间映射关系的类

import com.camera.entity.LoginCamera;
import com.camera.entity.Operator;
import com.camera.entity.OperatorDecoder;
import com.camera.entity.OperatorEncoder;
import com.camera.service.CloudService;
import com.camera.service.LoginService;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicInteger;

@ServerEndpoint(value = "/ptzControl",decoders = {OperatorDecoder.class},encoders = {OperatorEncoder.class})
@Component
public class WebSocketServer {

    //在WebSocket也是这样注入，因 SpringBoot+WebSocket 对每个客户端连接都会创建一个 WebSocketServer（@ServerEndpoint 注解对应的）对象，
    // Bean 注入操作会被直接略过，因而手动注入一个全局变量

    private static final AtomicInteger OnlineCount = new AtomicInteger(0);
    // concurrent包的线程安全Set，用来存放每个客户端对应的Session对象。
    private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();

    private static CloudService cloudService = new CloudServiceImpl();

    @PostConstruct
    public void init(){
        System.out.println("websocket loading");
    }

    /**
     * 连接建立成功调用方法
     * @param session
     */
    @OnOpen
    public void onOpen(Session session){
        SessionSet.add(session);
        OnlineCount.incrementAndGet();  // 在线数+1
        SendMessage(session,"连接成功");    // 告知客户端连接成功
    }

    /**
     * 连接关闭调用方法
     */
    @OnClose
    public void onClose(Session session){
        loginService.logOutAndCleanUp();
        SessionSet.remove(session);
        OnlineCount.decrementAndGet();
    }

    /**
     * 收到客户端消息后调用的方法
     * (这一部分有些丑啊 别骂 别骂)
     */
    @OnMessage
    public void onMessage(Operator operator, Session session){
        SendMessage(session,"接收到消息，消息内容："+ operator);
        System.out.println(operator.toString());
        if ("moveLeft".equals(operator.getOperate()))
            cloudService.moveLeft(operator.getNChannelID(), operator.getIparam2());
        if ("moveRight".equals(operator.getOperate()))
            cloudService.moveRight(operator.getNChannelID(), operator.getIparam2());
        if ("moveUp".equals(operator.getOperate()))
            cloudService.moveUp(operator.getNChannelID(), operator.getIparam2());
        if ("moveDown".equals(operator.getOperate()))
            cloudService.moveDown(operator.getNChannelID(), operator.getIparam2());
    }

    /**
     * 出现错误
     */
    @OnError
    public void onError(Session session,Throwable error){
        error.printStackTrace();
    }

    /**
     * 发送消息 实践表明 每次浏览器刷新 session会发生变化
     */
    public static void SendMessage(Session session,String message){
        try {
            session.getBasicRemote().sendText(String.format("%s (From Server,Session ID=%s)",message,session.getId()));
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 群发消息
     */
    public static void BroadCastInfo(String message) throws IOException {
        for (Session session : SessionSet) {
            if (session.isOpen())
                SendMessage(session,message);
        }
    }

    /**
     * 指定Session发送消息
     * @param sessionId
     * @param message
     * @throws IOException
     */
    public static void SendMessage(String message,String sessionId) throws IOException {
        Session session = null;
        for (Session s : SessionSet) {
            if(s.getId().equals(sessionId)){
                session = s;
                break;
            }
        }
        if(session!=null)
            SendMessage(session, message);
    }

}

4、编写entity->json的编码类

import com.alibaba.fastjson.JSON;

import javax.websocket.EncodeException;
import javax.websocket.Encoder;
import javax.websocket.EndpointConfig;

/**
 * 将JSON编码为entity
 */
public class OperatorEncoder implements Encoder.Text<Operator> {

    /**
     * 发送编码 entity->json
     * @param object
     * @return
     * @throws EncodeException
     */
    @Override
    public String encode(Operator object) throws EncodeException {
        return JSON.toJSONString(object);
    }

    @Override
    public void init(EndpointConfig endpointConfig) {

    }

    @Override
    public void destroy() {

    }
}

5、编写json->entity的解码类

import com.alibaba.fastjson.JSON;

import javax.websocket.Decoder;
import javax.websocket.EndpointConfig;

/**
 * 解码 json-> entity映射
 */
public class OperatorDecoder implements Decoder.Text<Operator> {

    /**
     * 转换json->entity
     * @param move
     * @return
     */
    @Override
    public Operator decode(String move) {
        return JSON.parseObject(move, Operator.class);
    }

    /**
     * 是否进行转换
     * @param s
     * @return
     */
    @Override
    public boolean willDecode(String s) {
        return true;
    }

    @Override
    public void init(EndpointConfig endpointConfig) {

    }

    @Override
    public void destroy() {

    }
}

至此，即可使用

6、可能出现的疑问或错误

1、空指针

在WebSocket也是这样注入，因 SpringBoot+WebSocket
对每个客户端连接都会创建一个WebSocketServer对象，Bean
注入操作会被直接略过，因而手动注入一个全局变量

2、主动发送消息时如果需要发送entity类型的数据使用

session.getBasicRemote().sendObject();

3、解码时报错无法解析

willDecode()会在decode()之前执行，查看是否被拦截导致无法转换

由于项目需求管理员这边发通知需要主动通知到用户，所以决定采用websocket方式进行前后端数据交换，后来便决定一个页面的所有请求全部用websocket，因此需要json格式来包装键值对的请求名和请求内容。
奉上springboot内置tomcat的websocket配置及使用。

1：Config配置，目前看到说是内置springboot需要注入beanServerEndpointExporter，待我们项目部署到外置tomcat服务器时删除，不需要注入

2：WebSocketController实现

贴上代码吧`
package com.ctfplatform.hznuctf.controller;

import com.ctfplatform.hznuctf.dao.CompetitionDao;
import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;

import java.util.concurrent.CopyOnWriteArraySet;

@ServerEndpoint(value = “/websocket”)
@Component
public class WebSocketController {

//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketController> webSocketSet = new CopyOnWriteArraySet<WebSocketController>();

//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;

/**
 * 连接建立成功调用的方法*/
@OnOpen
public void onOpen(Session session) {
    this.session = session;
    webSocketSet.add(this);     //加入set中
    addOnlineCount();           //在线数加1
    System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());
    try {
        sendMessage("conpetitionList","123");
    } catch (IOException e) {
        System.out.println("websocket IO异常");
    }
}
//	//连接打开时执行
//	@OnOpen
//	public void onOpen(@PathParam("user") String user, Session session) {
//		currentUser = user;
//		System.out.println("Connected ... " + session.getId());
//	}

/**
 * 连接关闭调用的方法
 */
@OnClose
public void onClose() {
    webSocketSet.remove(this);  //从set中删除
    subOnlineCount();           //在线数减1
    System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());
}

/**
 * 收到客户端消息后调用的方法
 *
 * @param message 客户端发送过来的消息*/
@OnMessage
public void onMessage(String message, Session session){
    System.out.println(message);
    JSONObject jo = JSONObject.fromObject(message);
    System.out.println(jo);
    JSONObject jo2 = JSONObject.fromObject(jo.get("submit"));
    System.out.println(jo2.get("competitionId"));
    System.out.println("来自客户端的消息:" + message);

// 群发消息
for (WebSocketController item : webSocketSet) {
try {
item.sendMessage(“conpetitionList”,“111”);
item.sendMessage(“questionList”,“222”);
} catch (IOException e) {
e.printStackTrace();
}
}
}

/**
 *
 * @param session
 * @param error
 */
@OnError
public void onError(Session session, Throwable error) {
    System.out.println("发生错误");
    error.printStackTrace();
}

// public void sendMessage(String message) throws IOException {
// this.session.getBasicRemote().sendText(message);
// }

public void sendMessage(String message,Object datas) throws IOException {
    JSONObject result = new JSONObject();
    result.put("message", message);
    result.put("datas", datas);
    this.session.getBasicRemote().sendText(result.toString());
}

/**
 * 群发自定义消息
 * */
public static void sendInfo(String message) throws IOException {
    System.out.println(message);
    for (WebSocketController item : webSocketSet) {
        try {
            item.sendMessage("conpetitionList",message);
        } catch (IOException e) {
            continue;
        }
    }
}

public static synchronized int getOnlineCount() {
    return onlineCount;
}

public static synchronized void addOnlineCount() {
    WebSocketController.onlineCount++;
}

public static synchronized void subOnlineCount() {
    WebSocketController.onlineCount--;
}

}
`
其中最主要的便是sendMessage方法，可以自定义方法，最后将json格式转成字符串传输即可。

而在onMessage里接到前端传递过来的json对象字符串形式后，需要通过
JSONObject.fromObject。这个包通过maven引入。

        <dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <version>2.4</version>
            <classifier>jdk15</classifier>
        </dependency>

jdk版本必须是这个才不报错噢
总之websocket还是比较简单的 ，又能实现实时的数据传输 很不错。