MyException - 我的异常网
当前位置:我的异常网» Web前端 » java spring调整websocket教程

java spring调整websocket教程

www.MyException.Cn  网友分享于:2018-04-03  浏览:1次
java spring整合websocket教程

在javaweb项目开发中,我们经常可能需要websocket来实现人员互动,消息提醒等功能,但我们如何在ssm框架(spring+springmvc+mybatis)的spring中整合websocket呢?本人刚刚开发了一个消息提醒功能,就是在oa系统中,当申请人有一条申请记录时,会马上js弹窗消息告诉审批人员他有一条待办事项。

(请在ssm框架搭建好运行正常的情况下使用websocket整合教程),总共7个步骤,步骤7和最后面的红色字体备注的方式可以任选一种。

步骤一:ssm框架中使用到了maven项目,我们在pom.xml中添加引入jar包,还有json转换相关的jar包,因为websocket消息是通过json数据传输的,json相关的jar包有很多,我相信你的项目中已经有了,本人用的是jackson相关的jar包。

<!-- Jackson -->
<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-databind</artifactId>
	<version>${jackson.version}</version>
</dependency>

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-core</artifactId>
	<version>${jackson.version}</version>
</dependency>

<dependency>
	<groupId>com.fasterxml.jackson.core</groupId>
	<artifactId>jackson-annotations</artifactId>
	<version>${jackson.version}</version>
</dependency>
<dependency>
	<groupId>javax.websocket</groupId>
	<artifactId>javax.websocket-api</artifactId>
	<version>1.1</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-messaging</artifactId>
  <version>4.0.5.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-websocket</artifactId>
  <version>4.0.5.RELEASE</version>
</dependency>

步骤二:websocket相关jar包导入之后,开始创建websocket配置相关的类,如我的WebSocketConfig.java,这一个类似于servlet项目中的@ServerEndpoint注解,它的作用就是在html页面中可以直接访问这个类配置的网址,从而进行相关逻辑的处理,而不是经过controller层来管理,有了这个类,WebSocketConfig就相当于是controller层了。

@Configuration
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer{
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(WebSocketPushHandler(),"/webSocketServer").addInterceptors(new MyWebSocketInterceptor());
        registry.addHandler(WebSocketPushHandler(), "/sockjs/webSocketServer").addInterceptors(new MyWebSocketInterceptor())
                .withSockJS();
    }
    @Bean	
    public WebSocketHandler WebSocketPushHandler(){
        return new WebSocketPushHandler();
    }
}

上面的类创建好之后,需要在springmvc的spring-context.xml配置文件中加入包扫描,如果你的ssm框架中已经有包扫描,就不需要再添加包扫描了,比如WebSocketConfig.java类在项目包com.baidu.webSocketDemo.xxxxx下,你只需要扫描基本包就好了,如下:

<context:component-scan base-package="com.baidu.webSocketDemo"/>

@Configuration注解该类,等价于XML中配置beans标签,@Bean相当于spring xml里面的bean标签,@EnableWebSocket这个注解用于springmvc对websocket的支持。

其中WebSocketPushHandler是websocket消息处理类,包括窗口打开,关闭,信息发送,错误信息监听等功能。MyWebSocketInterceptor是登录信息拦截处理的类,都是自定义的,名字可以自己取,后面会有代码演示。

1:/webSocketServer这个请求网址是普通浏览器访问所用,使用大多数浏览器支持websocket

2:/sockjs/webSocketServer 是适应IE低版本浏览器所用的,因为IE11以下的浏览器都不支持websocket,所以需要前台jsp页面用这个网址访问注册对应的注册器。

步骤三:在web.xml中的servlet和filter中加入支持异步处理的代码,因为websocket页面是异步处理信息的。

<async-supported>true</async-supported>

servlet中加入:

<servlet>
	<servlet-name>oa</servlet-name>
	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:spring/spring-mvc.xml</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
	<async-supported>true</async-supported>
</servlet>

所有的filter中也要加入,如下:

<filter>
	<filter-name>shiroFilter</filter-name>
	<filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
	<async-supported>true</async-supported>
	<init-param>
		<param-name>targetFilterLifecycle</param-name>
		<param-value>true</param-value>
	</init-param>
</filter>

经过上面的步骤,spring websocket的配置整合基本上已经ok,下面就要开始写处理类相关信息。

步骤四:MyWebSocketInterceptor拦截用户登录信息,并将用户登录信息交给websocket的WebSocketSession来管理,因为这样websocket就可以知道用户是否在线,是否不在线了,而且还能给别的用户发送消息,非常的方便。

/**
 * 此类用来获取登录用户信息并交由websocket管理
 * @author ts
 *
 */
public class MyWebSocketInterceptor implements HandshakeInterceptor{
		
	@Override
	public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
			Map<String, Object> attributes) throws Exception {
		//将ServerHttpRequest转换成request请求相关的类,用来获取request域中的用户信息	
		if (request instanceof ServletServerHttpRequest) {
			ServletServerHttpRequest servletRequest  = (ServletServerHttpRequest) request;
			HttpServletRequest httpRequest = servletRequest.getServletRequest();
			//Constants.CURRENT_USER这个是我定义的常量,是request域的key,通过key就可以获取到用户信息了
			TsUser user = (TsUser)httpRequest.getAttribute(Constants.CURRENT_USER);
			//Constants.CURRENT_WEBSOCKET_USER也是常量,用来存储WebsocketSession的key值
			attributes.put(Constants.CURRENT_WEBSOCKET_USER,user.getUserid());
		}
		return true;
	}
	@Override
	public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
			Exception exception) {		
	}
}

步骤五:WebSocketPushHandler消息处理类,这个类主要就是用来做消息的逻辑处理的,代码如下。

/**
 * 消息处理类
 * @author ts
 *
 */
public class WebSocketPushHandler implements WebSocketHandler{
	
	private static final List<WebSocketSession> users = new ArrayList<>();
	
	//用户进入系统监听
	@Override
	public void afterConnectionEstablished(WebSocketSession session) throws Exception {
		System.out.println("成功进入了系统。。。");
		users.add(session);
	}

	//
	@Override
	public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
	    //将消息进行转化,因为是消息是json数据,可能里面包含了发送给某个人的信息,所以需要用json相关的工具类处理之后再封装成TextMessage,
	    我这儿并没有做处理,消息的封装格式一般有{from:xxxx,to:xxxxx,msg:xxxxx},来自哪里,发送给谁,什么消息等等	    
	    //TextMessage msg = (TextMessage)message.getPayload();
	    //给所有用户群发消息
	    sendMessagesToUsers(msg);
	    给指定用户群发消息
	    sendMessageToUser(userId,msg);
		

	}
        
        //后台错误信息处理方法
	@Override
	public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {

	}

	//用户退出后的处理,不如退出之后,要将用户信息从websocket的session中remove掉,这样用户就处于离线状态了,也不会占用系统资源
	@Override
	public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
		if(session.isOpen()){
			session.close();
		}
		users.remove(session);
		System.out.println("安全退出了系统");
		
	}

	@Override
	public boolean supportsPartialMessages() {
		return false;
	}
	
	/**
	 * 给所有的用户发送消息
	 */
	public void sendMessagesToUsers(TextMessage message){
		for(WebSocketSession user : users){
			try {
			    //isOpen()在线就发送
				if(user.isOpen()){
					user.sendMessage(message);
				}
			} catch (IOException e) {
				e.printStackTrace();
			}
		}
	}
	
	/**
	 * 发送消息给指定的用户
	 */
	public void sendMessageToUser(String userId,TextMessage message){
		for(WebSocketSession user : users){
			if(user.getAttributes().get(Constants.CURRENT_WEBSOCKET_USER).equals(userId)){
				try {
				    //isOpen()在线就发送
					if(user.isOpen()){
						user.sendMessage(message);
					}
				} catch (IOException e) {
					e.printStackTrace();
				}
			}
		}
	}
}

步骤六:jsp页面创建websocket对象,实现页面信息的实时接收。

下载sockjs.min.js,点击进去:https://cdn.jsdelivr.net/sockjs/1/sockjs.min.js,然后右键“另存为”就下载下来了。

引入socketjs文件,这个非常重要,不然IE低版本就不支持websocket功能了,提高浏览器的兼容性。

<script type="text/javascript" src="${ctx}/asset/lib/socketjs/sockjs.min.js"></script>
<script type="text/javascript">
	var  ws;
	window.onload=connect;
	function connect(){
		var ws;
		if ('WebSocket' in window) {
			ws = new WebSocket("ws://192.168.1.117:8080/xf_oa_new/webSocketServer");
		} else if ('MozWebSocket' in window) {
			ws = new MozWebSocket("ws://192.168.1.117:8080/xf_oa_new/webSocketServer");
		} else {
			//如果是低版本的浏览器,则用SockJS这个对象,对应了后台“sockjs/webSocketServer”这个注册器,
			//它就是用来兼容低版本浏览器的
			ws = new SockJS("http://192.168.1.117:8080/xf_oa_new/sockjs/webSocketServer");
		}
		ws.onopen = function (evnt) {
			
		};
		ws.onmessage = function (evnt) {
			eval("var dataObj="+event.data);
			if(dataObj != undefined){	
				$(dataObj.data).each(function(i,o){
					$("#msgName").text(o.msgName);
					$("#amount").text(o.amount);
					$("#msg a:first").attr("_href",core.getRootPath()+o.toUrl).text(o.taskName);
					$("#msgId").val(o.id);
					setTimeout("tips_pop()",1000); 
				});
			}
			
		};
		ws.onerror = function (evnt) {
		};
		ws.onclose = function (evnt) {
		}
	}
	
	function  send(){
		var value= $("#msg").val();
		ws.send(value);
	}
</script>

步骤七:我们ssm框架的controller层或者service层该如何用它来发送消息呢?通常我们使用一个方法,都是用@Autowired注解注入service的,而我们这里因为WebSocketPushHandler并不是service层方法,而是一个和controller层一样的控制器,这个时候我们就需要new对象来引用WebSocketPushHandler这个类里面的发送信息的方法了。

首先我在controller层注入对象实例。

/**
 * 注入发送消息类实例
 * @return
 */
@Bean
public WebSocketPushHandler getWebSocketPushHandler() {
	return new WebSocketPushHandler();
}

然后对信息进行封装。

/**
 * 根据用户获取消息内容
 */
public TextMessage getMsgByUserId(String userId){
	Map<String, Object> resultMap = tcService.selectTask(userId);
	ObjectMapper mapper = new ObjectMapper();
	String msg = "";
	try {
		msg = mapper.writeValueAsString(resultMap);
	} catch (JsonProcessingException e) {
		e.printStackTrace();
	}
	return new TextMessage(msg);
}

然后在controller方法中引入发送消息给某个人的方法。

//前台通知处理人处理任务
getWebSocketPushHandler().sendMessageToUser(info.getUserId(), this.getMsgByUserId(info.getUserId()));

特别注意步骤七,其实我们发送消息也不需要再controller层做,因为jsp页面已经将消息交给了WebSocketConfig类,而我们前面已经在WebSocketConfig.java文件中定义了url对应的的WebSocketPushHandler消息处理类,因此我们所有群发消息,对某个用户发送消息,都可以在前面WebSocketPushHandler这个消息处理类中的handleMessage方法中判断是否群发消息,是否对某人发送消息。步骤七可以增加程序的扩展性,它可以在任何类中使用发送消息的方法。

文章评论

看13位CEO、创始人和高管如何提高工作效率
看13位CEO、创始人和高管如何提高工作效率
什么才是优秀的用户界面设计
什么才是优秀的用户界面设计
不懂技术不要对懂技术的人说这很容易实现
不懂技术不要对懂技术的人说这很容易实现
代码女神横空出世
代码女神横空出世
为啥Android手机总会越用越慢?
为啥Android手机总会越用越慢?
我跳槽是因为他们的显示器更大
我跳槽是因为他们的显示器更大
 程序员的样子
程序员的样子
老美怎么看待阿里赴美上市
老美怎么看待阿里赴美上市
Java 与 .NET 的平台发展之争
Java 与 .NET 的平台发展之争
2013年美国开发者薪资调查报告
2013年美国开发者薪资调查报告
Web开发者需具备的8个好习惯
Web开发者需具备的8个好习惯
“肮脏的”IT工作排行榜
“肮脏的”IT工作排行榜
我的丈夫是个程序员
我的丈夫是个程序员
亲爱的项目经理,我恨你
亲爱的项目经理,我恨你
10个调试和排错的小建议
10个调试和排错的小建议
老程序员的下场
老程序员的下场
我是如何打败拖延症的
我是如何打败拖延症的
编程语言是女人
编程语言是女人
程序员都该阅读的书
程序员都该阅读的书
程序员的鄙视链
程序员的鄙视链
写给自己也写给你 自己到底该何去何从
写给自己也写给你 自己到底该何去何从
漫画:程序员的工作
漫画:程序员的工作
当下全球最炙手可热的八位少年创业者
当下全球最炙手可热的八位少年创业者
十大编程算法助程序员走上高手之路
十大编程算法助程序员走上高手之路
那些争议最大的编程观点
那些争议最大的编程观点
鲜为人知的编程真相
鲜为人知的编程真相
要嫁就嫁程序猿—钱多话少死的早
要嫁就嫁程序猿—钱多话少死的早
Web开发人员为什么越来越懒了?
Web开发人员为什么越来越懒了?
初级 vs 高级开发者 哪个性价比更高?
初级 vs 高级开发者 哪个性价比更高?
做程序猿的老婆应该注意的一些事情
做程序猿的老婆应该注意的一些事情
60个开发者不容错过的免费资源库
60个开发者不容错过的免费资源库
如何区分一个程序员是“老手“还是“新手“?
如何区分一个程序员是“老手“还是“新手“?
每天工作4小时的程序员
每天工作4小时的程序员
为什么程序员都是夜猫子
为什么程序员都是夜猫子
如何成为一名黑客
如何成为一名黑客
科技史上最臭名昭著的13大罪犯
科技史上最臭名昭著的13大罪犯
5款最佳正则表达式编辑调试器
5款最佳正则表达式编辑调试器
“懒”出效率是程序员的美德
“懒”出效率是程序员的美德
旅行,写作,编程
旅行,写作,编程
程序员眼里IE浏览器是什么样的
程序员眼里IE浏览器是什么样的
程序员应该关注的一些事儿
程序员应该关注的一些事儿
程序员最害怕的5件事 你中招了吗?
程序员最害怕的5件事 你中招了吗?
聊聊HTTPS和SSL/TLS协议
聊聊HTTPS和SSL/TLS协议
程序员和编码员之间的区别
程序员和编码员之间的区别
10个帮程序员减压放松的网站
10个帮程序员减压放松的网站
程序员周末都喜欢做什么?
程序员周末都喜欢做什么?
总结2014中国互联网十大段子
总结2014中国互联网十大段子
程序员的一天:一寸光阴一寸金
程序员的一天:一寸光阴一寸金
程序猿的崛起——Growth Hacker
程序猿的崛起——Growth Hacker
软件开发程序错误异常ExceptionCopyright © 2009-2015 MyException 版权所有