websocket @ServerEndpoint(value = “/websocket/{ip}”)详解

学习网络编程，理解HTTP协议和TCP/IP。 #生活技巧# #学习技巧# #编程学习指南#

WebSocket是JavaEE7新支持的：

    Javax.websocket.server包含注解，类，接口用于创建和配置服务端点

    Javax.websocket包则包含服务端点和客户断电公用的注解，类，接口，异常

    创建一个编程式的端点，需要继承Endpoint类，重写它的方法。

    创建一个注解式的端点，将自己的写的类以及类中的一些方法用前面提到的包中的注解装饰（@EndPoint，@OnOpen等等）。

编程式注解示例：

@Component

@ServerEndpoint(value = "/websocket/{ip}")

public class MyWebSocket {

private static final Logger log = LoggerFactory.getLogger(MyWebSocket.class);

private static int onlineCount = 0;

private static ConcurrentHashMap<String, MyWebSocket> webSocketMap = new ConcurrentHashMap<String, MyWebSocket>();

private Session session;

private String ip;

public static final String ACTION_PRINT_ORDER = "printOrder";

public static final String ACTION_SHOW_PRINT_EXPORT = "showPrintExport";

@OnOpen

public void onOpen(Session session, @PathParam("ip") String ip) {

this.session = session;

this.ip = ip;

webSocketMap.put(ip, this);

addOnlineCount();

log.info("有新连接加入,ip:{}！当前在线人数为:{}", ip, getOnlineCount());

ExportService es = BeanUtils.getBean(ExportService.class);

List<String> list = es.listExportCodesByPrintIp(ip);

ResponseData<String> rd = new ResponseData<String>();

rd.setAction(MyWebSocket.ACTION_SHOW_PRINT_EXPORT);

rd.setList(list);

sendObject(rd);

}

@OnClose

public void onClose(@PathParam("ip") String ip) {

webSocketMap.remove(ip);

subOnlineCount();

log.info("websocket关闭，IP：{},当前在线人数为:{}", ip, getOnlineCount());

}

@OnMessage

public void onMessage(String message, Session session) {

log.debug("websocket来自客户端的消息:{}", message);

OrderService os = BeanUtils.getBean(OrderService.class);

OrderVo ov = os.getOrderDetailByOrderNo(message);

ResponseData<OrderVo> rd = new ResponseData<OrderVo>();

ArrayList<OrderVo> list = new ArrayList<OrderVo>();

list.add(ov);

rd.setAction(MyWebSocket.ACTION_PRINT_ORDER);

rd.setList(list);

sendObject(rd);

}

@OnError

public void onError(Session session, Throwable error) {

log.error("webSocket发生错误！IP：{}", ip);

error.printStackTrace();

}

public void sendMessage(String message) {

try {

this.session.getBasicRemote().sendText(message);

} catch (IOException e) {

e.printStackTrace();

log.error("发送数据错误，ip:{},msg：{}", ip, message);

}

}

public void sendObject(Object obj) {

ObjectMapper mapper = new ObjectMapper();

mapper.setSerializationInclusion(Include.NON_NULL);

String s = null;

try {

s = mapper.writeValueAsString(obj);

} catch (JsonProcessingException e) {

e.printStackTrace();

log.error("转json错误！{}", obj);

}

this.sendMessage(s);

}

public static void sendInfo(String message) {

for (Entry<String, MyWebSocket> entry : webSocketMap.entrySet()) {

MyWebSocket value = entry.getValue();

value.sendMessage(message);

}

}

public static synchronized int getOnlineCount() {

return onlineCount;

}

public static synchronized void addOnlineCount() {

MyWebSocket.onlineCount++;

}

public static synchronized void subOnlineCount() {

MyWebSocket.onlineCount--;

}

public static ConcurrentHashMap<String, MyWebSocket> getWebSocketMap() {

return webSocketMap;

}

}

当创建好一个（服务）端点之后，将它以一个指定的URI发布到应用当中，这样远程客户端就能连接上它了。

Websocket（服务）端点以URI表述，有如下的访问方式：

ws://host:port/path?query

wss://host:port/path?query

注解详解：

@ServerEndPoint：

    RequiredElements :

        Value: URI映射

    OptionalElemens：

        subprotocols：

        decoders：解码器

        encoders：编码器

        configurator

建立连接相关：

Annotation

Event

Example

OnOpen

Connection opened

@OnOpen

Public void open(Sessionsession,

EndpointConfig conf) { }

OnMessage

Message received

@OnMessage

public void message(Sessionsession,

String msg) { }

OnError

Connection error

@OnError

public void error(Sessionsession,

Throwable error) { }

OnClose

Connection closed

@OnClose

public void close(Sessionsession,

CloseReason reason) { }

Session代表着服务端点与远程客户端点的一次会话。

容器会为每一个连接创建一个EndPoint的实例，需要利用实例变量来保存一些状态信息。

Session.getUserProperties提供了一个可编辑的map来保存properties，

例如，下面的端点在收到文本消息时，将前一次收到的消息回复给其他的端点

@ServerEndpoint("/delayedecho")

public class DelayedEchoEndpoint

{

@OnOpen

public void open(Sessionsession)

{

session.getUserProperties().put("previousMsg", "");

}

@OnMessage

public void message(Session session, Stringmsg)

{

String prev= (String) session.getUserProperties().get("previousMsg");

session.getUserProperties().put("previousMsg",msg);

try {

session.getBasicRemote().sendText(prev);

} catch (IOException e){ ... }

}

}

发送、接收消息：

Websocketendpoint能够发送和接收文本、二进制消息，另外，也可以发送ping帧和接收pong 帧

发送消息：

Obtain the Session object from theconnection.

从连接中获得Session对象

Session对象是endPoint中那些被注解标注的方法中可得到的参数

当你的message作为另外的消息的响应

在@OnMessage标注的方法中，有session对象接收message

如果你必须主动发送message，需要在标注了@OnOpen的方法中将session对象作为实例变量保存

这样，你可以再其他方法中得到该session对象

1.Use the Session object to obtain aRemote Endpoint object.

通过Session对象获得Remoteendpoint对象

2.Use the RemoteEndpoint object to sendmessages to the peer.

利用RemoteEndpoint对象来发送message

代码示例：

@ServerEndpoint("/echoall")

public class EchoAllEndpoint

{

@OnMessage

public void onMessage(Session session, Stringmsg)

{

try {

for (Session sess :session.getOpenSessions())

{

if (sess.isOpen())

sess.getBasicRemote().sendText(msg);

}

} catch (IOExceptione) { ... }

}

}

接收消息

OnMessage注解指定方法来处理接收的messages

在一个端点类中，至多可以为三个方法标注@OnMessage注解

消息类型分别为：text、binary、pong。

我们查看一下ServerEndpoint类源码：

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = {ElementType.TYPE})

public @interface ServerEndpoint {

public String value();

public String[] subprotocols() default {};

public Class<? extends Decoder>[] decoders() default {};

public Class<? extends Encoder>[] encoders() default {};

public Class<? extends ServerEndpointConfig.Configurator> configurator() default ServerEndpointConfig.Configurator.class;

Encoders and Decoders（编码器和解码器）：

WebSocket Api 提供了encoders 和 decoders用于 Websocket Messages 与传统java 类型之间的转换

An encoder takes a Java object and produces a representation that can be transmitted as a WebSocket message;

编码器输入java对象，生成一种表现形式，能够被转换成Websocket message

for example, encoders typically produce JSON, XML, or binary representations.

例如：编码器通常生成json、XML、二进制三种表现形式

A decoder performs the reverse function; it reads a WebSocket message and creates a Java object.

解码器执行相反的方法，它读入Websocket消息，然后输出java对象

编码器编码：

looks for an encoder that matches your type and uses it to convert the object to a WebSocket message.

利用RemoteEndpoint.Basic 或者RemoteEndpoint.Async的sendObject(Object data)方法将对象作为消息发送，容器寻找一个符合此对象的编码器，

利用此编码器将此对象转换成Websocket message

代码示例：可以指定为自己的一个消息对象

package com.zlxls.information;

import com.alibaba.fastjson.JSON;

import com.common.model.SocketMsg;

import javax.websocket.EncodeException;

import javax.websocket.Encoder;

import javax.websocket.EndpointConfig;

public class ServerEncoder implements Encoder.Text<SocketMsg> {

@Override

public void destroy() {

}

@Override

public void init(EndpointConfig arg0) {

}

@Override

public String encode(SocketMsg socketMsg) throws EncodeException {

try {

return JSON.toJSONString(socketMsg);

} catch (Exception e) {

e.printStackTrace();

return "";

}

}

}

Then, add the encodersparameter to the ServerEndpointannotation as follows:

@ServerEndpoint(

value = "/myendpoint",

encoders = { ServerEncoder.class, ServerEncoder1.class }

)

解码器解码：

Decoder.Binary<T>for binary messages

These interfaces specify the willDecode and decode methods.

the container calls the method annotated with @OnMessage that takes your custom Java type as a parameter if this method exists.

package com.zlxls.information;

import com.common.model.SocketMsg;

import javax.websocket.DecodeException;

import javax.websocket.Decoder;

import javax.websocket.EndpointConfig;

public class ServerDecoder implements Decoder.Text<SocketMsg>{

@Override

public void init(EndpointConfig ec){}

@Override

public void destroy(){}

@Override

public SocketMsg decode(String string) throws DecodeException{

return new SocketMsg();

}

@Override

public boolean willDecode(String string){

return false;

}

}

Then, add the decoderparameter to the ServerEndpointannotation as follows:

@ServerEndpoint(

value = "/myendpoint",

encoders = { ServerEncoder.class, ServerEncoder1.class },

decoders = {ServerDecoder.class }

)

处理错误：

To designate a method that handles errors in an annotated WebSocket endpoint, decorate it with @OnError:

@OnError

public void onError(Throwable t) throws Throwable {

System.out.println("错误: " + t.toString());

}

为一个注解式的端点指定一个处理error的方法，为此方法加上@OnError注解：

This method is invoked when there are connection problems, runtime errors from message handlers, or conversion errors when decoding messages.

当出现连接错误，运行时错误或者解码时转换错误，该方法才会被调用

指定端点配置类：

The Java API for WebSocket enables you to configure how the container creates server endpoint instances.

Websocket的api允许配置容器合适创建server endpoint 实例

You can provide custom endpoint configuration logic to:

Access the details of the initial HTTP request for a WebSocket connection

Perform custom checks on the OriginHTTP header

Modify the WebSocket handshake response

Choose a WebSocket subprotocol from those requested by the client

Control the instantiation and initialization of endpoint instances

To provide custom endpoint configuration logic, you extend the ServerEndpointConfig.Configurator class and override some of its methods.

继承ServerEndpointConfig.Configurator 类并重写一些方法，来完成custom endpoint configuration 的逻辑代码

In the endpoint class, you specify the configurator class using the configurator parameter of the ServerEndpoint annotation.

代码示例：

package com.zlxls.information;

import javax.servlet.http.HttpSession;

import javax.websocket.HandshakeResponse;

import javax.websocket.server.HandshakeRequest;

import javax.websocket.server.ServerEndpointConfig;

import javax.websocket.server.ServerEndpointConfig.Configurator;

public class GetHttpSessionConfigurator extends Configurator{

@Override

public void modifyHandshake(ServerEndpointConfig sec,HandshakeRequest request, HandshakeResponse response) {

HttpSession httpSession=(HttpSession) request.getHttpSession();

sec.getUserProperties().put(HttpSession.class.getName(),httpSession);

}

}

@OnOpen

public void open(Session s, EndpointConfig conf){

HandshakeRequest req = (HandshakeRequest) conf.getUserProperties().get("sessionKey");

}

@ServerEndpoint(

value = "/myendpoint",

configurator=GetHttpSessionConfigurator.class

)

不过要特别说一句：

HandshakeRequest req = (HandshakeRequest) conf.getUserProperties().get("sessionKey");  目前获取到的是空值。会报错：java.lang.NullPointerException，这个错误信息，大家最熟悉不过了。

原因是：请求头里面并没有把相关的信息带上

这里就需要实现一个监听，作用很明显：将所有request请求都携带上httpSession，这样就可以正常访问了

说明：注解非常简单可以直接使用注解@WebListener，也可以再web.xml配置监听

package com.zlxls.information;

import javax.servlet.ServletRequestEvent;

import javax.servlet.ServletRequestListener;

import javax.servlet.annotation.WebListener;

import javax.servlet.http.HttpServletRequest;

@WebListener

public class RequestListener implements ServletRequestListener {

@Override

public void requestInitialized(ServletRequestEvent sre) {

((HttpServletRequest) sre.getServletRequest()).getSession();

}

public RequestListener() {}

@Override

public void requestDestroyed(ServletRequestEvent arg0) {}

}

网址：websocket @ServerEndpoint(value = “/websocket/{ip}”)详解 https://www.yuejiaxmz.com/news/view/263733

相关内容

如何使用websocket压力并发测试工具
2024 年 8 个好用的 Websocket 测试工具推荐
websocket压力测试小工具
压力测试工具哪个好？压力测试工具盘点
JS如何实现远程控制：一步步教你掌握技术远程控制是指通过网络等远距离通讯手段控制另一设备的操作行为。在现实生活中，随着物
压力测试工具下载 Socket Client Tester(压力测试软件) v1.0 免费绿色版 下载
压测工具如何选择? ab、locust、Jmeter、go压测工具【单台机器100w连接压测实战】
轻松搭建，畅快沟通：Python打造高效聊天室私聊体验
Laravel 中使用 swoole 项目实战开发案例二 (后端主动分场景给界面推送消息)life
基于Android系统的智能社区平台系统APP设计与实现（含论文）

随便看看