Spring websocket配置及其他

 

 

根据spring版本下载对应支持架包,spring最低版本4.0+

web容器对应 tomcat8.0+ tomcat8.0以下没有找到对应解决方案,出现问题架包冲突,缺少方法.

配置:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
import org.springframework.web.socket.handler.TextWebSocketHandler;

@Configuration
@EnableWebMvc
@EnableWebSocket
public class SpringWebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
    
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(),"/websocket/socketServer.do")
                .addInterceptors(new SpringWebSocketHandlerInterceptor());
        
        registry.addHandler(webSocketHandler(), "/sockjs/socketServer.do")
                .addInterceptors(new SpringWebSocketHandlerInterceptor()).withSockJS();
    }
 
    @Bean
    public TextWebSocketHandler webSocketHandler(){
 
        return new SpringWebSocketHandler();
    }


}

拦截器:

import java.util.Map;
 
import javax.servlet.http.HttpSession;
 
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;
 

public class SpringWebSocketHandlerInterceptor extends HttpSessionHandshakeInterceptor {
    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
                                   Map<String, Object> attributes) throws Exception {
        System.out.println("Before Handshake");
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession(false);
            if (session != null) {
                //使用userName区分WebSocketHandler，以便定向发送消息
                String userName = (String) session.getAttribute("SESSION_USERNAME");  //一般直接保存user实体
                if (userName!=null) {
                    attributes.put("WEBSOCKET_USERID",userName);
                }
 
            }
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);
 
    }
 
    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
                               Exception ex) {
        super.afterHandshake(request, response, wsHandler, ex);
    }
}

处理器:

import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.socket.CloseStatus;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

import com.iplat.base.system.entity.SysUser;
import com.iplat.common.util.Const;

public class SpringWebSocketHandler extends TextWebSocketHandler {
 
    private static Logger logger = LoggerFactory.getLogger(SpringWebSocketHandler.class);
 
    private static final Map<String, WebSocketSession> users;  //Map来存储WebSocketSession，key用USER_ID 即在线用户列表
 
    //用户标识
    //private static final String USER_ID = "WEBSOCKET_USERID";   //对应监听器从的key
    private static final String USER_ID =  Const.SESSION_SYS_USER;
 
    static {
        users =  new HashMap<String, WebSocketSession>();
    }
 
    public SpringWebSocketHandler() {}
 
    /**
     * 连接成功时候，会触发页面上onopen方法
     */
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
 
        System.out.println("成功建立websocket连接!");
        //String userId = (String) session.getAttributes().get(USER_ID);
        SysUser sysUser = (SysUser) session.getAttributes().get(USER_ID);
        users.put(sysUser.getId(),session);
        System.out.println("当前线上用户:" + sysUser.getId());
        System.out.println("当前线上用户数量:"+users.size());
 
        //这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户
        //TextMessage returnMessage = new TextMessage("成功建立socket连接，你将收到的离线");
        //session.sendMessage(returnMessage);
    }
 
    /**
     * 关闭连接时触发
     */
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        logger.debug("关闭websocket连接");
       // String userId= (String) session.getAttributes().get(USER_ID);
       
       // System.out.println("用户"+userId+"已退出！");
       // users.remove(userId);
        SysUser sysUser = (SysUser) session.getAttributes().get(USER_ID);
        System.out.println("用户"+sysUser.getId()+"已退出！");
        
        users.remove(sysUser.getId());
        System.out.println("剩余在线用户"+users.size());
    }
 
    /**
     * js调用websocket.send时候，会调用该方法
     */
    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
 
        super.handleTextMessage(session, message);
 
        /**
         * 收到消息，自定义处理机制，实现业务
         */
        System.out.println("服务器收到消息："+message);
 
        if(message.getPayload().startsWith("#anyone#")){ //单发某人
 
             sendMessageToUser((String)session.getAttributes().get(USER_ID), new TextMessage("服务器单发：" +message.getPayload())) ;
 
        }else if(message.getPayload().startsWith("#everyone#")){
 
             sendMessageToUsers(new TextMessage("服务器群发：" +message.getPayload()));
 
        }else{
 
        }
 
    }
 
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){
            session.close();
        }
        logger.debug("传输出现异常，关闭websocket连接... ");
       // String userId= (String) session.getAttributes().get(USER_ID);
        //users.remove(userId);
        SysUser sysUser = (SysUser) session.getAttributes().get(USER_ID);
        System.out.println("用户"+sysUser.getId()+"已退出！");
        users.remove(sysUser.getId());
    }
 
    public boolean supportsPartialMessages() {
 
        return false;
    }
 
 
    /**
     * 给某个用户发送消息
     *
     * @param userId
     * @param message
     */
    public void sendMessageToUser(String userId, TextMessage message) {
        for (String id : users.keySet()) {
            if (id.equals(userId)) {
                try {
                    if (users.get(id).isOpen()) {
                        users.get(id).sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }
 
    /**
     * 给所有在线用户发送消息
     *
     * @param message
     */
    public void sendMessageToUsers(TextMessage message) {
        for (String userId : users.keySet()) {
            try {
                if (users.get(userId).isOpen()) {
                    users.get(userId).sendMessage(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    
    public List<String> getOnlineUser(){
    	List<String> onlineUser =  new ArrayList<String>();
    	
    	Set<String> keySet = users.keySet();
    	Iterator<String> it   = keySet.iterator();
    	while (it.hasNext()) {
    	    String key = it.next();
    	    //有了键可以通过map集合的get方法获取其对应的值。
    	    //String value = map.get(key);
    	    //获得key和value值
    	    System.out.println("user: " + key );
    	    onlineUser.add(key);
    	}
    	return onlineUser;
    }
 
}

<script type="text/javascript">
	
				
				
			var websocket;
            /*
			if ('WebSocket' in window) {
                websocket = new WebSocket("ws://${ctx}/websocket/socketServer.do");
            } else if ('MozWebSocket' in window) {
                websocket = new MozWebSocket("ws://${ctx}/websocket/socketServer.do");
            } else {
                websocket = new SockJS("http://${ctx}/sockjs/socketServer.do");
            }*/
            

            websocket = new SockJS("${ctx}/sockjs/socketServer.do");
            
            websocket.onopen = function (evnt) {
            };
            websocket.onmessage = function (evnt) {
                //$("#msgcount").html("(<font color='red'>"+evnt.data+"</font>)")
            	pop(evnt.data);
            };
            websocket.onerror = function (evnt) {
            };
            websocket.onclose = function (evnt) {
            }
		
	</script>

注意点 tomcat版本