WebSocket就是這麼簡單

時間  2019-12-07
標籤 websocket 就是 簡單 简体版
原文   原文鏈接

前言

今天在慕課網上看到了Java的新教程（Netty入門之WebSocket初體驗）：www.imooc.com/learn/941javascript

WebSocket我是聽得不少，沒有真正使用過的技術。我以前也去了解過了WebSocket到底是什麼東西，不過一直沒有去實踐過。html

我在寫監聽器博文的時候，在線人數功能用監聽器的是來作，在評論有說使用WebSocket的方式會更加好。java

那麼，咱們就來探究一下WebSocket到底是什麼東西，順便了解一下Netty！web

WebSocket介紹

什麼是WebSocket

WebSocket是一個協議，歸屬於IETF。bootstrap

  • HTTP是運行在TCP協議傳輸層上的應用協議，而WebSocket是經過HTTP協議協商如何鏈接，而後獨立運行在TCP協議傳輸層上的應用協議。
  • Websocket是一個持久化的協議，相對於HTTP這種非持久的協議來講。
  • websocket約定了一個通訊的規範，經過一個握手的機制，客戶端和服務器之間能創建一個相似tcp的鏈接，從而方便它們之間的通訊

爲何須要WebSocket

添加WebSocket特性，是爲了更好、更靈活，輕量的與服務器通信。由於WebSocket提供了簡單的消息規範，能夠更快的適應長鏈接的環境，其實如今HTTP協議自身就能夠作，可是不過輕便。瀏覽器

WebSocket最大的特色就是實現全雙工通訊：客戶端可以實時推送消息給服務端，服務端也可以實時推送消息給客戶端。緩存

WebSocket能夠作聊天室，股票實時價格顯示等應用tomcat

糾正WebSocket誤區

WebSocket是一種應用協議，而咱們經常看到了HTML5 WebSocket是API,不要將其進行混淆。服務器

廣義上的 HTML5 裏面包含的是 WebSocket API，並非 WebSocket。簡單的說，能夠把 WebSocket 當成 HTTP，WebSocket API 當成 Ajax。微信

Netty介紹

什麼是Netty

知乎的@郭無意總結得很好，我下面就摘抄一下了(連接在下方)：

Netty是什麼？

  • 1）本質：JBoss作的一個Jar包
  • 2）目的：快速開發高性能、高可靠性的網絡服務器和客戶端程序
  • 3）優勢：提供異步的、事件驅動的網絡應用程序框架和工具

通俗的說：一個好使的處理Socket的東東

若是沒有Netty？

遠古：java.net + java.io

近代：java.nio

其餘：Mina，Grizzly

簡單來講：

  • 你想寫個tomcat同樣的Server，能夠用netty。
  • 你想寫一個即時通信的應用，能夠用netty。
  • 你想實現一個高性能Rpc框架，能夠用netty。

Netty優點

Netty優點：API簡單，性能高，入門門檻低，成熟穩健，修復了不少原生NIO的bug

回到課程中來

課程是以Netty實現WebSocket來進行講解的，也就上邊所說的：用Netty來實現即時通訊的應用

源碼下載地址：img.mukewang.com/down/5a6e80…

首先建立了一個全局配置類，WebSocket是全雙工通訊的，它是經過通道來進行通訊，所以配置了系統通道組，管理全部的通道

/**
 * 存儲整個工程的全局配置
 * @author liuyazhuang
 *
 */
public class NettyConfig {
	
	/**
	 * 存儲每個客戶端接入進來時的channel對象
	 */
	public static ChannelGroup group = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);
}

配置一些通道的信息(能夠理解成Servlet時配置request對象的charset、response對象的緩存)

/**
 * 初始化鏈接時候的各個組件
 * @author liuyazhuang
 *
 */
public class MyWebSocketChannelHandler extends ChannelInitializer<SocketChannel> {



	//配置通道的一些編碼格式、數據大小、處理器(交由誰處理)
	@Override
	protected void initChannel(SocketChannel e) throws Exception {
		e.pipeline().addLast("http-codec", new HttpServerCodec());
		e.pipeline().addLast("aggregator", new HttpObjectAggregator(65536));
		e.pipeline().addLast("http-chunked", new ChunkedWriteHandler());
		e.pipeline().addLast("handler", new MyWebSocketHandler());
	}
}

Netty接收請求，分別處理HTTP請求和WebSocket請求，此部分在視頻中單單只是代碼編寫，並無作過多的介紹。下面我就整理一下：

  • 該類是用於處理請求的核心業務類
  • 最重要的方法是：messageReceived()方法，主要判斷是HTTP請求仍是WebSocket請求
    • 是HTTP請求時，就handHttpRequest()來進行處理，該方法判斷是否有握手的傾向，
      • 若是不是WebSocket握手請求消息,那麼直接返回HTTP 400 BAD REQUEST 響應給客戶端，應答消息，並關閉連接。
      • 若是是握手請求，那麼就進行握手,將WebSocket相關的編碼和解碼類動態添加到ChannelPipeline中
    • 是websocket則羣發，服務端向每一個鏈接上來的客戶端羣發消息
package com.imooc.netty;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.DefaultFullHttpResponse;
import io.netty.handler.codec.http.FullHttpRequest;
import io.netty.handler.codec.http.HttpResponseStatus;
import io.netty.handler.codec.http.HttpVersion;
import io.netty.handler.codec.http.websocketx.*;
import io.netty.util.CharsetUtil;

import java.util.Date;

/**
 * 接收/處理/響應客戶端websocket請求的核心業務處理類
 *
 * @author liuyazhuang
 */
public class MyWebSocketHandler extends SimpleChannelInboundHandler<Object> {

    private WebSocketServerHandshaker handshaker;
    private static final String WEB_SOCKET_URL = "ws://localhost:8888/websocket";


    //客戶端與服務端建立鏈接的時候調用
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        NettyConfig.group.add(ctx.channel());
        System.out.println("客戶端與服務端鏈接開啓...");
    }

    //客戶端與服務端斷開鏈接的時候調用
    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        NettyConfig.group.remove(ctx.channel());
        System.out.println("客戶端與服務端鏈接關閉...");
    }

    //服務端接收客戶端發送過來的數據結束以後調用
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        ctx.flush();
    }

    //工程出現異常的時候調用
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }

    //服務端處理客戶端websocket請求的核心方法
    @Override
    protected void messageReceived(ChannelHandlerContext context, Object msg) throws Exception {

        // 傳統的HTTP接入
        //第一次握手請求消息由HTTP協議承載，因此它是一個HTTP消息，執行handleHttpRequest方法來處理WebSocket握手請求。
        if (msg instanceof FullHttpRequest) {
            handHttpRequest(context, (FullHttpRequest) msg);
        }

        // WebSocket接入
        // 客戶端經過文本框提交請求消息給服務端，WebSocketServerHandler接收到的是已經解碼後的WebSocketFrame消息。
        else if (msg instanceof WebSocketFrame) {

            handWebsocketFrame(context, (WebSocketFrame) msg);
        }
    }


    /**
     * 處理客戶端向服務端發起http握手請求的業務
     *
     * @param ctx
     * @param req
     */
    private void handHttpRequest(ChannelHandlerContext ctx, FullHttpRequest req) {

        //若是不是WebSocket握手請求消息，那麼就返回 HTTP 400 BAD REQUEST 響應給客戶端。
        if (!req.getDecoderResult().isSuccess()
                || !("websocket".equals(req.headers().get("Upgrade")))) {
            sendHttpResponse(ctx, req,
                    new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.BAD_REQUEST));
            return;
        }

        //若是是握手請求，那麼就進行握手
        WebSocketServerHandshakerFactory wsFactory = new WebSocketServerHandshakerFactory(
                WEB_SOCKET_URL, null, false);
        handshaker = wsFactory.newHandshaker(req);
        if (handshaker == null) {
            WebSocketServerHandshakerFactory.sendUnsupportedWebSocketVersionResponse(ctx.channel());
        } else {

            // 經過它構造握手響應消息返回給客戶端，
            // 同時將WebSocket相關的編碼和解碼類動態添加到ChannelPipeline中，用於WebSocket消息的編解碼，
            // 添加WebSocketEncoder和WebSocketDecoder以後，服務端就能夠自動對WebSocket消息進行編解碼了
            handshaker.handshake(ctx.channel(), req);
        }
    }

    /**
     * 處理客戶端與服務端以前的websocket業務
     *
     * @param ctx
     * @param frame
     */
    private void handWebsocketFrame(ChannelHandlerContext ctx, WebSocketFrame frame) {
        //判斷是不是關閉websocket的指令
        if (frame instanceof CloseWebSocketFrame) {
            handshaker.close(ctx.channel(), (CloseWebSocketFrame) frame.retain());
        }
        //判斷是不是ping消息
        if (frame instanceof PingWebSocketFrame) {
            ctx.channel().write(new PongWebSocketFrame(frame.content().retain()));
            return;
        }

        //判斷是不是二進制消息，若是是二進制消息，拋出異常
        if (!(frame instanceof TextWebSocketFrame)) {
            System.out.println("目前咱們不支持二進制消息");
            throw new RuntimeException("【" + this.getClass().getName() + "】不支持消息");
        }


        //返回應答消息
        //獲取客戶端向服務端發送的消息
        String request = ((TextWebSocketFrame) frame).text();
        System.out.println("服務端收到客戶端的消息====>>>" + request);
        TextWebSocketFrame tws = new TextWebSocketFrame(new Date().toString()
                + ctx.channel().id()
                + " ===>>> "
                + request);
        //羣發，服務端向每一個鏈接上來的客戶端羣發消息
        NettyConfig.group.writeAndFlush(tws);
    }



    /**
     * 服務端向客戶端響應消息
     *
     * @param ctx
     * @param req
     * @param res
     */
    private void sendHttpResponse(ChannelHandlerContext ctx, FullHttpRequest req,
                                  DefaultFullHttpResponse res) {

        // 返回應答給客戶端
        if (res.getStatus().code() != 200) {
            ByteBuf buf = Unpooled.copiedBuffer(res.getStatus().toString(), CharsetUtil.UTF_8);
            res.content().writeBytes(buf);
            buf.release();
        }

        // 若是是非Keep-Alive，關閉鏈接
        ChannelFuture f = ctx.channel().writeAndFlush(res);
        if (res.getStatus().code() != 200) {
            f.addListener(ChannelFutureListener.CLOSE);
        }
    }
}


 

最後，編寫入口程序：啓動WebSocket服務

package com.imooc.netty;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.Channel;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;

/**
 * 程序的入口，負責啓動應用
 * @author liuyazhuang
 *
 */
public class Main {
	public static void main(String[] args) {
		EventLoopGroup bossGroup = new NioEventLoopGroup();
		EventLoopGroup workGroup = new NioEventLoopGroup();
		try {
			ServerBootstrap b = new ServerBootstrap();
			b.group(bossGroup, workGroup);
			b.channel(NioServerSocketChannel.class);
			b.childHandler(new MyWebSocketChannelHandler());
			System.out.println("服務端開啓等待客戶端鏈接....");
			Channel ch = b.bind(8888).sync().channel();
			ch.closeFuture().sync();
		} catch (Exception e) {
			e.printStackTrace();
		}finally{
			//優雅的退出程序
			bossGroup.shutdownGracefully();
			workGroup.shutdownGracefully();
		}
	}
}

客戶端代碼：

<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset = utf-8"/>
		<title>WebSocket客戶端</title>
	<script type="text/javascript">
		var socket;
		if(!window.WebSocket){
			window.WebSocket = window.MozWebSocket;
		}

		if(window.WebSocket){
			socket = new WebSocket("ws://localhost:8888/websocket");
			socket.onmessage = function(event){
				var ta = document.getElementById('responseContent');
				ta.value += event.data + "\r\n";
			};

			socket.onopen = function(event){
				var ta = document.getElementById('responseContent');
				ta.value = "你當前的瀏覽器支持WebSocket,請進行後續操做\r\n";
			};

			socket.onclose = function(event){
				var ta = document.getElementById('responseContent');
				ta.value = "";
				ta.value = "WebSocket鏈接已經關閉\r\n";
			};
		}else{
			alert("您的瀏覽器不支持WebSocket");
		}


		function send(message){
			if(!window.WebSocket){
				return;
			}
			if(socket.readyState == WebSocket.OPEN){
				socket.send(message);
			}else{
				alert("WebSocket鏈接沒有創建成功！！");
			}
		}
	</script>
	</head>
	<body>
		<form onSubmit="return false;">
			<input type = "text" name = "message" value = ""/>
			<br/><br/>
			<input type = "button" value = "發送WebSocket請求消息" onClick = "send(this.form.message.value)"/>
			<hr color="red"/>
			<h2>客戶端接收到服務端返回的應答消息</h2>
			<textarea id = "responseContent" style = "width:1024px; height:300px"></textarea>
		</form>
	</body>
</html>

 

 

實際使用WebSocket

上面的例子講解了Netty實現WebSocket，通常咱們使用WebSocket不會本身來實現，都是用現成的工具包來進行實現。

我查到的經常使用的方式有兩種：

  • Tomcat實現WebSocket
  • 整合Spring實現WebSocket

這一部分我就再也不贅述了，等我用到的時候再補教程吧，先mark下相關的博客：

總結

WebSocket最大的特色就是長鏈接，可以實時推送數據。

參考連接：

 

若是文章有錯的地方歡迎指正，你們互相交流。習慣在微信看技術文章的同窗，想要獲取更多的Java資源的同窗，能夠關注微信公衆號:Java3y

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程