基于WebSocket的client封裝

最近已經陷于了Socket測試的泥潭中了,之前用Java寫了一個Client封裝類,本想在經歷過本輪測試之后,寫一些文檔在發出來,沒想到測試對象用的是Socket.IO,所以先把一個寫好的WebSocketClient的類發出來,分享一下。后臺回復Git可以查看倉庫地址,方便及時了解代碼更新情況。

這里面主要增加了一些日期和方法的封裝,重點是為了調用方便和以后進行Socket接口性能測試做準備,增加的功能性的東西就是返回消息的記錄。用了一個LinkedList<String>記錄最后獲取到的消息。具體的操作方法如下:

    /**
     * 保存收到的信息,只保留最近的{@link SocketConstant}條
     *
     * @param msg
     */
    public void saveMsg(String msg) {
        synchronized (msgs) {
            if (msgs.size() > SocketConstant.MAX_MSG_SIZE) msgs.remove();
            msgs.add(msg);
        }
    }

增加了一個配置類SocketConstant,里面都是一些靜態的常量,這里就不放代碼了。

WebSocketFunClient封裝類

package com.fun.frame.socket;

import com.alibaba.fastjson.JSONObject;
import com.fun.base.bean.AbstractBean;
import com.fun.base.exception.FailException;
import com.fun.base.exception.ParamException;
import com.fun.config.Constant;
import com.fun.config.SocketConstant;
import com.fun.frame.SourceCode;
import com.fun.utils.RString;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.enums.ReadyState;
import org.java_websocket.handshake.ServerHandshake;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.LinkedList;
import java.util.Vector;

/**
 * socket客戶端代碼,限于WebSocket協議的測試
 */
@SuppressFBWarnings({"CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE", "DM_DEFAULT_ENCODING", "MS_SHOULD_BE_FINAL"})
public class WebSocketFunClient extends WebSocketClient {

    private static Logger logger = LoggerFactory.getLogger(WebSocketFunClient.class);

    public static Vector<WebSocketFunClient> socketClients = new Vector<>();

    /**
     * 存儲收到的消息
     */
    public LinkedList<String> msgs = new LinkedList<>();

    /**
     * 連接的url
     */
    private String url;

    /**
     * 客戶端名稱
     */
    private String cname;

    private WebSocketFunClient(String url, String cname) throws URISyntaxException {
        super(new URI(url));
        this.cname = cname;
        this.url = url;
        socketClients.add(this);
    }

    /**
     * 獲取socketclient實例
     *
     * @param url
     * @return
     */
    public static WebSocketFunClient getInstance(String url) {
        return getInstance(url, Constant.DEFAULT_STRING + RString.getString(4));
    }

    /**
     * 獲取socketclient實例
     *
     * @param url
     * @param cname
     * @return
     */
    public static WebSocketFunClient getInstance(String url, String cname) {
        WebSocketFunClient client = null;
        try {
            client = new WebSocketFunClient(url, cname);
        } catch (URISyntaxException e) {
            ParamException.fail(cname + "創建socket client 失敗! 原因:" + e.getMessage());
        }
        return client;
    }

    @Override
    public void onOpen(ServerHandshake handshakedata) {
        logger.info("{} 正在建立socket連接...", cname);
        handshakedata.iterateHttpFields().forEachRemaining(x -> logger.info("握手信息key: {} ,value: {}", x, handshakedata.getFieldValue(x)));
    }

    /**
     * 收到消息時候調用的方法
     *
     * @param message
     */
    @Override
    public void onMessage(String message) {
        saveMsg(message);
        logger.info("{}收到: {}", cname, message);
    }

    /**
     * 關閉
     *
     * @param code   關閉code碼,詳情查看 {@link org.java_websocket.framing.CloseFrame}
     * @param reason 關閉原因
     * @param remote
     */
    @Override
    public void onClose(int code, String reason, boolean remote) {
        logger.info("{} socket 連接關閉,URL: {} ,code碼:{},原因:{},是否由遠程服務關閉:{}", cname, url, code, reason, remote);
    }

    /**
     * 關閉socketclient
     */
    @Override
    public void close() {
        logger.warn("{}:socket連接關閉!", cname);
        super.close();
        socketClients.remove(this);
    }

    /**
     * 出錯時候調用
     *
     * @param e
     */
    @Override
    public void onError(Exception e) {
        logger.error("{} socket異常,URL: {}", cname, url, e);
    }

    /**
     * 發送消息
     *
     * @param text
     */
    @Override
    public void send(String text) {
        logger.debug("{} 發送:{}", cname, text);
        super.send(text);
    }

    /**
     * 簡歷socket連接
     */
    @Override
    public void connect() {
        logger.info("{} 開始連接...", cname);
        super.connect();
        int a = 0;
        while (true) {
            if (this.getReadyState() == ReadyState.OPEN) break;
            if ((a++ > SocketConstant.MAX_WATI_TIMES)) FailException.fail(cname + "連接重試失敗!");
            SourceCode.sleep(SocketConstant.WAIT_INTERVAL);
        }
        logger.info("{} 連接成功!", cname);
    }

    /**
     * 發送非默認編碼格式的文字
     *
     * @param text
     * @param charset
     */
    public void send(String text, Charset charset) {
        send(new String(text.getBytes(), charset));
    }

    /**
     * 發送json信息
     *
     * @param json
     */
    public void send(JSONObject json) {
        send(json.toJSONString());
    }

    /**
     * 發送bean
     *
     * @param bean
     */
    public void send(AbstractBean bean) {
        send(bean.toString());
    }

    /**
     * 重置連接
     */
    @Override
    public void reconnect() {
        logger.info("{}重置連接并嘗試重新連接!", cname);
        super.reconnect();
    }

    /**
     * 設置cname,多用于性能測試clone()之后
     *
     * @param cname
     */
    public void setCname(String cname) {
        this.cname = cname;
    }

    /**
     * 該方法用于性能測試中,clone多線程對象
     *
     * @return
     */
    @Override
    public WebSocketFunClient clone() {
        return getInstance(this.url, this.cname + RString.getString(4));
    }

    /**
     * 關閉所有socketclient
     */
    public static void closeAll() {
        socketClients.forEach(x ->
                {
                    if (x != null && !x.isClosed()) x.close();
                }
        );
        socketClients.clear();
        logger.info("關閉所有Socket客戶端!");
    }

    /**
     * 保存收到的信息,只保留最近的{@link SocketConstant}條
     *
     * @param msg
     */
    public void saveMsg(String msg) {
        synchronized (msgs) {
            if (msgs.size() > SocketConstant.MAX_MSG_SIZE) msgs.remove();
            msgs.add(msg);
        }
    }


}

測試Demo

    public static void main(String[] args) {
        def instance = WebSocketFunClient.getInstance("ws://127.0.0.1:8080/ws/fun")
        instance.connect()
        instance.send("FunTester")
        sleep(10000)
        instance.close()

    }

控制臺輸出

INFO-> 當前用戶:fv,IP:10.60.192.21,工作目錄:/Users/fv/Documents/workspace/fun/,系統編碼格式:UTF-8,系統Mac OS X版本:10.15.7
INFO-> FunTesterkgbn 開始連接...
INFO-> FunTesterkgbn 正在建立socket連接...
INFO-> 握手信息key: Connection ,value: upgrade
INFO-> 握手信息key: Date ,value: Mon, 30 Nov 2020 09:16:30 GMT
INFO-> 握手信息key: Sec-WebSocket-Accept ,value: yQj8IZx/STCzhcWY0ovQ98hxI8o=
INFO-> 握手信息key: Upgrade ,value: websocket
INFO-> FunTesterkgbn收到: 世界喊話器     用戶:fun已經上線了!   
INFO-> FunTesterkgbn 連接成功!
INFO-> FunTesterkgbn收到: 世界喊話器     fun:FunTester   
WARN-> FunTesterkgbn:socket連接關閉!
INFO-> FunTesterkgbn socket 連接關閉,URL: ws://127.0.0.1:8080/ws/fun ,code碼:1000,原因:,是否由遠程服務關閉:false

Process finished with exit code 0


公眾號FunTester,非著名測試開發,文章記錄學習和感悟,歡迎關注,交流成長。

FunTester熱文精選

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容