在 Android 应用程序中使用哪个 WebSocket 库？ [关闭]

Question

我想将Service 添加到我的Android 应用程序中，该应用程序在后台运行并持有WebSocket 连接（可能需要几个小时甚至几天）并定期向服务器发送一些数据。

现在似乎有一堆用于 Java 的 WebSocket 库，我不确定应该使用哪个：

• TooTallNate/Java-WebSocket 来自 GitHub 的描述：用 100% Java 编写的准系统 WebSocket 客户端和服务器实现。 http://java-websocket.org/ -- 这个链接在my first result of googling "android websocket"。但是，它有很多未解决的问题，尤其是关于 SSL 连接，而且目前似乎没有得到积极维护。

• koush/AndroidAsync 来自 GitHub 的描述：异步套接字、http（客户端+服务器）、websocket 和 android 的 socket.io 库。基于 nio，而不是线程。 -- 还有许多未解决的问题，但似乎正在积极维护/处理。

• Project Tyrus 来自网站的描述：JSR 356: Java API for WebSocket - 参考实现 -- 这是甲骨文制作的。不确定它是否适用于 Android。

• Jetty WebSocket Client API 来自网站的信息：Jetty 还提供了一个 Jetty WebSocket 客户端库来编写使与 WebSocket 服务器的对话更容易。 -- 再说一遍：不确定它是否适用于 Android。

• codebutler/android-websockets 来自 GitHub 的描述：适用于 Android 的 Bare minimum websockets (hybi13/RFC) 客户端 -- 这个在schwiz/android-websocket-example中使用，这是StackOverflow问题“How to make the Android device hold a TCP connection to Internet without wake lock?”的公认答案。

• Atmosphere/wasync 来自 GitHub 的描述：带有后备传输客户端库的 WebSockets 用于 Node.js、Android 和 Java http://async-io.org

• TakahikoKawasaki/nv-websocket-client 来自 GitHub 的描述：Java 中的高质量 WebSocket 客户端实现。

• square/okhttp 来自 GitHub 的描述：Android 和 Java 应用程序的 HTTP+SPDY 客户端。 http://square.github.io/okhttp/ -- 它有一个Websocket module。 作为mentioned by scorpiodawg，OkHttp 从 3.5 版本开始就内置了 websocket 支持。

• firebase/TubeSock 来自 GitHub 的描述：用 Java 实现的 WebSocket 客户端库

• Autobahn|Android (GitHub) 来自网站的描述：Autobahn|Android 是一个用于 Java/Android 的开源网络库，由 Autobahn 项目创建，它实现了 WebSocket 协议和 Web 应用程序消息传递协议 (WAMP)，用于创建本地移动 WebSocket/WAMP 客户端。 -- cloudsurfin pointed out 不支持wss。

另外还有一个原生的socket.ioAndroid客户端库：

• nkzawa/socket.io-client.java 来自 GitHub 的描述：用于 Java 的全功能 Socket.IO 客户端库，兼容 Socket.IO v1.0 及更高版本。

使用 socket.io Android 客户端对我来说很方便，因为无论如何我都计划将 nodejs/socket.io 用于 Web 前端。但是本地客户端还很年轻，并且有几个未解决的问题。除此之外，据我了解，android 应用程序没有任何使用 socket.io 客户端库的好处（除了与 socket.io 1.0 服务器兼容），因为可以在客户端确保 WebSocket 支持.

我的要求如下：

• 与 Android API 9 及更高版本的兼容性
• 可以通过 SSL 连接
• 无需持有永久唤醒锁即可长时间保持连接
• 与可用的 nodejs websocket 服务器实现或与 socket.io 的兼容性

有什么建议适合这些需求的库吗？

Answer 1

一些笔记。

• koush/AndroidAsync 不执行RFC 6455 所需的closing handshake。详情请见this。

• Project Tyrus 适用于 Android，但请确保其许可证 (CDDL 1.1 and GPL 2 with CPE) 和大小 (Reducing WebSocket client jar size with ProGuard) 符合您的要求。另请注意，当文本大小很大时，Tyrus 可能会抛出异常（这可能是一个错误）。详情请见this。

• Jetty：2 年前，jetty-users 邮件列表中的 email thread 说 “我们目前没有兼容 Android 的 Jetty 9 WebSocket 客户端。有计划尝试向后移植Jetty WebSocket Client 从 JDK 7 到 JDK 5/6 供 android 使用，但它的优先级低于完成我们对 JSR-356 Java WebSocket API (javax.websocket) 的实现。” Jetty 当前的 document 关于它的WebSocket Client API 没有提及任何关于 Android 的内容。

• codebutler/android-websocket 不执行closing handshake 所需的RFC 6455，并且可能在关闭时抛出异常。见this。

• Atmosphere/wasync 使用 AsyncHttpClient/async-http-client 作为其 WebSocket 实现。因此，应该改为提及 AsyncHttpClient/async-http-client。

• firebase/TubeSock 不验证 Sec-WebSocket-Accept。这违反了RFC 6455。此外，TubeSock 在构建文本消息方面存在错误。如果您将多字节 UTF-8 字符用于文本消息，您迟早会遇到该错误。有关 TubeSock 问题的长列表，请参阅 delight-im/Android-DDP 中的 Issue 3。
  
  

注意事项

选择Java编写的WebSocket客户端实现的注意事项：

1. 合规性。不少实现没有实现RFC 6455 要求的closing handshake。 （如果关闭握手没有实现会怎样？见this。）
2. 所需的 Java 版本。 Java SE 5、6、7、8 还是 Java EE？甚至可以在 Android 上运行？
3. 尺寸。一些实现有很多依赖项。
4. wss 支持。
5. HTTP 代理 支持。
6. wss over HTTP 代理 支持。请参阅How HTML5 Web Sockets Interact With Proxy Servers 中的图 2，了解 WebSocket 客户端库必须做什么才能支持 wss over HTTP 代理。
7. SSL 配置的灵活性。 SSLSocketFactory 和 SSLContext 应该可以在没有不必要限制的情况下使用。
8. opening handshake 中的自定义 HTTP 标头，包括基本身份验证。
9. HTTP 代理协商中的自定义 HTTP 标头，包括代理服务器上的身份验证。
10. 能够发送所有帧类型（连续、二进制、文本、关闭、ping 和 pong）。大多数实现不为开发人员提供手动发送fragmented frames 和不请自来 pong frames 的方法。
11. 侦听器接口 接收各种 WebSocket 事件。糟糕的界面使开发人员感到沮丧。丰富的界面可帮助开发人员编写强大的应用程序。
12. 能否查询WebSocket状态。 RFC 6455 定义了 CONNECTING、OPEN、CLOSING 和 CLOSED 状态，但很少有实现以定义的方式保持其内部状态转换。
13. 可以设置套接字连接的超时值。 （相当于Socket.@987654344@(SocketAddress endpoint, int timeout)方法的第二个参数）
14. 能够访问底层原始套接字。
15. 直观易用的 API 与否。
16. 有据可查与否。
17. RFC 7692（WebSocket 的压缩扩展） 支持（又名 permessage-deflate）。
18. 重定向 (3xx) 支持。
19. 摘要式身份验证支持。

nv-websocket-client 涵盖了除最后两个之外的所有内容。此外，它的一项小而方便的功能是定期发送 ping/pong 帧。只需调用setPingInterval/setPongInterval方法即可实现（见JavaDoc）。

免责声明：Takahiko Kawasaki 是 nv-websocket-client 的作者。

Answer 2

其他一些注意事项：

Tyrus 适用于 Android。然而，它在 Android 5.0 中使用的 SSL 库是有缺陷的，而且 fail SSL handshakes。这应该在较新版本的 Android 中得到修复，但由于许多设备上没有更新 Android，这对您来说可能是个问题。

取决于 SSL 是如何为其他 websocket 实现实现的，这也可能是一个问题。

AndroidAsync 没有这个 SSL 问题。它确实有其他问题，例如not being able to set timeouts。

Answer 3

a) 将此文件添加到 gradle 文件中

compile 'com.github.nkzawa:socket.io-client:0.3.0'

b) 在 Application Activity 中添加这些行：

    public class MyApplication extends Application {
     private Socket mSocket;
        {
            try {
               mSocket = IO.socket(Config.getBaseURL());

            } catch (URISyntaxException e) {
                throw new RuntimeException(e);
            }
        }

        public Socket getSocket() {
            return mSocket;
        }
}

c) 将此函数添加到您调用 WebSocket 的活动中：

     private void websocketConnection() {
            //Get websocket from application
            MyApplication app = (MyApplication ) getApplication();
            mSocket = app.getSocket();
            mSocket.on(Socket.EVENT_CONNECT, onConnect);
            mSocket.on(Socket.EVENT_DISCONNECT, onDisconnect);
            mSocket.on(Socket.EVENT_CONNECT_ERROR, onConnectError);
            mSocket.on(Socket.EVENT_CONNECT_TIMEOUT, onConnectError);
            mSocket.on("messageFromServer", onNewLocation);
            mSocket.connect();
        } 


    private Emitter.Listener onConnect = new Emitter.Listener() {
        @Override
        public void call(Object... args) {
            runOnUiThread(() -> {
                if (!isConnected) {

                    RequestSocket mRequestSocket = new RequestSocket();

                    mRequestSocket.setToken("anil_singhania");
                   /* your parameter */
                    mSocket.emit("messageFromClient", new Gson().toJson(mRequestSocket));
                    Log.i("Socket Data", new Gson().toJson(mRequestSocket));
                    isConnected = true;
                }
            });
        }
    };

    private Emitter.Listener onDisconnect = args -> runOnUiThread(() -> {
        isConnected = false;
       /* Toast.makeText(getApplicationContext(),
                R.string.disconnect, Toast.LENGTH_LONG).show();*/
    });

    private Emitter.Listener onConnectError = args -> runOnUiThread(() -> {
         /*   Toast.makeText(getApplicationContext(),
            R.string.error_connect, Toast.LENGTH_LONG).show()*/
    });

    private Emitter.Listener onNewLocation = new Emitter.Listener() {
        @Override
        public void call(final Object... args) {
            runOnUiThread(() -> {


            });
        }
    };