今日内容
-
⑴ ⑵ ⑶ ⑷ ⑸ ⑹ ⑺ ⑻ ⑼
① ② ③ ④ ⑤ ⑥ ⑦ ⑧ ⑨
学习目标
-
⑴ ⑵ ⑶ ⑷ ⑸ ⑹ ⑺ ⑻ ⑼ ⑽
⑾ ⑿ ⒀ ⒁ ⒂ ⒃ ⒄ ⒅ ⒆ ⒇
① ② ③ ④ ⑤ ⑥ ⑦ ⑧ ⑨
一、引入依赖
建议!!和自己的Spring一个版本
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-websocket</artifactId>
<version>5.1.5.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-messaging</artifactId>
<version>5.1.5.RELEASE</version>
</dependency>
二、添加WebSocket处理器映射及拦截器
配置
访问地址和处理器的映射
及拦截器
注意!!! 一定要加上"setAllowedOrigins()"解决跨域问题!! 否则使用工具能连上, 使用浏览器就连不上!!!
@Component
@EnableWebSocket
public class WebSocketConfiguration implements WebSocketConfigurer {
@Resource
private ModelSessionWebSocketHandler handler;
/**
* 配置WebSocket链接地址
* @param registry
*/
@Override
public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
// 浏览器支持websocket
registry.addHandler(handler, "/modelSession")
.setAllowedOrigins("*")
.addInterceptors(new ModelSessionInterceptor());
// 浏览器不支持的话,需要SocketJs引入支持
// registry.addHandler(handler, "/modelSession/sockjs")
// .setAllowedOrigins("*")
// .addInterceptors(new ModelSessionInterceptor()).withSockJS();
}
}
这个类的作用是配置WebSocket的链接地址,分为浏览器支持WebSocket和不支持WebSocket的情况,不支持可以引入sockjs(某些环境下使用这行代码会导致无法连接,不放心可以删去)
WebSocket连接地址是:
ws://ip:端口号/项目名称/modelSession
WebSocket可以通过URL传参:
"ws://ip:端口号/项目名称/modelSession?userId="+userId
三、创建拦截器
public class ModelSessionInterceptor implements HandshakeInterceptor {
protected static Logger logger = LoggerFactory.getLogger(ModelSessionInterceptor.class);
private static SaasLoginService saasLoginService = SpringContextHolder.getBean(SaasLoginService.class);
public final static String HEADER_DEV_LOGIN_NAME = "dev-login-name";
public final static String HEADER_CLIENT_ID = "pro-client-id";
public final static String HEADER_ACCESS_TOKEN = "pro-access-token";
public final static String HEADER_ACCESS_SECRET_KEY = "pro-access-secret-key";
// 前置操作
@Override
public boolean beforeHandshake(ServerHttpRequest request,
ServerHttpResponse response,
WebSocketHandler wsHandler,
Map<String, Object> attributes) throws Exception {
// 获取Header中的参数
WebContextHolder.setDownloadBrowserFlag(false);
List<String> clientIdList = request.getHeaders().get(HEADER_CLIENT_ID);
List<String> accessTokenList = request.getHeaders().get(HEADER_ACCESS_TOKEN);
List<String> accessSecretKeyList = request.getHeaders().get(HEADER_ACCESS_SECRET_KEY);
List<String> devLoginNameList = request.getHeaders().get(HEADER_DEV_LOGIN_NAME);
// 获取Header中的参数
String clientId = CollectionUtils.isEmpty(clientIdList) ? null : clientIdList.get(0);
String accessToken = CollectionUtils.isEmpty(accessTokenList) ? null : accessTokenList.get(0);
String accessSecretKey = CollectionUtils.isEmpty(accessSecretKeyList) ? null : accessSecretKeyList.get(0);
String devLoginName = CollectionUtils.isEmpty(devLoginNameList) ? null : devLoginNameList.get(0);
// 对参数进行校验
User user = saasLoginService.checkLoginUser(devLoginName, clientId, accessToken, accessSecretKey, null, "");
// 如果用户为空或Id为空, 则拦截
if (user == null || StringUtils.isEmpty(user.getId())) {
logger.info("登录失败!");
return false;
}
// 将用户存入线程上下文中
WebContextHolder.setCurrentUser(user);
return true;
}
// 后置操作
@Override
public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception exception) {
}
}
这个类是WebSocket的握手拦截器,会拦截WebSocket链接地址的请求,进行握手,不建议在该类中做业务处理
四、创建处理器
@Slf4j
@Component
public class ModelSessionWebSocketHandler implements WebSocketHandler {
private final static String PARK_INQUIRE_INTERFACE_DOMAIN_WS_URL = Global.getConfig("park.interface.domain.ws");
/**
* 存储Session集合
*/
private static ConcurrentHashMap<String, WebSocketSession> sessionMap = new ConcurrentHashMap<>();
/**
* 存储对象集合
*/
private static ConcurrentHashMap<String, User> userMap = new ConcurrentHashMap<>();
/**
* 连接成功后
*
* @param session
* @throws Exception
*/
@Override
public void afterConnectionEstablished(WebSocketSession session) throws Exception {
// 获取用户Id
User user = UserUtils.getUser();
// 判断该用户是否已经链接
String userId = user.getId();
if (StringUtils.isEmpty(userId)){
log.error("未获取到用户信息!");
return;
}
if (sessionMap.get(userId) != null) {
log.error("用户已经登录! {}", userId);
return;
}
// 设置Map
setMap(session, user);
// 获取在线人数
log.info("用户连接: {}, 名称为: {}, 当前在线人数: {}", userId, user.getName(), sessionMap.size());
}
/**
* 设置Map集合
*
* @param session 会话
* @param user 用户
*/
private void setMap(WebSocketSession session, User user) {
// 获取用户Id
String userId = user.getId();
// 存储会话到会话集合
sessionMap.put(userId, session);
// 存储用户到用户集合
userMap.put(userId, user);
}
/**
* 关闭连接后
*
* @param session
* @param closeStatus
* @throws Exception
*/
@Override
public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
String userId = getUserIdBySession(session);
removeMap(userId);
log.info("用户下线: {}, 当前在线人数: {}", userId, sessionMap.size());
}
/**
* 当用户关闭会话时, 移除用户会话记录
*
* @param userId
*/
private void removeMap(String userId) {
if (StringUtils.isEmpty(userId)) {
// 用户不存在直接结束
return;
}
sessionMap.remove(userId);
userMap.remove(userId);
}
/**
* 根据会话找到用户id
*
* @param session
* @return
*/
private String getUserIdBySession(WebSocketSession session) {
for (String userId : sessionMap.keySet()) {
if (sessionMap.get(userId).getId().equals(session.getId())) {
return userId;
}
}
return null;
}
/**
* 消息传输错误处理
*
* @param webSocketSession
* @param throwable
* @throws Exception
*/
@Override
public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {
log.error("连接异常: {}", throwable.getMessage());
throwable.printStackTrace();
}
@Override
public boolean supportsPartialMessages() {
return false;
}
/**
* 消息处理
*
* @param session
* @param webSocketMessage
* @throws Exception
*/
@Override
public void handleMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage) throws Exception {
// 根据会话获取当前用户
User user = getUserBySession(session);
if (Objects.isNull(user)) {
log.info("未获取到用户信息!");
return;
}
// 解析消息
if (webSocketMessage.getPayloadLength() == 0){
log.info("消息内容为空!");
return;
}
log.info("用户: {}, 接收到了消息: {}", user.getId(), webSocketMessage.getPayload().toString());
// 获取用户发送内容
String requestJson = webSocketMessage.getPayload().toString();
// 返回消息
session.sendMessage(new TextMessage("收到! 收到! 收到!"));
// 以下是转发到其他WS中了, 如果没有不需要转发, 可以根据自身业务返回
// 连接服务器
//String url = PARK_INQUIRE_INTERFACE_DOMAIN_WS_URL.replace("http://", "ws://").replace("https://", "wss://");
//url += "/inquire/modelSession/" + user.getId();
//log.info("获取鉴权URL: {}", url);
// 发送请求
//Request request = new Request.Builder().url(url).build();
//OkHttpClient client = new OkHttpClient.Builder().build();
//BigModelSocketListener bigModelSocketListener = new BigModelSocketListener(requestJson, false, session);
//client.newWebSocket(request, bigModelSocketListener);
}
/**
* 根据会话获取当前用户
*
* @param session 会话
* @return
*/
private User getUserBySession(WebSocketSession session) {
String userId = getUserIdBySession(session);
if (StringUtils.isEmpty(userId)) {
return null;
}
return userMap.get(userId);
}
}
这个类是对websocket的各种状态作出相应的处理,如开头所说,本文不会给出相应的逻辑,防止出现错误,这里真的很坑
大体思路就是通过方法中的WebSocketSession获取到session中的用户id,再注入自己的userService(或者其他service层)去完成业务,同时可以在本类中使用ConcurrentHashMap或者直接开一个线程来实现同时在线人数等功能
发送信息的逻辑推荐对信息进行封装,构建实体类
五、如果还需要建立相应的请求到WebSocket会话中
import com.webchat.websocket.MyWebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/websocket")
public class WebSocketController {
@Autowired
private ModelSessionWebSocketHandler handler;
@GetMapping
....
@PostMapping
....
}
六、JS部分
let websocket = new WebSocket("ws://ip:端口号/项目名称/ws?userId="+userId);
websocket.onmessage = function(event) {
console.log(event.data)
};
websocket.onopen = function (event){
console.log("连接成功")
}
websocket.onerror = function (event){
console.log("连接错误")
}
websocket.onclose = function (event){
console.log('websocket 断开: ' + event.code + ' ' + event.reason + ' ' + event.wasClean)
}
七、错误码
如果在测试中出现其他错误,可以根据输出的
event.code
来匹配错误原因,如果连接后直接断开并显示1011请检查后端代码规范性
编码 | 原因 |
---|---|
1000 | 正常关闭 当你的会话成功完成时发送这个代码 |
1001 | 离开 因应用程序离开且不期望后续的连接尝试而关闭连接时,发送这一代码。服务器可能关闭,或者客户端应用程序可能关闭 |
1002 | 协议错误 当因协议错误而关闭连接时发送这一代码 |
1003 | 不可接受的数据类型 当应用程序接收到一条无法处理的意外类型消息时发送这一代码 |
1004 | 保留 不要发送这一代码。根据 RFC 6455,这个状态码保留,可能在未来定义 |
1005 | 保留 不要发送这一代码。WebSocket API 用这个代码表示没有接收到任何代码 |
1006 | 保留 不要发送这一代码。WebSocket API 用这个代码表示连接异常关闭 |
1007 | 无效数据 在接收一个格式与消息类型不匹配的消息之后发送这一代码。如果文本消息包含错误格式的 UTF-8 数据,连接应该用这个代码关闭 |
1008 | 消息违反政策 当应用程序由于其他代码所不包含的原因终止连接,或者不希望泄露消息无法处理的原因时,发送这一代码 |
1009 | 消息过大 当接收的消息太大,应用程序无法处理时发送这一代码(记住,帧的载荷长度最多为64 字节。即使你有一个大服务器,有些消息也仍然太大。) |
1010 | 需要扩展 当应用程序需要一个或者多个服务器无法协商的特殊扩展时,从客户端(浏览器)发送这一代码 |
1011 | 意外情况 当应用程序由于不可预见的原因,无法继续处理连接时,发送这一代码 |
1015 | TLS失败(保留) 不要发送这个代码。WebSocket API 用这个代码表示 TLS 在 WebSocket 握手之前失败。 |
0 ~ 999 | 禁止 1000 以下的代码是无效的,不能用于任何目的 |
1000 ~ 2999 | 保留 这些代码保留以用于扩展和 WebSocket 协议的修订版本。按照标准规定使用这些代码,参见表 3-4 |
3000 ~ 3999 | 需要注册 这些代码用于“程序库、框架和应用程序”。这些代码应该在 IANA(互联网编号分配机构)公开注册 |
4000 ~ 4999 | 私有 在应用程序中将这些代码用于自定义用途。因为它们没有注册,所以不要期望它们能被其他 WebSocket广泛理解 |