Java WebSocket 實踐1 - 基於javax

Java WebSocket 實踐1-基於javax

webSocket 的定義

WebSocket 是一種全雙工的通信協議，基於Http之上，可以實現服務端和客戶端之間建立一個長連接，實現服務端主動向客戶端推送消息，客戶端也可以主動向服務端發送消息的功能。
常見的使用場景就是：客戶端需要高頻率的向服務端發起同一個Http請求，類似於輪詢的方式，這種解決方案的缺陷主要有兩個方面：

消息不及時
浪費大量的帶寬和服務器資源。
這種情況下，websocket就派上用場了。

webSocket 中的概念

webSocket 和單純的Http請求最大不同，就是webSocket 是雙向的通信，http是單向的，所以websocket中會存在一些基本的生命週期的概念。作爲一個協議，各種不同的編程語言都有不同的實現形式，但是都是圍繞這些中心的生命週期來的。

connect ：客戶端同服務端發起連接。連接需要用到一個URL ：
URL ： webSocket 的URL 以ws作爲開頭，中間和http一樣是host和端口port，後邊加上服務端定義的請i去路徑。不同的是這個URL 只是用來建立連接的，建立連接之後，就是雙方互相通信了。就像是兩個人打電話，撥通電話時候用到的電話號碼就是這兒的這個URL ，電話接通了，兩個人就可以說話了。
message：不同的環境中有不同的名稱，比如 javax中叫做是 onMessage , 反正就是處理收到的消息。
close : 連接關閉。通常可以定義連接關閉之後可以處理的步驟
error：連接錯誤，定義連接錯誤時候，如何處理錯誤，比如發起重連還是隻記錄錯誤信息。

webSocket 在java 中的實現方式。

WebSocket 在Java中得到了javaEE 的原生支持，在Spring 框架中，也有具體解決方案。使用二者都可以實現一個WebSoket的客戶端和服務端。Spring 框架中方案其實也是基於javax的，更加靈活，可以實現一些攔截器之類的更高級的功能。
接下來會提供兩種方式的小Demo ，這兩個小demo是在最近工作中踩坑以後總結出來的。
基於Javax的方案。

基於javax的服務端實現：
- 首先提供是用到的： pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.2.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<groupId>com.example</groupId>
	<artifactId>websocket_javax</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>demo</name>
	<description>A websocket implement by javax</description>

	<properties>
		<java.version>1.8</java.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-websocket</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
			<exclusions>
				<exclusion>
					<groupId>org.junit.vintage</groupId>
					<artifactId>junit-vintage-engine</artifactId>
				</exclusion>
			</exclusions>
		</dependency>

	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

這裏直接使用了spring-boot-starter-websocket 的這個starter ，這個starter中已經包含了javax的依賴，所以不需要重複引入javax-websoket 的相關jar包了。

MyEndPoint 。這裏定義了服務端的webSoket 處理邏輯。實現如下。
其中用到了幾個很重要的註解：
@ServerEndpoint("/test/websocket")：用來聲明這是一個服務端的websoket 。
@Open方法名稱無所謂，隨便定義，不過接受一個Session 對象作爲參數。可以在這裏定義一些連接後的邏輯
@OnMessage處理消息的方法，在這裏處理收到的消息。如果需要返回消息，可以直接return 要返回的消息即可。當然也可以用open時候獲取到的那個Session，手動發送。具體方法是：session.getBasicRemote().sendText();
@OnClose: 處理連接後的事務
@OnError：處理連接失敗的情況

package com.example.demo.service;

import org.springframework.stereotype.Service;

import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;

@Service
// 定義了服務端webSoket的訪問地址
@ServerEndpoint("/test/websocket")
public class MyEndPoint {

    private Session session;

    @OnOpen
    public void myOnOpen (Session session) {
        this.session = session;
        System.out.println("客戶端已經鏈接");
    }

    @OnMessage
    public String myOnMessage (String txt) throws IOException {
        System.out.println(txt);
        return "服務端收到並返回";
    }

    @OnClose
    public void myOnClose (CloseReason reason) {
        System.out.println ("Closing a WebSocketConfig due to "+reason.getReasonPhrase());
    }

    @OnError
    public void onError(Throwable throwable){
        System.out.println("連接已經關閉");
    }


}

配置webSoket ：這裏向Spring中註冊一個ServerEndpointExporter 對象。

package com.example.demo.service;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

@Configuration
public class WebSocketConfig {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

Spring boot的啓動類代碼就補貼了，最原始的，除了一個run沒有其他的。

到此，一個服務端的demo就ok 了。

基於javax的客戶端實現
- pom和上邊的一樣，不重複貼了。
- 客戶端實現：
  和服務端唯一的不同是換成了@ClientEndpoint 的註解，表示這是一個客戶端的websoket。不同的是這個註解不能自定義屬性。其他的註解含義和服務端一致。

package com.example.demo.service;

import org.springframework.stereotype.Service;

import javax.websocket.*;
import java.io.IOException;

@Service
@ClientEndpoint
public class MyClientEndPoint {


    private Session session;

    @OnOpen
    public void onOpen(Session session) {
        this.session = session;
        System.out.println ("WebSocketConfig opened: "+session.getId());
        System.out.println("服務端鏈接成功");
        try {
            this.sendMessage();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    @OnMessage
    public String onMessage(String txt) throws IOException, InterruptedException {
        System.out.println(txt);
        Thread.sleep(1000);
        return "客戶端收到";
    }

    @OnClose
    public void onClose(CloseReason reason) {
        System.out.println ("Closing a WebSocketConfig due to "+reason.getReasonPhrase());
    }

    @OnError
    public void onError(Throwable throwable){
        System.out.println("連接已經關閉");
    }

    public void sendMessage() throws IOException {
        this.session.getBasicRemote().sendText("客戶端發送");
    }


}

配置類代碼和服務端一致。
啓動類代碼：

package com.example.demo;

import com.example.demo.service.MyClientEndPoint;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

import javax.websocket.ContainerProvider;
import javax.websocket.DeploymentException;
import javax.websocket.WebSocketContainer;
import java.io.IOException;
import java.net.URI;

/**
 * @author duanqichao
 */
@SpringBootApplication
public class DemoApplication {

	public static void main(String[] args) throws IOException, DeploymentException {
		SpringApplication.run(DemoApplication.class, args);
		// 這裏需要使用一個WebSoketContainer 對象來和服務端的連接
		WebSocketContainer container = ContainerProvider.getWebSocketContainer();
		String uri = "ws://localhost:8080/test/websocket";
		// 連接服務端的地址和處理類信息
		container.connectToServer(MyClientEndPoint.class, URI.create(uri));
	}
}

至此，一個webSoket的小demo 就可以運行了。

主要會遇到的坑：
1：忘了寫配置類信息。
2： Session 對象很重要，用可以獲取連接的具體屬性信息以及用它來發送信息等。

webSocket 如何測試：

Http 接口通常我們會使用postman這類工具來模擬發起請求，但是websoket 沒那麼容易，所以需要一些小工具。
推薦兩個：

一個網址：http://websoket-test.com
chrome 瀏覽器插件：去chrome 市場去看一下，直接搜索websoket client ，隨便選一個都可以。

Java WebSocket 實踐1 - 基於javax