2、Java WebSocket实现服务端主动发消息给客户端

最新推荐文章于 2024-05-18 12:09:03 发布

君子丨莫笑

最新推荐文章于 2024-05-18 12:09:03 发布

阅读量1.6w

点赞数 6

分类专栏： websocket-推送实时消息文章标签： websocket java

本文链接：https://blog.csdn.net/gaolele_92/article/details/76158087

版权

websocket-推送同时被 2 个专栏收录

1 篇文章 0 订阅

订阅专栏

实时消息

1 篇文章 0 订阅

订阅专栏

开发环境：Windows x64，Eclipse 4.6.2，Tomcat 7.0.79，Jdk 1.8。
介绍

现很多网站为了实现即时通讯，所用的技术都是轮询(polling)。轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出HTTP request，然后由服务器返回最新的数据给客服端的浏览器。这种传统的HTTP request 的模式带来很明显的缺点 – 浏览器需要不断的向服务器发出请求，然而HTTP request 的header是非常长的，里面包含的数据可能只是一个很小的值，这样会占用很多的带宽。

而最比较新的技术去做轮询的效果是Comet – 用了AJAX。但这种技术虽然可达到全双工通信，但依然需要发出请求。

在 WebSocket API，浏览器和服务器只需要要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

依赖：
Tomcat 7 或者 J2EE7
我用的tomcat 7.0.79和Java jdk1.8.0（1.7Linux服务器架设有问题），我使用的时候，没有需要自己手动引用别的jar包，tomcat默认jar包就可以运行。

遇到的问题：

开始用的eclipse4.3版本，不支持jdk1.8，后改用的4.6.2。
虽然tomcat7.0.47就已支持WebSocket，但是tomcat7.0.47版本只支持jdk1.6，所以改用tomcat7.0.79.

注意：早前业界没有统一的标准，各服务器都有各自的实现，现在J2EE7的JSR356已经定义了统一的标准，请尽量使用支持最新通用标准的服务器。

详见：

http://www.oracle.com/technetwork/articles/java/jsr356-1937161.html
http://jinnianshilongnian.iteye.com/blog/1909962
用nginx做反向代理的需要注意啦，socket请求需要做特殊配置的，切记！

##服务端
服务端使用注解模式后，不需要在web.xml中做额外的配置，Tomcat启动后就可以直接连接了（去掉注解，使用web.xml中配置后，启动服务报错cannot be cast to javax.servlet.Servlet）。

源码：

package com.hdtytech.websocket;

import java.io.IOException;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;

@ServerEndpoint(value = "/websocket")  
public class MyWebSocket{
    //与某个客户端的连接会话，需要通过它来给客户端发送数据
    private Session session;
    /**
     * 连接建立成功调用的方法
     * @param session  可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
     * @throws Exception 
     */
    @OnOpen
    public void onOpen(Session session) throws Exception{
        this.session = session;
        WebSocketMapUtil.put(session.getQueryString(),this);
    }
     
    /**
     * 连接关闭调用的方法
     * @throws Exception 
     */
    @OnClose
    public void onClose() throws Exception{
    	//从map中删除
    	WebSocketMapUtil.remove(session.getQueryString());
    }
     
    /**
     * 收到客户端消息后调用的方法
     * @param message 客户端发送过来的消息
     * @param session 可选的参数
     * @throws IOException 
     */
    @OnMessage
    public void onMessage(String message, Session session) throws IOException {
        try {
        	MyWebSocket myWebSocket= ((MyWebSocket) WebSocketMapUtil.get(session.getQueryString().replace("service", "client")));
        	if(myWebSocket != null){
        		myWebSocket.sendMessage(message);
        	}
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
     
    /**
     * 发生错误时调用
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error){
        error.printStackTrace();
    }
     
    
    /**
     * 发送消息方法。
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException{
        this.session.getBasicRemote().sendText(message);
    }
    
    /**
     * 群发消息方法。
     * @param message
     * @throws IOException
     */
    public void sendMessageAll(String message) throws IOException{
    	for(MyWebSocket myWebSocket : WebSocketMapUtil.getValues()){
    		myWebSocket.sendMessage(message);
    	}
    }
}

##客户端

源码：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
 
<!DOCTYPE HTML>
<html>
  <head>
    <base href="<%=basePath%>">
    <title>My WebSocket</title>
  </head>
   
  <body>
    Welcome<br/>
    <input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>
    <div id="message">
    </div>
  </body>
   
  <script type="text/JavaScript">
      var websocket = null;
      //判断当前浏览器是否支持WebSocket
      if('WebSocket' in window){
          websocket = new WebSocket("ws://localhost:8080/MyWebSocket/websocket?client123");
      }
      else{
          alert('Not support websocket');
      }
       
      //连接发生错误的回调方法
      websocket.onerror = function(){
          setMessageInnerHTML("error");
      };
       
      //连接成功建立的回调方法
      websocket.onopen = function(event){
          setMessageInnerHTML("open");
      };
       
      //接收到消息的回调方法
      websocket.onmessage = function(event){
          setMessageInnerHTML(event.data);
      };
       
      //连接关闭的回调方法
      websocket.onclose = function(){
          setMessageInnerHTML("close");
      };
       
      //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
      window.onbeforeunload = function(){
          websocket.close();
      };
       
      //将消息显示在网页上
      function setMessageInnerHTML(innerHTML){
          document.getElementById('message').innerHTML += innerHTML + '<br/>';
      }
       
      //关闭连接
      function closeWebSocket(){
          websocket.close();
      }
       
      //发送消息
      function send(){
          var message = document.getElementById('text').value;
          websocket.send(message);
      }
  </script>
</html>

##工具类ConcurrentMap
用来存储唯一key和连接（ConcurrentMap是线性安全的Map）

这个是我业务的需要，因为我的业务是服务器需要主动点对点发送消息给客户端，所以需要用Map来存储客户端连接。

遇到的问题：

本来想直接调用服务端的发送接口，从Map中取到需要发送的客户端连接信息，但是只要在外部调用MapUtil,MapUtil就会重新实例化，Map为空，也就是把连接放在单独静态Map中不可行。
后来也考虑把Map放在session中，但是考虑到session容易丢失，就放弃了这个想法。
又考虑使用memcache，但是在往memcache放的时候，报需要序列化的错，也放弃了这个想法。

解决办法：
后来就模仿微信聊天一样，把服务端做为一个中间转发消息的中间件，在服务端定义一个客户端类，在需要给客户端发送消息时，调用客户端类，发送消息到中间件，通过中间件转发消息到你想发送的客户端，若需要取法消息，则可便利Map客户端进行群发通知公告等。

源码：

package com.hdtytech.websocket;

import java.util.Collection;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

public class WebSocketMapUtil {
	public static ConcurrentMap<String, MyWebSocket> webSocketMap = new ConcurrentHashMap<>();
    public static void put(String key, MyWebSocket myWebSocket){
    	webSocketMap.put(key, myWebSocket);
    }
    	 
    public static MyWebSocket get(String key){
    	 return webSocketMap.get(key);
    }
    	 
	public static void remove(String key){
		 webSocketMap.remove(key);
	}
	
	public static Collection<MyWebSocket> getValues(){
		return webSocketMap.values();
	}
}

##服务端用于主动发消息的客户端类

源码：

package com.hdtytech.websocket;

import java.io.IOException;
import java.net.URI;

import javax.websocket.ClientEndpoint;
import javax.websocket.ContainerProvider;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.WebSocketContainer;

@ClientEndpoint
public class MyClient {
	
	private Session session;
	@OnOpen
	public void onOpen(Session session) throws IOException {
		this.session = session;
	}

	@OnMessage
	public void onMessage(String message) {
	}

	@OnError
	public void onError(Throwable t) {
		t.printStackTrace();
	}
	/**
     * 连接关闭调用的方法
     * @throws Exception 
     */
    @OnClose
    public void onClose() throws Exception{
    }
    
    /**
     * 关闭链接方法
     * @param message
     * @throws IOException
     */
    public void closeSocket() throws IOException{
        this.session.close();
    }
    
    /**
     * 发送消息方法。
     * @param message
     * @throws IOException
     */
    public void sendMessage(String message) throws IOException{
        this.session.getBasicRemote().sendText(message);
    }
    //启动客户端并建立链接
    public void start(String uri) {
		WebSocketContainer container = ContainerProvider.getWebSocketContainer();
		try {
			this.session = container.connectToServer(MyClient.class, URI.create(uri));
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

##测试main函数
说明：为了测试，写了一个timer，每个两秒，调用发送给客户端发送一条消息；

源码：

package com.hdtytech.websocket;

import java.io.IOException;
import java.util.Timer;
import java.util.TimerTask;

public class MyClientApp {


	public static void main(String[] args){
		 // TODO todo.generated by zoer  
        Timer timer = new Timer();  
        timer.schedule(new MyTask(), 1000, 2000);  
	}
	static int num = 0;
	static class MyTask extends TimerTask {  
		  
	    @Override  
	    public void run() {  
	    	MyClient client = new MyClient();
			String uri = "ws://localhost:8080/MyWebSocket/websocket?service123";
			client.start(uri);
			try {
				num++;
				client.sendMessage("消息测试"+num);
				client.closeSocket();
				System.out.println(num);
			} catch (IOException e) {
				// TODO Auto-generated catch block
				e.printStackTrace();
			}
			
	    }  
	  
	} 
}