websocket 消息推送

实现web端的推送目前有几种方式:

* 轮询

客户端定时向服务器发送ajax请求,服务器接到请求后马上返回响应信息并关闭连接。

优点:后端程序编写简单

缺点:请求中有大多是无用的,浪费带宽和服务器资源。

示例:适用于小型应用

* websocket

WebSocket是HTML5开始提供的一种浏览器与服务器间进行全双工通讯的网络技术。依靠这种技术可以实现客户端和服务器端的长连接,双向实时通信。在 WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。

优点:节省服务器资源和带宽,实时进行通信

缺点:少部分浏览器不支持,且不同浏览器支持的程度和方式有区别

image.png

那么接下来说明一下自己写的一个超简单的demo,关于接收消息的一些逻辑控制未写入代码,此处只做简单的推送功能展示。

1、服务端

* 引入jar包:

敲重点:注意scope作用域, provided--在编译和测试的过程有效,最后生成war包时不会加入

<!-- 引入websocket -->

<dependency>

    <groupId>javax.websocket</groupId>

    <artifactId>javax.websocket-api</artifactId>

    <version>1.1</version>

    <scope>provided</scope>

</dependency>

<dependency>

    <groupId>javax</groupId>

    <artifactId>javaee-api</artifactId>

    <version>7.0</version>

    <scope>provided</scope>

</dependency>

* 消息处理类(注意前后端websocket对象是同一个)


import javax.websocket.*;

import javax.websocket.server.ServerEndpoint;

import java.io.IOException;

@ServerEndpoint("/websocket/endpoint")

public class WebsocketHandler {

    private static Map<String, WebsocketHandler> clients = new ConcurrentHashMap<String, WebsocketHandler>();

    @OnOpen

    public void onOpen(Session session) throws IOException {

        //如果有用户信息,可以将用户编码之类的唯一标识作为clients的key,这样可以保证一个用户只有一个websocket client有效(此处的“1”仅仅作为demo的测试例子)

        //如果同一个用户可以拥有多个websocket client,可以将session.getId()作为key,根据实际业务需求来设置即可

        clients.put("1", this);

        System.out.println("已连接");

    }

    @OnMessage

    public void onMessage(String message) {

        //以下代码省略...

        System.out.println(message);

        for (WebsocketHandler client : clients.values()) {

            client.session.getBasicRemote().sendText(message);

        }

    }

    @OnError

    public void onError(Throwable t) {

        //以下代码省略...

        t.printStackTrace();

    }

    @OnClose

    public void onClose(Session session, CloseReason reason) {

        //以下代码省略...

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

        System.out.println("已关闭连接");

    }

    public static void pushMsg(String message){

        // “1”只是测试用的key

        WebsocketHandler client = clients.get("1");

        try {

            if(client != null){

                client.session.getBasicRemote().sendText(message);

            }

        }catch (IOException e){

            e.printStackTrace();

        }

    }

}

* 后端对外消息推送接口


@ResponseBody

@RequestMapping(value="/sendMessage", method = RequestMethod.GET)

public void sendMessage() throws IOException {

    WebsocketHandler.pushMsg("这是我需要发送的消息,记得给我传达,后面可以做成通用的接口");

}

2、客户端


<!-- html -->

<button onclick="sendMessage()">发送消息</button>

<button onclick="closeWebSocket()">关闭</button>

<div>这是显示结果的地方:

    <p id="message" style="color:red;"></p>

</div>

<!-- javascript -->

<script type="text/javascript" src="../js/jquery-1.9.1.min.js"></script>

<script type="text/javascript">

    var websocket = null;

    var url = "ws://localhost:8081/websocket-demo/websocket/endpoint";

    $(document).ready(function(){

        //判断当前浏览器是否支持WebSocket

        if ('WebSocket' in window) {

            alert("浏览器支持Websocket")

            websocket = new WebSocket(url);

        } else {

            alert('当前浏览器 Not support websocket');

        }

        if(websocket != null){

            //连接发生错误的回调方法

            websocket.onerror = function() {

                alert("WebSocket连接发生错误")

                setMessageInnerHTML("WebSocket连接发生错误");

            };

            //连接成功建立的回调方法

            websocket.onopen = function() {

                alert("WebSocket连接成功")

                setMessageInnerHTML("WebSocket连接成功");

            }

            //接收到消息的回调方法

            websocket.onmessage = function(event) {

                alert("接收到消息的回调方法")

                alert("这是后台推送的消息:"+event.data);

                // websocket.close();

                // alert("webSocket已关闭!")

            }

            //连接关闭的回调方法

            websocket.onclose = function() {

                setMessageInnerHTML("WebSocket连接关闭");

            }

        }

    });

    //监听窗口关闭事件,当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。

    window.onbeforeunload = function() {

        closeWebSocket();

    }

    //关闭WebSocket连接

    function closeWebSocket() {

        websocket.close();

    }

    //将消息显示在网页上

    function setMessageInnerHTML(innerHTML) {

        $("#message").text(innerHTML);

    }

</script>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343