Spring4.0.6 Websocket详细配置 之 消息模块

阅读更多

历经一周把整个消息模块开发完毕，其中在websocket这块遇到比较多的问题是中文乱码，因为项目中用ajax跟后端交互，用@Response注解时候出现中文乱码，需要Spring MVC相关配置，这块遇到配置会在另一个文章体现。

鉴于网上提供的一些文章，都介绍不是很到位，关键部分都没体现，导致在真实项目中出现各种各样的问题。

 

===============================================

环境介绍：

Jdk 1.7

Tomcat7.0.52 （支持Websocket协议）

Spring4.0.26 （支持Websocket）

web.xml（配置了前端自动优化HtmlCompressor和Druid监控），自动优化会影响Websocket js脚本，后面会讲

=================================================

配置步骤：

1. 引入Spring相关Jar，特别需要下面这两个

       
            org.springframework
            spring-websocket
            4.0.6.RELEASE
       
       
            org.springframework
            spring-messaging
            4.0.6.RELEASE
       

 

2. 编写WebSocketConfig implements WebSocketConfigurer

WebSocketConfig.java

 

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;

import cn.com.ship.message.handler.ChatMessageHandler;
import cn.com.ship.message.handler.TextMessageHandler;

@Configuration
//@EnableWebMvc//这个标注可以不加，如果有加，要extends WebMvcConfigurerAdapter
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(chatMessageHandler(),"/websocket/chatMessageServer.do").addInterceptors(new ChatHandshakeInterceptor());
        registry.addHandler(chatMessageHandler(), "/sockjs/chatMessageServer.do").addInterceptors(new ChatHandshakeInterceptor()).withSockJS();
    }
 
    @Bean
    public TextWebSocketHandler chatMessageHandler(){
        return new ChatMessageHandler();
    }

}

 3. 编写ChatMessageHandler extends TextWebSocketHandler

ChatMessageHandler.java

 

 

import java.io.IOException;
import java.util.ArrayList;

import org.apache.log4j.Logger;
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 cn.com.ship.message.common.Constants;
import cn.com.ship.message.common.MessageCriteria;

public class ChatMessageHandler extends TextWebSocketHandler{

	private static final ArrayList users;//这个会出现性能问题，最好用Map来存储，key用userid
	private static Logger logger = Logger.getLogger(ChatMessageHandler.class);
	static {
		users = new ArrayList();
	}
	
	public ChatMessageHandler() {
		// TODO Auto-generated constructor stub
	}
		
	/**
	 * 连接成功时候，会触发UI上onopen方法
	 */
	@Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
		System.out.println("connect to the websocket success......");
	users.add(session);
	//这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户
        //TextMessage returnMessage = new TextMessage("你将收到的离线");
	//session.sendMessage(returnMessage);
    }

	/**
	 * 在UI在用js调用websocket.send()时候，会调用该方法
	 */
	@Override
	protected void handleTextMessage(WebSocketSession session,
			TextMessage message) throws Exception {
		super.handleTextMessage(session, message);
				
	}

	/**
     * 给某个用户发送消息
     *
     * @param userName
     * @param message
     */
    public void sendMessageToUser(String userName, TextMessage message) {
        for (WebSocketSession user : users) {
            if (user.getAttributes().get(Constants.WEBSOCKET_USERNAME).equals(userName)) {
                try {
                    if (user.isOpen()) {
                        user.sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }
    
    /**
     * 给所有在线用户发送消息
     *
     * @param message
     */
    public void sendMessageToUsers(TextMessage message) {
        for (WebSocketSession user : users) {
            try {
                if (user.isOpen()) {
                    user.sendMessage(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){
            session.close();
        }
        logger.debug("websocket connection closed......");
        users.remove(session);
    }
    
    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        logger.debug("websocket connection closed......");
        users.remove(session);
    }
    
    @Override
    public boolean supportsPartialMessages() {
        return false;
    }

}

 

 

4. 编写websocket握手拦截器ChatHandshakeInterceptor extends HttpSessionHandshakeInterceptor

ChatHandshakeInterceptor.java

 

package cn.com.ship.message.websocket;

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;

import cn.com.ship.message.common.Constants;

public class ChatHandshakeInterceptor extends HttpSessionHandshakeInterceptor {

	@Override
	public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Map 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(Constants.SESSION_USERNAME);
                if (userName==null) {
                	userName="default-system";
                }
                attributes.put(Constants.WEBSOCKET_USERNAME,userName);
                
            }
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);
	}

	@Override
	public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, Exception ex) {
		System.out.println("After Handshake");
		super.afterHandshake(request, response, wsHandler, ex);
	}
	

}

 

 

4. 重点在Spring mvc相关配置（经常出现问题就是：中文乱码，如果是用ajax交互）

 

	
	
	
		
			
				
				
				
				
			
		
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
		
	
		
			
				text/plain;charset=UTF-8
			
		
	
	
	
		
			
				
				
					
				
			
		
		
			
				application/json
			
		
	
	
	
		
			
				
					
						
					
				
				
				
					
				
			
		
		
			
				text/json
			
		
	
	
	
		
		
		
	

	
	
		
		
	

 注意：MappingJackson2HttpMessageConverter.java，来自Spring代码，并且修改了一点点，这个找到附件位置下载

 

 

5. jsp相关Websocket脚本编写

     ws.jsp

 

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>



	  





请输入：
发送

    login.jsp

 

 

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>




 


        
	

		登录名：
		
	

 

 

5. 调用端Controller编写 WebsocketController.java

 

package cn.com.ship.websocket.controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class WebsocketController {

	@Bean//这个注解会从Spring容器拿出Bean
	public InfoHandler infoHandler() {
		return new InfoHandler();
	}
	
	@RequestMapping("/websocket/login")
	public void login(HttpServletRequest request, HttpServletResponse response) throws Exception {
		String username = request.getParameter("username");
		HttpSession session = request.getSession(false);
		session.setAttribute(Constants.SESSION_USERNAME, username);
		
		response.sendRedirect("/ship/websocket/ws.jsp");
	}

	@RequestMapping("/websocket/send")
	@ResponseBody
	public String send(HttpServletRequest request) {
		
		String username = request.getParameter("username");
		infoHandler().sendMessageToUser(username, new TextMessage("你好，测试！！！！"));
		
		return null;
	}

}

 

 

6. 测试Websocket是否连接成功

   先在login.jsp上随便输入用户名，然后WebsocketController处理完请求，会重定向到ws.jsp

   如果后台打印出现消息，证明Websocket连接成功（前两名消息是在ChatHandshakeInterceptor.java，最后一句是在ChatMessageHandler.java）

Before Handshake
After Handshake
connect to the websocket success......

 

开发中遇到各个问题，会开另外一篇文章来描述！！！

 

http://strongant.iteye.com/blog/2153821