提示Exception("select_subprotocol called twice")的解决方案

问题原因

Tornado 出现 Exception("select_subprotocol called twice") 的原因是在 WebSockets 协议升级的过程中，select_subprotocol() 方法被调用了两次。这通常是由于在 WebSocket 握手期间，客户端发送的请求中包含多个 Sec-WebSocket-Protocol 头部造成的。这是不符合 WebSocket 协议标准的行为，因为在标准规范中，客户端在请求中只能包含一个 Sec-WebSocket-Protocol 头部来指定子协议。 由于 Tornado 在 WebSocket 握手期间会调用 select_subprotocol() 方法来选择适当的子协议，但是当该方法被多次调用时会导致该异常的发生。 解决该问题的方法是在客户端发送的 WebSocket 请求中只包含一个 Sec-WebSocket-Protocol 头部，以确保满足 WebSocket 协议的规范要求。同时，可以在服务器端的代码中进行异常处理，或调整代码逻辑以适应客户端的行为。

解决方案

在Tornado框架中，当出现Exception("select_subprotocol called twice")异常时，通常是因为在WebSocket连接的过程中多次调用了select_subprotocol方法。WebSocket协议规定在协商子协议时只能调用一次select_subprotocol方法，如果多次调用会导致该异常的抛出。 要解决这个问题，可以在代码中确保只调用一次select_subprotocol方法。一种解决方法是在get_subprotocol方法中保存已经选择的子协议，并在以后的调用中直接返回保存的子协议，而不再调用select_subprotocol方法。 以下是一个示例代码，演示了如何正确处理select_subprotocol方法，避免多次调用导致异常：

class MyWebSocketHandler(tornado.websocket.WebSocketHandler):
    def select_subprotocol(self, subprotocols):
        # 只选择第一个子协议，并保存选择结果
        self.selected_subprotocol = subprotocols[0]
        return subprotocols[0]

    def get_subprotocol(self):
        # 返回保存的子协议选择结果
        return self.selected_subprotocol

    def open(self):
        print("WebSocket connection opened")

    def on_message(self, message):
        print("Received message: %s" % message)
        self.write_message("You said: %s" % message)

    def on_close(self):
        print("WebSocket connection closed")

def make_app():
    return tornado.web.Application([
        (r"/ws", MyWebSocketHandler),
    ])

在上面的示例代码中，select_subprotocol方法只会被调用一次，并将选择的子协议保存在self.selected_subprotocol中。之后的调用会直接返回保存的子协议，从而避免多次调用select_subprotocol方法导致异常的发生。 通过以上的修改，可以避免Tornado框架中出现Exception("select_subprotocol called twice")异常。

具体例子

在 Tornado 框架中出现 Exception("select_subprotocol called twice") 错误的原因是在 WebSocket 连接期间调用了 select_subprotocol() 方法两次。这个问题通常是由于在 WebSocket 连接中重复调用 select_subprotocol() 方法造成的。在 Tornado 中，select_subprotocol() 方法应该在 WebSocket 握手期间用于选择子协议，只能调用一次。 要正确使用 Tornado 中的 select_subprotocol() 方法，需要确保在 WebSocket 握手期间只调用一次，并且不要在其他地方再次调用该方法。 下面是一个示例代码，演示了如何正确使用 Tornado 中的 WebSocket 连接并避免出现 Exception("select_subprotocol called twice") 错误：

import tornado.web
import tornado.websocket
import tornado.ioloop

class MyWebSocketHandler(tornado.websocket.WebSocketHandler):
    def select_subprotocol(self, subprotocols):
        # 在这里选择子协议并返回
        return subprotocols[0]

    def open(self):
        print("WebSocket 连接已建立")

    def on_message(self, message):
        # 处理收到的消息
        self.write_message("Echo: " + message)

    def on_close(self):
        print("WebSocket 连接已关闭")

if __name__ == "__main__":
    app = tornado.web.Application([
        (r"/websocket", MyWebSocketHandler),
    ])
    app.listen(8888)
    tornado.ioloop.IOLoop.current().start()

在这个示例中，我们创建了一个 WebSocketHandler 类，其中覆盖了 select_subprotocol() 方法用于选择子协议。在该方法中，我们使用了参数 subprotocols 来选择第一个子协议并返回。这样就确保了在 WebSocket 握手阶段仅调用了一次 select_subprotocol() 方法，避免了出现 "select_subprotocol called twice" 错误。 通过这样的方式，我们可以正确地使用 Tornado 中的 WebSocket 功能，并避免出现 "select_subprotocol called twice" 错误。