python建立客户端wesocket

WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。

WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据。在 WebSocket API 中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接，并进行双向数据传输。

在 WebSocket API 中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

现在，很多网站为了实现推送技术，所用的技术都是 Ajax 轮询。轮询是在特定的的时间间隔（如每1秒），由浏览器对服务器发出HTTP请求，然后由服务器返回最新的数据给客户端的浏览器。这种传统的模式带来很明显的缺点，即浏览器需要不断的向服务器发出请求，然而HTTP请求可能包含较长的头部，其中真正有效的数据可能只是很小的一部分，显然这样会浪费很多的带宽等资源。

HTML5 定义的 WebSocket 协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯

websocket中就有建立连接connect、发送消息send等函数可供使用，但是websocket.WebSocketApp将这些都封装好了，只用在实例化的时候传入自定义函数即可，更方便。因此这里选择使用websocket.WebSocketApp来模拟客户行为。

WebSocketApp也是websocket中的一个类。要使用WebSocketApp中的回调函数需要传入一系列的可调用对象。在实例化该类时传入构造函数中的on_open、on_message、on_error就需要传入一系列的可调用对象，例如自定义的函数。

以下是websocket.WebSocketApp类中的构造函数的摘录，简单介绍一下各个传入值的说明。

def init(self, url, header=[],

on_open=None, on_message=None, on_error=None,

on_close=None, on_ping=None, on_pong=None,

on_cont_message=None,

keep_running=True,get_mask_key=None, cookie=None,

subprotocols=None,

on_data=None)

（1）url: websocket的地址。

（2）header: 客户发送websocket握手请求的请求头，{‘head1:value1’,‘head2:value2’}。

（3）on_open：在建立Websocket握手时调用的可调用对象，这个方法只有一个参数，就是该类本身。

（4）on_message：这个对象在接收到服务器返回的消息时调用。有两个参数，一个是该类本身，一个是我们从服务器获取的字符串（utf-8格式）。

（5）on_error：这个对象在遇到错误时调用，有两个参数，第一个是该类本身，第二个是异常对象。

（6）on_close：在遇到连接关闭的情况时调用，参数只有一个，就是该类本身。

（7）on_cont_message：这个对象在接收到连续帧数据时被调用，有三个参数，分别是：类本身，从服务器接受的字符串（utf-8），连续标志。

（8）on_data：当从服务器接收到消息时被调用，有四个参数，分别是：该类本身，接收到的字符串（utf-8），数据类型，连续标志。

（9）keep_running：一个二进制的标志位，如果为True，这个app的主循环将持续运行，默认值为True。

（10）get_mask_key：用于产生一个掩码。

（11）subprotocols：一组可用的子协议，默认为空。

除此之外，还有on_ping，on_pong等，详细内容可以查看源代码。

另外说明一下该类中的一个方法叫run_forever()。Run_forever是一个无限循环，只要这个websocket连接未断开，这个循环就会一直进行下去。如果在实现websocket连接时使用了心跳包，可以在这个函数中传入心跳包的间隔，格式如下：

ws.run_forever(ping_interval=SOCKET_PING_INTERVAL,
以上来自原文
原文链接：https://blog.csdn.net/zhaojikun521521/article/details/90574330

对应的实现代码由转载

方法名称	方法解释
on_open	发送参数给服务器调用该方法
on_message	接受服务器返回信息调用该方法
on_error	程序报错调用该方法
on_close	程序断开调用该方法

• 代码如下所示

#!/usr/bin/python
# -*- coding: utf-8 -*-

#@Users: LiMu
#@Files：websocket_long.py
#@Times: 2021/12/29 
#@Software：PyCharm

import os
import sys
import time
import websocket
import json
import zlib
from func_seal.case_premise import get_premise


class socket_long(object):
    def __init__(self,url,premises):
        self.premise = premises
        #当报错module 'websocket' has no attribute 'enableTrace'时使用不报错可以注释
        websocket.enableTrace(True)

        #向服务器建立连接
        self.ws = websocket.WebSocketApp(url=url,on_message = self.on_message,on_error = self.on_error,on_close = self.on_close)
        self.ws.on_open = self.on_open

        #发送心跳时间间隔ping_interval，心跳超时时间ping_timeout
        self.ws.run_forever(ping_interval=3, ping_timeout=1)

    #接受消息调用方法on_message()
    def on_message(self,ws,message):
        #对服务器返回数据进行处理
        message = zlib.decompress(message)
        message = json.loads(message)

        #筛选服务器返回数据，只打印用例相关接口的数据
        if message["HandleCode"] != "":
            print("{} 返回信息:{}".format(message["HandleCode"], message))

    #程序调错时调用方法on_error()
    def on_error(self,ws,error):
        print("{}返回错误:{}".format(ws,error))

    #主动断开时调用方法on_close()
    def on_close(self,ws):
        self.ws.close()
        print("{}关闭链接{}".format(ws,"closed"))

    #建立连接时调用方法on_open()
    def on_open(self,ws):
        time.sleep(2)
        #便利用例并把参数发送给服务器
        for i in self.premise:
            print("{} 参数发送:{}".format(i["HandleCode"], i))
            ws.send(json.dumps(i))
        print("-" * 180)


if __name__ == '__main__':
    resp = socket_long("ws://XX.XX.XX.XX:YYYY/client",get_premise().get_premise())

作者：解语者
链接：https://www.jianshu.com/p/2aef1da6950c
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。