一、WebSocket客户端

websocket允许通过JavaScript建立与远程服务器的连接，从而实现客户端与服务器间双向的通信。在websocket中有两个方法：　　
　　　　1、send() 向远程服务器发送数据
　　　　2、close() 关闭该websocket链接
　　websocket同时还定义了几个监听函数　　　　
　　　　1、onopen 当网络连接建立时触发该事件
　　　　2、onerror 当网络发生错误时触发该事件
　　　　3、onclose 当websocket被关闭时触发该事件
　　　　4、onmessage 当websocket接收到服务器发来的消息的时触发的事件，也是通信中最重要的一个监听事件。msg.data
　　websocket还定义了一个readyState属性，这个属性可以返回websocket所处的状态：
　　　　1、CONNECTING(0) websocket正尝试与服务器建立连接
　　　　2、OPEN(1) websocket与服务器已经建立连接
　　　　3、CLOSING(2) websocket正在关闭与服务器的连接
　　　　4、CLOSED(3) websocket已经关闭了与服务器的连接

　　websocket的url开头是ws，如果需要ssl加密可以使用wss，当我们调用websocket的构造方法构建一个websocket对象（new WebSocket(url)）的之后，就可以进行即时通信了。

<!DOCTYPE html>

<html>

    <head>

        <meta name="viewport" content="width=device-width" />

        <title>WebSocket 客户端</title>

    </head>

    <body>

        <div>

            <input type="button" id="btnConnection" value="连接" />

            <input type="button" id="btnClose" value="关闭" />

            <input type="button" id="btnSend" value="发送" />

        </div>

        <script src="js/jquery-1.11.1.min.js" type="text/javascript" charset="utf-8"></script>

        <script type="text/javascript">

            var socket;

            if(typeof(WebSocket) == "undefined") {

                alert("您的浏览器不支持WebSocket");

                //return;

            }

            $("#btnConnection").click(function() {

                //实现化WebSocket对象，指定要连接的服务器地址与端口

                socket = new WebSocket("ws://127.0.0.1:8080/spring-websocket-test/demo2/duanxz");

                //打开事件

                socket.onopen = function() {

                    alert("Socket 已打开");

                    //socket.send("这是来自客户端的消息" + location.href + new Date());

                };

                //获得消息事件

                socket.onmessage = function(msg) {

                    alert(msg.data);

                };

                //关闭事件

                socket.onclose = function() {

                    alert("Socket已关闭");

                };

                //发生了错误事件

                socket.onerror = function() {

                    alert("发生了错误");

                }

            });

            //发送消息

            $("#btnSend").click(function() {

                socket.send("这是来自客户端的消息" + location.href + new Date());

            });

            //关闭

            $("#btnClose").click(function() {

                socket.close();

            });

        </script>

    </body>

</html>

二、WebSocket服务器端

JSR356定义了WebSocket的规范，Tomcat7中实现了该标准。JSR356 的 WebSocket 规范使用 javax.websocket.*的 API，可以将一个普通 Java 对象（POJO）使用 @ServerEndpoint 注释作为 WebSocket 服务器的端点。

package org.springframework.samples.websocket.echo2;

import java.io.IOException;

import javax.websocket.CloseReason;

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("/push")

public class EchoEndpoint {

    @OnOpen

    public void onOpen(Session session) throws IOException {

        // 以下代码省略...

    }

    @OnMessage

    public String onMessage(String message) {

        // 以下代码省略...

        return null;

    }

    @Message(maxMessageSize = 6)

    public void receiveMessage(String s) {

        // 以下代码省略...

    }

    @OnError

    public void onError(Throwable t) {

        // 以下代码省略...

    }

    @OnClose

    public void onClose(Session session, CloseReason reason) {

        // 以下代码省略...

    }

}

上面简洁代码即建立了一个WebSocket的服务端，@ServerEndpoint("/push")的annotation注释端点表示将WebSocket服务端运行在ws://[Server端IP或域名]:[Server端口]/项目/push的访问端点，客户端浏览器已经可以对WebSocket客户端API发起HTTP长连接了。
使用ServerEndpoint注释的类必须有一个公共的无参数构造函数，

@OnMessage注解的Java方法用于接收传入的WebSocket信息，这个信息可以是文本格式，也可以是二进制格式。
@OnOpen注解的java方法用于在这个端点一个新的连接建立时被调用。参数提供了连接的另一端的更多细节。Session表明两个WebSocket端点对话连接的另一端，可以理解为类似HTTPSession的概念。
@OnClose注解的java方法用于在连接被终止时调用。参数closeReason可封装更多细节，如为什么一个WebSocket连接关闭。
更高级的定制如@Message注释，MaxMessageSize属性可以被用来定义消息字节最大限制，在示例程序中，如果超过6个字节的信息被接收，就报告错误和连接关闭。

三、常见状态码

任何一端发送关闭帧给对方，即可关闭连接。关闭连接时通常都带有关闭连接的状态码(status code)。常见状态码的含义如下：

  • 1000 连接正常关闭
  • 1001 端点离线，例如服务器down，或者浏览器已经离开此页面
  • 1002 端点因为协议错误而中断连接
  • 1003 端点因为受到不能接受的数据类型而中断连接
  • 1004 保留
  • 1005 保留, 用于提示应用未收到连接关闭的状态码
  • 1006 端点异常关闭
  • 1007 端点收到的数据帧类型不一致而导致连接关闭
  • 1008 数据违例而关闭连接
  • 1009 收到的消息数据太大而关闭连接
  • 1010 客户端因为服务器未协商扩展而关闭
  • 1011 服务器因为遭遇异常而关闭连接
  • 1015 TLS握手失败关闭连接

四、部署

如果在与Web服务器集成的情况下使用使用WebSocket，通常需要Web服务器进行额外配置，具体可以参见各种Web服务器的配置方案，此处不再赘述：

Apache：http://httpd.apache.org/docs/2.4/mod/mod_proxy_wstunnel.html。 
Nginx：https://www.nginx.com/blog/websocket-nginx/。

既然WebSocket是HTML5新增的特性，那么在使用时我们就要考虑浏览器旧版本兼容的问题，这也是Comet方案尽管存在各种问题，但仍旧被采用的原因。

五、示例

package org.springframework.samples.websocket.echo2;

import javax.websocket.CloseReason;

import javax.websocket.OnClose;

import javax.websocket.OnError;

import javax.websocket.OnMessage;

import javax.websocket.OnOpen;

import javax.websocket.Session;

import javax.websocket.server.PathParam;

import javax.websocket.server.ServerEndpoint;

import org.springframework.web.socket.server.standard.SpringConfigurator;

//ws://127.0.0.1:8080/project/ws/张三

@ServerEndpoint(value = "/demo2/{user}", configurator = SpringConfigurator.class)

public class WSServer {

    private String currentUser;

    // 连接打开时执行

    @OnOpen

    public void onOpen(@PathParam("user") String user, Session session) {

        currentUser = user;

        System.out.println("Connected ... " + session.getId());

    }

    // 收到消息时执行

    @OnMessage

    public String onMessage(String message, Session session) {

        System.out.println(currentUser + "：" + message);

        return currentUser + "：" + message;

    }

    // 连接关闭时执行

    @OnClose

    public void onClose(Session session, CloseReason closeReason) {

        System.out.println(String.format("Session %s closed because of %s", session.getId(), closeReason));

    }

    // 连接错误时执行

    @OnError

    public void onError(Throwable t) {

        t.printStackTrace();

    }

}

url中的字符张三是的路径参数，响应请求的方法将自动映射。

六、测试运行

websocket之二：WebSocket编程入门的更多相关文章

  1. WebSocket 介绍(二)-WebSocket API

    这一章介绍如何用WebSocket API来控制协议和创建应用,运用http://websocket.org 提供的现有WebSocket服务器,我们可以收发消息.创建一些简单的WebSocket应用 ...

  2. 通讯编程入门--WEBSOCKET

    C#通讯编程入门--WEBSOCKET WebSocket服务端 C#示例代码 using System; using System.Collections.Generic; using System ...

  3. VS2010/MFC编程入门之二（利用MFC向导生成单文档应用程序框架）

    VS2010/MFC编程入门之二(利用MFC向导生成单文档应用程序框架)-软件开发-鸡啄米 http://www.jizhuomi.com/software/141.html   上一讲中讲了VS20 ...

  4. Websocket和PHP Socket编程

    本来是搜一些html5 websocket资料看的,结果被引去看了php的socket编程.下面是一些简单的例子,在命令行运行php脚本就行 [命令行运行PHP]PHP中有一个php.exe文件,可以 ...

  5. 脑残式网络编程入门(二)：我们在读写Socket时，究竟在读写什么？

    1.引言 本文接上篇<脑残式网络编程入门(一):跟着动画来学TCP三次握手和四次挥手>,继续脑残式的网络编程知识学习 ^_^. 套接字socket是大多数程序员都非常熟悉的概念,它是计算机 ...

  6. WebSocket原理与实践(二)---WebSocket协议

    WebSocket原理与实践(二)---WebSocket协议 WebSocket协议是为了解决web即时应用中服务器与客户端浏览器全双工通信问题而设计的.协议定义ws和wss协议,分别为普通请求和基 ...

  7. VS2010/MFC编程入门之五十二（Ribbon界面开发：创建Ribbon样式的应用程序框架）

    上一节中鸡啄米讲了GDI对象之画刷CBrush,至此图形图像的入门知识就讲完了.从本节开始鸡啄米将为大家带来Ribbon界面开发的有关内容.本文先来说说如何创建Ribbon样式的应用程序框架. Rib ...

  8. [转帖]脑残式网络编程入门(二)：我们在读写Socket时，究竟在读写什么？

    脑残式网络编程入门(二):我们在读写Socket时,究竟在读写什么?     http://www.52im.net/thread-1732-1-1.html   1.引言 本文接上篇<脑残式网 ...

  9. WebSocket刨根问底(二)

    上篇文章[WebSocket刨根问底(一)]中我们对WebSocket的一些基本理论进行了介绍,但是并没有过多的涉及到一些实战的内容,今天我希望能够用几个简单的案例来向小伙伴们展示下WebSocket ...

  10. WebSocket（二）-WebSocket、Socket、TCP、HTTP区别

    原文地址:Socket 与 WebSocket 1. 概述 WebSocket 是为了满足基于 Web 的日益增长的实时通信需求而产生的.在传统的 Web 中,要实现实时通信,通用的方式是采用 HTT ...

随机推荐

  1. 【Android】百度地图自定义弹出窗口

    我们使用百度地图的时候,点击地图上的Marker,会弹出一个该地点详细信息的窗口,如下左图所示,有时候,我们希望自己定义这个弹出窗口的内容,或者,干脆用自己的数据来构造这样的弹出窗口,但是,在百度地图 ...

  2. TP框架---thinkphp修改删除数据

    1.在控制器MainController里面写一个方法,调用Nation表中的数据. public function zhuyemian() { $n = D("Nation"); ...

  3. Python 深入剖析SocketServer模块（一）（V2.7.11）

    一.简介(翻译)  通用socket server 类  该模块尽力从各种不同的方面定义server:  对于socket-based servers:  -- address family:     ...

  4. 之前博客中的代码都放到github上

    之前一直把代码托管在taocode上,现在已经不能用了,所以把代码整理了一下,统一都放在gibhub上了. LALR(1)语法分析生成器:https://github.com/kiven-li/xby ...

  5. Spring Boot启动原理解析

    Spring Boot启动原理解析http://www.cnblogs.com/moonandstar08/p/6550758.html 前言 前面几章我们见识了SpringBoot为我们做的自动配置 ...

  6. sed命令使用举例

    选择操作的行范围 sed -n '1,2p' testsed2.txt  匹配第1到2行 sed -n '/a/,/b/p' testsed2.txt  匹配从包含a的行到包含b的行 sed -n ' ...

  7. 早一天把生意做到de

    const isMobilePhoneNum = (params) => { const areaCode = params.areaCode || 'cn' const str = param ...

  8. Python爬虫--Urllib库

    Urllib库 Urllib是python内置的HTTP请求库,包括以下模块:urllib.request (请求模块).urllib.error( 异常处理模块).urllib.parse (url ...

  9. json字符串转集合或者数组

    import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; import java.util. ...

  10. Linux就该这么学--命令集合10（vim编辑器）

    1.vim编辑器的命令模式中常用的快捷键: dd 删除(剪切)光标所在整行 5dd 删除(剪切)从光标处开始的5行 yy 复制光标所在整行 5yy 复制从光标处开始的5行 p 将之前删除(dd)或复制 ...