前段时间在什么地方无意间见到过websocket的身影,当时专注于其他方面的学习,也没去了解这是个什么东东。最近项目需要服务端和浏览器建立长连接,服务端向浏览器推送消息,这时突然就想起了websocket,猜测这个词的字面意思,觉得很有可能可以用来处理长连接的问题。于是上网查找相关资料,果然印证了我的猜测。
websocket的定义已经写在了javaee7的标准里面,具体可见oracle官方协议文档:
http://www.oracle.com/technetwork/articles/java/jsr356-1937161.html
这里不再啰嗦协议,这里将tomcat7里面的一个例子给大家演示一下(我自己本机工程跑成功了),方便不习惯看官方文档或不方便看英文的朋友。
websocket的开发,当然分服务端和客户端,这里服务端是java,客户端是javascript。
准备工作:
开发工具,我用的是 idea13.1,用eclipse,myeclipse也都一样;应用服务器:tomcat7.0.52,老版的tomcat可能不支持websocket,所以尽量用最新的,具体可以去看tomcat文档。
好,下面正式开始了
一,建立web工程
下面是我在idea13.1上建立的web工程的结构图:
test包里面的java类都是服务端的代码,其实这里有重复的,EchoAnnotation和Test,TestWeb都是一样的,这里就以Test为例来讲。
web目录下的echo.xhtml和index.jsp, 都是websocket客户端的实现,这里以index.jsp为例,好,下面详细讲解。
二,Websocket服务端
服务端有两种实现方式,注解方式和接口实现方式:
注解方式
服务端写一个java类,比如叫Test,Test类加上@ServerEndpoint注解,先看代码,再解释:
package test;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
/**
* Created by valenon on 2014/6/17.
*/
@ServerEndpoint("/test")
public class Test {
@OnOpen
public void onOpen(Session session,EndpointConfig config){
System.out.println("websocket session opened");
}
@OnMessage
public void onMessage(String message, Session session){
System.out.println("websocket message:" + message);
try {
session.getBasicRemote().sendText("i have received your message");
} catch (IOException e) {
e.printStackTrace();
}
}
@OnClose
public void onClose(Session session,CloseReason reason){
System.out.println("websocket session closed");
}
}
@ServerEndpoint("/test")
表示Test类型被当做websocket的服务端处理类,后面圆括号中的参数“/test”, 用来组成服务端的url,客户端将根据url连接到服务端。url具体会在后面说。
@OnOpen
public void onOpen(Session session,EndpointConfig config)这个方法上面加了@OnOpen这个标注,表示当websocket链接一建立,就会调用这个方法
@OnMessage
被@OnMessage标注的方法,会在收到客户端的消息的时候,被调用,这里就是public void onMessage(String message, Session session)这个方法
还有@OnClose,@OnError,他们的意思也很好理解,就不多说了
好了,服务端的代码就这一个类,说到这里,大家可能需要jar包了,需要依赖,websocket的api在javaee的javax.websocket中,jar包叫做javax.websocket-api-1.0.jar,可以到oracle官网下载javaee7然后找到这个jar包,或者点本人的资源链接:
http://download.csdn.net/detail/valenon/7517243
下面给出maven依赖:
<dependency>
<groupId>javax.websocket</groupId>
<artifactId>javax.websocket-api</artifactId>
<version>1.0</version>
</dependency>
部署到tomcat里面,服务端就可以用了。前面说过服务端还有一种实现方式,这种方式先不说,我们先用一种方式,把websocket的整个流程跑下来,那么接下来该是客户端了
三,Websocket客户端
在web根目录下,建立文件index.jsp,内容如下:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title></title>
</head>
<body οnlοad="startWebSocket();">
<script type="text/javascript">
var ws
function startWebSocket() {
if ('WebSocket' in window)
ws = new WebSocket("ws://localhost:8080/webserver/test");
else if ('MozWebSocket' in window)
ws = new MozWebSocket("ws://localhost:8080/webserver/test");
else
alert("not support");
ws.onmessage = function(evt) {
alert('Server:' + evt.data);
};
ws.onclose = function(evt) {
alert("close");
};
ws.onopen = function(evt) {
alert("open");
};
}
function sendMsg(){
// alert(window.location.host)
ws.send('hi,this is the client')
}
</script>
<input type="button" value="点击发送" οnclick="sendMsg();"/>
</body>
</html>
页面加载时,调用startWebSocket()方法,该方法建立websocket客户端对象:
ws = new WebSocket("ws://localhost:8080/webserver/test"); 参数 ws://localhost:8080/webserver/test 便是websocket服务的url,ws是该协议的特定符号,然后是主机号,端口号,端口号就是tomcat的端口号,webserver是我的应用的部署名称,后面的/test, 就是服务端@ServerEndpoint的参数值
onmessage,onclose,onopen分别表示websocket客户端的收到消息,链接关闭,链接打开事件。页面还有一个按钮,当点击按钮时,会调用websocket的send方法,向服务端发送消息,通过这个可以调试该程序。
将项目部署到tomcat中,启动tomcat,浏览器中输入地址http://localhost:8080/webserver/index.jsp就可以看效果了。
完了,就这么点东西,代码直接贴过去就可以用。
到此,一个完整的websocket应用例子就完了,下面我们回过头来说一下另外一种服务端的实现方式--接口实现。
这种方式需要一个类去实现EndPoint抽象类,并且注册为websocket服务。在本人的工程里,有EchoEndpoint和ExamplesConfig两个类,先看EchoEndpoint:
package test;
import java.io.IOException;
import javax.websocket.Endpoint;
import javax.websocket.EndpointConfig;
import javax.websocket.MessageHandler;
import javax.websocket.RemoteEndpoint;
import javax.websocket.Session;
public class EchoEndpoint extends Endpoint {
@Override
public void onOpen(Session session, EndpointConfig endpointConfig) {
RemoteEndpoint.Basic remoteEndpointBasic = session.getBasicRemote();
session.addMessageHandler(new EchoMessageHandler(remoteEndpointBasic));
}
private static class EchoMessageHandler
implements MessageHandler.Whole<String> {
private final RemoteEndpoint.Basic remoteEndpointBasic;
private EchoMessageHandler(RemoteEndpoint.Basic remoteEndpointBasic) {
this.remoteEndpointBasic = remoteEndpointBasic;
}
@Override
public void onMessage(String message) {
try {
if (remoteEndpointBasic != null) {
remoteEndpointBasic.sendText("This is interface implementation");
}
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
}
EchoEndpoint 实现Endpoint的onOpen方法,并且注册一个消息处理类EchoMessageHandler,当收到消息时调用onMessage方法处理。
接下来还有个问题,如何注册这个websocket服务,以便客户端可以找到它(想想注解方式给出了一个参数"/test" 用来生成url,这里当然也需要),那么看ExamplesConfig:
package test;
import java.util.HashSet;
import java.util.Set;
import javax.websocket.Endpoint;
import javax.websocket.server.ServerApplicationConfig;
import javax.websocket.server.ServerEndpointConfig;
import test.EchoEndpoint;
public class ExamplesConfig implements ServerApplicationConfig {
@Override
public Set<ServerEndpointConfig> getEndpointConfigs(
Set<Class<? extends Endpoint>> scanned) {
Set<ServerEndpointConfig> result = new HashSet<ServerEndpointConfig>();
if (scanned.contains(EchoEndpoint.class)) {
result.add(ServerEndpointConfig.Builder.create(
EchoEndpoint.class,
"/test").build());
}
return result;
}
@Override
public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) {
// Deploy all WebSocket endpoints defined by annotations in the examples
// web application. Filter out all others to avoid issues when running
// tests on Gump
Set<Class<?>> results = new HashSet<Class<?>>();
for (Class<?> clazz : scanned) {
if (clazz.getPackage().getName().startsWith("websocket.")) {
results.add(clazz);
}
}
return results;
}
}
看到了吧,
if (scanned.contains(EchoEndpoint.class)) {
result.add(ServerEndpointConfig.Builder.create(
EchoEndpoint.class,
"/test").build());
}
这句就是把EchoEndpoint注册为websocket服务的,getEndpointConfigs方法会在程序启动时,由api自动调用,我们就不用操心了。
好了,不知道说的清楚不,如果有问题,欢迎留言。