教你怎么使用Java实现WebSocket
一、WebSocket简介
WebSocket协议通过在客户端和服务端之间提供全双工通信来进行Web和服务器的交互功能。
在WebSocket应用程序中，服务器发布WebSocket端点，客户端使用url连接到服务器。建立连接后，服务器和客户端就可以互相发送消息。客户端通常连接到一台服务器，服务器接受多个客户端的连接。
1.1 WebSocket协议
WebSocket协议有两个部分：握手和传输。客户端通过向服务端URL发送握手请求来建立连接。握手与现有的基于HTTP的基础结构相兼容。Web服务器将其解释为升级版的HTTP连接请求。
一个客户端建立连接的握手请求：
GET /path/to/websocket/endpoint HTTP/1.1 Host: localhost Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: xqBt3ImNzJbYqRINxEFlkg== Origin: http://localhost Sec-WebSocket-Version: 13
一个服务端响应：
HTTP/1.1 101 Switching Protocols Upgrade: websocket Connection: Upgrade Sec-WebSocket-Accept: K7DJLdLooIwIG/MOpvWFB3y3FE8=
从上面的请求和响应中可以看出来，一个WebSocket连接的建立，需要客户端和服务端维护一个Key来作为该连接的连接凭证。
客户端向服务端发送WebSocketKey，服务器根据WebSocketKey生成WebSocketAccept返回给客户端，客户端对WebSocketKey的值再进行相同的操作，如果与服务器返回的Accept的值相匹配，就表示握手成功。握手之后客户端与服务端就互相发送消息。
1.2 WebSocket支持的消息类型
WebSocket支持文本消息（UTF-8编码）和二进制消息。WebSocket的控制消息由Close、Ping、Pong组成。ping和pong也有可能包含应用程序信息。
webSocket端点具有如下的URI形式表示：
ws://host:port/path?query wss://host:port/path?query
ws代表未加密的连接，默认端口是80
wss代表加密的连接，默认端口是443
path：表示服务器内端点的位置
query：路径参数信息
二、创建一个WebSocket程序
创建和部署WebSocket端点的过程如下：
1、创建一个端点类
2、实现端点的生命周期方法
3、将业务逻辑添加到端点
4、将端点部署到Web应用程序中
注意：与Servlet相反，WebSocket端点类会被实例化多次，容器针对与其部署的URI的每个连接都创建一个实例。每个实例都与一个连接相关联。因为在任何时间都只有一个线程执行端点实例的代码，所以有助于保持每个连接的用户状态简化开发。
2.1 生命周期方法
EndPoint类中定义了三个生命周期方法：onOpen、onClose、onError
使用注解方式创建服务类
@ServerEndpoint("/echo")
public class EchoEndpoint {
@OnMessage
public void onMessage(Session session, String msg) {
try {
session.getBasicRemote().sendText(msg);
} catch (IOException e) { ... }
}
}
2.2 业务逻辑方法
@ServerEndpoint("/receive")
public class ReceiveEndpoint {
@OnMessage
public void textMessage(Session session, String msg) {
System.out.println("Text message: " + msg);
}
@OnMessage
public void binaryMessage(Session session, ByteBuffer msg) {
System.out.println("Binary message: " + msg.toString());
}
@OnMessage
public void pongMessage(Session session, PongMessage msg) {
System.out.println("Pong message: " +
msg.getApplicationData().toString());
}
}
注意：一个服务类最多可以有三个OnMessage注解，每个消息类型分别使用一种方法：Text、Binary、Pong
2.3 维护客户状态
有时在程序中我们可能需要在连接中维护一些用户参数，WebSocket也提供了这样的服务
Session.getUserProperties获取用户参数信息
如果要存储所有连接的客户端共有的信息，可以使用静态变量，但是需要用户保证对数据的线程安全访问。
@ServerEndpoint("/delayedecho")
public class DelayedEchoEndpoint {
@OnOpen
public void open(Session session) {
session.getUserProperties().put("previousMsg", " ");
}
@OnMessage
public void message(Session session, String msg) {
String prev = (String) session.getUserProperties()
.get("previousMsg");
session.getUserProperties().put("previousMsg", msg);
try {
session.getBasicRemote().sendText(prev);
} catch (IOException e) { ... }
}
}
2.4 数据格式的编码与解码
由于客户端和服务端交互可能涉及数据格式的转换，所以提供了Decoder和Encoder的方式解决。
同时由于WebSocket的@Message注解只能有一个用来传输Text信息或Binary信息，所以要进行最常用的Json->entity转换解析就需要该方法
Encoder
Encoder.Text 用于文本消息Encoder.Binary 用于二进制消息
使用方法：
1、创建编解码类
public class MessageATextEncoder implements Encoder.Text<MessageA> {
@Override
public void init(EndpointConfig ec) { }
@Override
public void destroy() { }
@Override
public String encode(MessageA msgA) throws EncodeException {
// Access msgA's properties and convert to JSON text...
return msgAJsonString;
}
}
2、在端点类注解中添加该Encoder
@ServerEndpoint(
value = "/myendpoint",
encoders = { MessageATextEncoder.class, MessageBTextEncoder.class }
)
public class EncEndpoint { ... }
3、这时候就可以发送MessageA和MessageB两种类型的Text数据
MessageA msgA = new MessageA(...); MessageB msgB = new MessageB(...); session.getBasicRemote.sendObject(msgA); session.getBasicRemote.sendObject(msgB);
注意：webSocket会自动寻找使用哪种编码器，所以发送数据统一使用sendObject即可
Decoder
实现Decoder以将WebSocket消息转换为Java对象
- Decoder.Text 用于文本消息
- Decoder.Binary 用于二进制消息
使用方法
与Encoder类似
注意：与Encoder不同，Decoder最多可以指定一个Binary和一个Text类型的Decoder，如果有两种以上的Java类型作为文本消息进行发送和接收需要进行定义处理。可以使多个消息继承一个公共的消息父类
1、编写Decoder类，对收到消息类型的不同进行不同的解码
public class MessageTextDecoder implements Decoder.Text<Message> {
@Override
public void init(EndpointConfig ec) { }
@Override
public void destroy() { }
@Override
public Message decode(String string) throws DecodeException {
// Read message...
if ( /* message is an A message */ )
return new MessageA(...);
else if ( /* message is a B message */ )
return new MessageB(...);
}
@Override
public boolean willDecode(String string) {
// Determine if the message can be converted into either a
// MessageA object or a MessageB object...
return canDecode;
}
}
2、在端点类中添加decoders={MessageDecoder.class}
@ServerEndpoint(
value = "/myendpoint",
encoders = { MessageATextEncoder.class, MessageBTextEncoder.class },
decoders = { MessageTextDecoder.class }
)
public class EncDecEndpoint { ... }
3、在@OnMessage方法中使用
@OnMessage
public void message(Session session, Message msg) {
if (msg instanceof MessageA) {
// We received a MessageA object...
} else if (msg instanceof MessageB) {
// We received a MessageB object...
}
}
到此这篇关于教你怎么使用Java WebSocket的文章就介绍到这了,更多相关Java WebSocket详解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要介绍了JAVA中如何通过异常处理错误，文中讲解非常细致，代码帮助大家更好的理解，感兴趣的朋友可以了解下2020-06-06
这篇文章主要介绍了SpringBoot项目整合jasypt实现过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-08-08
这篇文章主要为大家详细介绍了Java中static关键字和内部类的使用，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一下2022-08-08
这篇文章主要介绍了Netty如何设置为Https访问，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-06-06
MyBatis如何处理MySQL字段类型date与datetime
这篇文章主要介绍了MyBatis如何处理MySQL字段类型date与datetime问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-01-01
Java如何解决发送Post请求报Stream closed问题
这篇文章主要介绍了Java如何解决发送Post请求报Stream closed问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-06-06
这篇文章主要介绍了java实现图片转ascii字符画的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-08-08
Querydsl是一个采用API代替拼凑字符串来构造查询语句，可跟 Hibernate 和 JPA 等框架结合使用。本文介绍的是非spring环境下querydsl JPA整合使用，感兴趣的小伙伴们可以参考一下2019-01-01
这篇文章主要介绍了jar包双击执行程序的方法,可实现双击jar包直接执行Java程序的功能,具有一定的参考借鉴价值,需要的朋友可以参考下2014-12-12
日新月异的技术圈，随着云、大数据、人工智能等主流技术的广泛应用，作为开发利器的编程语言的最新发展趋势也在无形中发生了变化，本文主要介绍了java、Python、Julia等语言在Resmonk榜单的排名2021-08-08
最新评论