WebSocket接口测试方法

WebSocket介绍

WebSocket 是一种基于在单个 TCP 连接上进行全双工通信的协议，是从HTML5开始提供的一种浏览器与服务器之间进行全双工通讯的网络技术，解决了HTTP协议不适用于实时通信的缺点，相较于 HTTP 协议，WebSocket 协议实现了持久化网络通信，可以实现客户端和服务端的长连接，能够进行双向实时通信，协议名为”ws”。

HTTP与WebSocket的区别

​

1. 两者都是基于TCP协议进行数据传输，具有可靠的传输能力，而且都是应用层协议
2. HTTP是单向的通信，只能由客户端向服务端发送请求，服务端无法主动向客户端发送消息
3. WebSocket是双向通信，客户端和服务端是通过握手建立连接，可实现全双工通信，双方可以同时主动向对方发送消息
4. WebSocket在建立连接时数据是通过HTTP协议传输的，但是建立之后，真正传输数据时使用的是更加可靠的TCP协议

二者关系

• WebSocket在建立连接时，HTTP通过Upgrade消息头来通知客户端需要采用WebSocket协议来完成这个请求，在发送完此响应最后的空行后，服务器就会切换到WebSocket协议，接口返回状态码为101，表示服务器已经理解了客户端的请求，需要升级协议

WebSocket测试方法

使用在线工具

在线工具有很多，自行百度吧！个人习惯用这个工具

使用Postman

Postman支持测试WebSocket协议的接口，此文章发布时还处于公测阶段，需要登录后才能使用，入口如下图所示

操作跟测试HTTP请求类似，不过多介绍啦！如下图所示

使用Jmeter

使用Jmeter既可以单独测接口，也可以进行性能测试，但测试WebSocket协议需要安装插件，下载插件后放到Jmeter安装路径中的lib/ext目录下，重启Jmeter后在【选项】菜单中会出现【Plugins Manager】，然后在可用插件Tab页搜索WebSocket，进行安装即可，如下图所示

安装后新建【线程组】，在添加【取样器】中会出现6项WebSocket的组件

• WebSocket Close：用于关闭WebSocket连接
• WebSocket Open Connection：只建立WebSocket连接，不发送数据
• WebSocket Ping/Pong：用于心跳检测，为了保持长连接，防止客户端被服务端判定为不活跃而被断开
• WebSocket Single Read Sampler：用于接收一个（文本或二进制）数据
• WebSocket Single Write Sampler：用于发送一个（文本或二进制）数据
• WebSocket request-response Sampler：用于执行基本的请求和响应交换，既能发送数据又可以接收数据

若有使用过Jmeter就肯定能明白这些组件的使用方法，以WebSocket request-response Sampler为例，页面信息介绍如下图所示

使用Python

首先需要安装websocket-client

pip install websocket-client

对于只是测试WebSocket接口发送接收消息是否正常，不需要长时间连接，可以使用下面的短连接方法，在请求结束后会主动断开连接

from websocket import create_connection

user1 = create_connection("ws://localhost:6688/user/1")	# 用户1打开连接
user2 = create_connection("ws://localhost:6688/user/2")	# 用户2打开连接

print("获取响应状态码：", user1.getstatus()) # 正常应返回101
print("获取响应头：", user2.getheaders())

user1.send("你好呀！")	 # 用户1向服务端发送消息

res1 = user1.recv()		# 查看服务端推送的消息
res2 = user2.recv()

if res1 == res2:
    print("服务端消息推送成功！\n")
else:
    print("消息获取异常！\n")
    
print("查看用户1收到的消息：",res1,"\n查看用户2收到的消息：",res2)

若是要对WebSocket接口做持续监听工作，需要长连接，但不需要传参，只是监听消息，使用WebSocketApp类就更合适啦！方法如下

import websocket

def on_open(ws):				# 定义用来处理打开连接的方法
    print("打开连接")
    
def on_message(ws, message):	# 定义用来监听服务器返回消息的方法
    print("监听到服务器返回的消息，：\n", message)

def on_error(ws, error):		# 定义用来处理错误的方法
    print("连接出现异常：\n", error)

def on_close(ws):				# 定义用来处理断开连接的方法
    print("关闭连接")

if __name__ == "__main__":
    websocket.enableTrace(True) # 可选择开启跟踪，在控制台可以看到详细的信息
    ws = websocket.WebSocketApp("ws://localhost:6688",
                                on_open=on_open,
                                on_message=on_message,
                                on_error=on_error,
                                on_close=on_close)
    ws.run_forever()	# 调用run_forever方法，保持长连接

还可以使用Pytest对WebSocket接口实现自动化测试，示例如下

import pytest
from websocket import create_connection

class TestDyd():
    url = "ws://localhost:6688"

    @classmethod
    def setup_class(cls):
        cls.ws = create_connection(cls.url)  # 建立连接
        cls.ws.settimeout(5)  # 设置超时时间

    def test_connect(self):
        # 通过状态码判断连接是否正常
        assert self.ws.getstatus() == 101

    def test_send(self):
        params = "你好呀！"  			# 定义传参

        self.ws.send(params)			# 发送请求
        result = self.ws.recv()			# 获取响应结果
        print("收到来自服务端的消息：", result)	# 打印响应结果
        # 因为该测试项目传参会显示在响应中，所以通过判断传参是否在响应结果中进行断言
        assert params in result

if __name__ == '__main__':
    pytest.main(["-vs"])

传参可以使用@pytest.mark.parametrize()装饰器，示例如下

import pytest
from websocket import create_connection

class TestDyd():
    
    data = [("/user/2", "今天开直播卖鱼！！！！"),("/user/3", "鱼可以买来放生吗？"),
            ("/user/4", "那条翻白肚的鱼有死亡证明吗？"),("/user/5", "你的鱼会唱歌吗？"),
            ("/user/6", "你的鱼上大学了吗？"),("/user/7", "你的鱼买回来需要隔离吗？")]

    @pytest.mark.parametrize("user, word", data)
    def test_send(self, user, word):
        ws = create_connection("ws://localhost:6688"+user)
        params = word  

        ws.send(params)  # 发送请求
        result = ws.recv()  # 获取响应结果
        print("来自服务端的消息：", result)
        assert params in result	# 断言

先简单介绍这些吧，关于Python脚本，可以参考官方文档，里面有示例和常见问题解决方法

今天的文章WebSocket接口测试方法分享到此就结束了，感谢您的阅读，如果确实帮到您，您可以动动手指转发给其他人。