README

代理服务器 (Python 3).

配置要求

Python 3 (tested on Python 3.7)

1. The websockets module (pip install websockets)
2. The yaml module (pip install pyyaml)
3. The asyncio module (pip install asyncio)

结构说明

结构图

.
├── README.md
├── config.yaml             				#配置文件
├── error_log.log          					#输出error级别的日志
├── output_log_all.log      				#总日志文件
├── proxy_one_coroutine_version.py  #只包含一个asyncio.coroutine函数的运行主体(main)
├── proxy_coroutine_yield_version.py#使用asyncio.coroutine和yield from实现的运行主体(main)
├── proxy_await_async_version.py		#使用async和await实现的运行主体(main)
├── launch.py               				#启动入口，负责加载配置文件、运行
├── test                    				#单元测试文件
│   ├── proxy_tests.py      
│   └── testConfig.yaml
└── websocket_proxpy        
    └── util                
        ├── base.py         				#定义fatal_fail处理方法
        ├── jsonutils.py    				#json处理方法
        └── loggers.py      				#日志记录

• proxy_one_coroutine_version在macos 10.14，python 3.7.6测试通过，在ubuntu18.04 python 3.7.6测试不通过，目前原因尚不清晰。proxy_coroutine_yield_version和proxy_await_async_version可正常运行。
• Python 3.8开始推荐使用async、await代替@asyncio.coroutine、yield from

使用说明

1. 在config.yaml中按照注释说明修改port、proxied_url、proxied_port_list。

2. 在launch.py的第一行可以选择从proxy_coroutine_yield_version或proxy_await_async_version引入WebSocketProxpy类。

3. 服务器(10.78.4.163)中打开终端，输入：

   conda activate wsp

   切换到wsp (websokets proxy) python 3.7.9环境，输入：

   cd /Downloads/websockets_proxy
   python launch.py

   进入到/Downloads/websockets_proxy，运行代理服务器。

4. 在运行quickstart中的测试脚本的时候，请在最后一行加入sim.remote.finish()。目的在于给代理服务器发送关闭请求，关闭已使用的端口。

   sim.remote.finish()发送{"action": "close"}到代理服务器，代理服务器关闭client--proxy和proxy--server的连接。

   Gitlab上的python client中已经更新了pythonAPI/lgsvl/remotes.py。

代码说明

launch.py

config = yaml.load(open("CONFIG_PATH"))

加载配置文件

WebSocketProxpy(loggers.ConsoleDebugLogger()).run(config)

loggers.ConsoleDebugLogger()是日志处理类对象；

WebSocketProxpy.run()是代理服务器程序入口

proxy_coroutine_yield_version.py

全局变量：

is_port_used = {}

字典数据类型，记录端口是否被占用，格式：{"port":bool}

---

WebSocketProxpy类内变量简介：

logger = None                       #日志处理类对象
host = ""                           #宿主机,0.0.0.0
port = 0                            #端口号,代理服务器的端口
serverType = "OPEN_URL"             #连接类型
proxied_url = ""                    #eg.ws://10.78.4.163:    
password = ""                       #连接密码
send_suffix = ""                    #json后缀
send_prefix = ""                    #json前缀
proxied_port_list = []              #服务器端可用端口列表
requests_per_connection = 10000     #每个连接的最大请求数量

---

WebSocketProxpy类内函数简介：

def is_close(json_content):

判断手否收到关闭请求，# expects {"url": "ws://0.0.0.0:8081"}

def load_config_from_yaml(self, config_yaml):

读取配置文件并赋值

@asyncio.coroutine

def run(self,config_yaml):

建立client--proxy之间的连接

运行调度函数proxy_dispatcher

@asyncio.coroutine

def proxy_dispatcher(self, proxy_web_socket, path):

协程函数，协程的了解可以参考这里

• 代理服务器调度函数，判断有无端口可用，有端口，则分空闲端口；无端口，则返回忙碌

• 处理client--proxy--server之间的请求(调用process_arbitrary_requests)

@asyncio.coroutine

def process_arbitrary_requests(self, proxy_web_socket, proxied_web_socket, connection):

负责四部分任务：

part 1:从client接收请求;

part 2:proxy发送请求到server;

part 3:proxy接受server返回的数据;

part 4:proxy返回数据到client

@asyncio.coroutine

def connect_to_proxy_server(self, proxied_url_value, proxy_web_socket):

建立proxy--server之间的链接

@asyncio.coroutine

def send_to_web_socket_connection_aware(self, proxy_web_socket, proxied_web_socket, request_for_proxy):

proxy发送请求到server