WebSocket总结

              今天继续，整理一下自己掌握的知识，今天我们要说的事WebSocket，可能很多人还没用过，还不知道这是个什么东西。我们先不说他是什么，我们先拿实际的例子来举例说明，我们日常在开发BS项目的时候，一般的处理流程是A用户通过浏览器点击了某个按钮，然后调用了服务端某个方法，返回一个结果集，这是我们平时做的最多的事情。突然有一天发现，假如两个同时在办公的人想在系统中进行交流的时候，发现服务器是无法主动推送消息给客户端的，那么问题来了，我们如何交流呢？以前的做法就是轮询，设定一个时间，然后将要交流的信息写入，读取。。。这样无形当中增加了客户端和服务器端的开销，而且麻烦。今天我们来认识认识这个WebSocket，他可以实现双向通信，他的出现将服务器端原来的被动等待变成了主动出击，不仅仅能接受请求，还能主动发送消息给客户端，是不是很强大，那么我们今天就来说说这个WebSocket。

             我们现在的开发基本都是基于Spring等的集成框架，所以我们日常用的较多的开发方式就是注解，WebSocket为我们的服务端开发提供了一下注解，主要有以下几个注解

@ServerEndpoint ---注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,注解的值将被用于监听用户连接的终端访问URL地址,客户端可 以                                          通过这个URL来连接到WebSocket服务器端。

@OnOpen-------------连接建立成功调用的方法

@OnMessage--------收到客户端消息后调用的方法

@OnError--------------发生错误时调用

@OnClose-------------连接关闭调用的方法

@Retention(RetentionPolicy.RUNTIME)@Target({java.lang.annotation.ElementType.TYPE})public @interface ServerEndpoint{  String value();   String[] subprotocols() default {};   Class<? extends Decoder>[] decoders() default {};   Class<? extends Encoder>[] encoders() default {};   Class<? extends ServerEndpointConfig.Configurator> configurator() default ServerEndpointConfig.Configurator.class;}

@Retention(RetentionPolicy.RUNTIME)@Target({java.lang.annotation.ElementType.METHOD})public @interface OnOpen {}

@Retention(RetentionPolicy.RUNTIME)@Target({java.lang.annotation.ElementType.METHOD})public @interface OnMessage{  long maxMessageSize() default -1L;}

@Retention(RetentionPolicy.RUNTIME)@Target({java.lang.annotation.ElementType.METHOD})public @interface OnError {}

@Retention(RetentionPolicy.RUNTIME)@Target({java.lang.annotation.ElementType.METHOD})public @interface OnClose {}

下面举个例子看下

<script type="text/javascript">    var websocket = null;    //判断当前浏览器是否支持WebSocket    if ('WebSocket' in window) {        websocket = new WebSocket("ws://localhost:8080/websocket");    }    else {        alert('当前浏览器 Not support websocket')    }    //连接发生错误的回调方法    websocket.onerror = function () {        setMessageInnerHTML("WebSocket连接发生错误");    };    //连接成功建立的回调方法    websocket.onopen = function () {        setMessageInnerHTML("WebSocket连接成功");    }    //接收到消息的回调方法    websocket.onmessage = function (event) {        setMessageInnerHTML(event.data);    }    //连接关闭的回调方法    websocket.onclose = function () {        setMessageInnerHTML("WebSocket连接关闭");    }    //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。    window.onbeforeunload = function () {        closeWebSocket();    }    //将消息显示在网页上    function setMessageInnerHTML(innerHTML) {        document.getElementById('message').innerHTML += innerHTML + '<br/>';    }    //关闭WebSocket连接    function closeWebSocket() {        websocket.close();    }    //发送消息    function send() {        var message = document.getElementById('text').value;        websocket.send(message);    }</script>

服务器端代码

import java.io.IOException;import java.util.concurrent.CopyOnWriteArraySet;import javax.websocket.*;import javax.websocket.server.ServerEndpoint;/** * @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端, * 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端 */@ServerEndpoint("/websocket")public class WebSocketTest {//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。private static int onlineCount = 0;//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户标识private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();//与某个客户端的连接会话，需要通过它来给客户端发送数据private Session session;/** * 连接建立成功调用的方法 * @param session  可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据 */@OnOpenpublic void onOpen(Session session){this.session = session;webSocketSet.add(this);     //加入set中addOnlineCount();           //在线数加1System.out.println("有新连接加入！当前在线人数为" + getOnlineCount());}/** * 连接关闭调用的方法 */@OnClosepublic void onClose(){webSocketSet.remove(this);  //从set中删除subOnlineCount();           //在线数减1System.out.println("有一连接关闭！当前在线人数为" + getOnlineCount());}/** * 收到客户端消息后调用的方法 * @param message 客户端发送过来的消息 * @param session 可选的参数 */@OnMessagepublic void onMessage(String message, Session session) {System.out.println("来自客户端的消息:" + message);//群发消息for(WebSocketTest item: webSocketSet){try {item.sendMessage(message);} catch (IOException e) {e.printStackTrace();continue;}}}/** * 发生错误时调用 * @param session * @param error */@OnErrorpublic void onError(Session session, Throwable error){System.out.println("发生错误");error.printStackTrace();}/** * 这个方法与上面几个方法不一样。没有用注解，是根据自己需要添加的方法。 * @param message * @throws IOException */public void sendMessage(String message) throws IOException{this.session.getBasicRemote().sendText(message);//this.session.getAsyncRemote().sendText(message);}public static synchronized int getOnlineCount() {return onlineCount;}public static synchronized void addOnlineCount() {WebSocketTest.onlineCount++;}public static synchronized void subOnlineCount() {WebSocketTest.onlineCount--;}}