javax.websocketクライアントの簡単な例


104

誰かが私にWebSocketクライアントの非常に簡単な使用例を教えてもらえますjavax.websocketか?

websocket(ws://socket.example.com:1234)に接続し、メッセージを送信(チャネルを追加)し、メッセージを聞きたいのですが。すべてのメッセージ(送信およびリッスン)はJSON形式です。

そして、このライブラリは単純なWebSocket通信に最適ですか?

回答:


120

私はjavax.websocketここを使用して良い例を見つけました:

http://www.programmingforliving.com/2013/08/jsr-356-java-api-for-websocket-client-api.html

ここで、上記のリンクされた例に基づくコード:

TestApp.java

package testapp;

import java.net.URI;
import java.net.URISyntaxException;

public class TestApp {

    public static void main(String[] args) {
        try {
            // open websocket
            final WebsocketClientEndpoint clientEndPoint = new WebsocketClientEndpoint(new URI("wss://real.okcoin.cn:10440/websocket/okcoinapi"));

            // add listener
            clientEndPoint.addMessageHandler(new WebsocketClientEndpoint.MessageHandler() {
                public void handleMessage(String message) {
                    System.out.println(message);
                }
            });

            // send message to websocket
            clientEndPoint.sendMessage("{'event':'addChannel','channel':'ok_btccny_ticker'}");

            // wait 5 seconds for messages from websocket
            Thread.sleep(5000);

        } catch (InterruptedException ex) {
            System.err.println("InterruptedException exception: " + ex.getMessage());
        } catch (URISyntaxException ex) {
            System.err.println("URISyntaxException exception: " + ex.getMessage());
        }
    }
}

WebsocketClientEndpoint.java

package testapp;

import java.net.URI;
import javax.websocket.ClientEndpoint;
import javax.websocket.CloseReason;
import javax.websocket.ContainerProvider;
import javax.websocket.OnClose;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.WebSocketContainer;

/**
 * ChatServer Client
 *
 * @author Jiji_Sasidharan
 */
@ClientEndpoint
public class WebsocketClientEndpoint {

    Session userSession = null;
    private MessageHandler messageHandler;

    public WebsocketClientEndpoint(URI endpointURI) {
        try {
            WebSocketContainer container = ContainerProvider.getWebSocketContainer();
            container.connectToServer(this, endpointURI);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * Callback hook for Connection open events.
     *
     * @param userSession the userSession which is opened.
     */
    @OnOpen
    public void onOpen(Session userSession) {
        System.out.println("opening websocket");
        this.userSession = userSession;
    }

    /**
     * Callback hook for Connection close events.
     *
     * @param userSession the userSession which is getting closed.
     * @param reason the reason for connection close
     */
    @OnClose
    public void onClose(Session userSession, CloseReason reason) {
        System.out.println("closing websocket");
        this.userSession = null;
    }

    /**
     * Callback hook for Message Events. This method will be invoked when a client send a message.
     *
     * @param message The text message
     */
    @OnMessage
    public void onMessage(String message) {
        if (this.messageHandler != null) {
            this.messageHandler.handleMessage(message);
        }
    }

    /**
     * register message handler
     *
     * @param msgHandler
     */
    public void addMessageHandler(MessageHandler msgHandler) {
        this.messageHandler = msgHandler;
    }

    /**
     * Send a message.
     *
     * @param message
     */
    public void sendMessage(String message) {
        this.userSession.getAsyncRemote().sendText(message);
    }

    /**
     * Message handler.
     *
     * @author Jiji_Sasidharan
     */
    public static interface MessageHandler {

        public void handleMessage(String message);
    }
}

1
こんにちは、websocketServerがメッセージの連続ストリームを送信していて、websocketClientがメッセージを1つずつ消費する必要がある場合に、このコードを機能させるにはどうすればよいですか。約1分間コードを実行した後、「デコードされたテキストメッセージは出力バッファーには大きすぎ、エンドポイントは部分的なメッセージをサポートしていません」というエラーが表示されます
firstpostcommenter

必ずmaven-import org.java-websocketをインポートしてください。
アルバートヘンドリックス2018年

9
このコードは次のエラーで失敗します:実装クラスが見つかりませんでした。
Kirk Sefchik

2
@deathgaze javax.websocket apiは、仕様に完全な実装がないため、jarファイルtyrus-standalone-client-1.9.jarを使用して、問題を解決する同じ例を試す必要がある場合があります。私は私の例でテストしましたが、うまくいきます。これがお役に立てば幸いです。
SRK 2018年

@Martin Openでメッセージを送信するにはどうすればよいですか。例:Webソケットを開いてサブスクライブするには、「{"type": "subscribe"、 "symbol": "AAPL"}」を送信する必要があります。
Buddhika

40

TooTallNateにはシンプルなクライアント側がありますhttps://github.com/TooTallNate/Java-WebSocket

distフォルダーのjava_websocket.jarをプロジェクトに追加するだけです。

 import org.java_websocket.client.WebSocketClient;
 import org.java_websocket.drafts.Draft_10;
 import org.java_websocket.handshake.ServerHandshake;
 import org.json.JSONException;
 import org.json.JSONObject;

  WebSocketClient mWs = new WebSocketClient( new URI( "ws://socket.example.com:1234" ), new Draft_10() )
{
                    @Override
                    public void onMessage( String message ) {
                     JSONObject obj = new JSONObject(message);
                     String channel = obj.getString("channel");
                    }

                    @Override
                    public void onOpen( ServerHandshake handshake ) {
                        System.out.println( "opened connection" );
                    }

                    @Override
                    public void onClose( int code, String reason, boolean remote ) {
                        System.out.println( "closed connection" );
                    }

                    @Override
                    public void onError( Exception ex ) {
                        ex.printStackTrace();
                    }

                };
 //open websocket
 mWs.connect();
 JSONObject obj = new JSONObject();
 obj.put("event", "addChannel");
 obj.put("channel", "ok_btccny_ticker");
 String message = obj.toString();
 //send message
 mWs.send(message);

// WebSocketを閉じる

 mWs.close();

4
Windows 7、Windows 8、およびEclipseを使用するOS Xマウンテンライオンで動作し、サーバーはUbuntuでした。
TCassellは、

1
なぜあなたはjavaxのものの代わりにこのライブラリを選ぶのですか?
BvuRVKyUVlViVIc7 2016年

2
それは明らかに単純であるため
カイル・ルーク

4
wssプロトコル(保護されたws)をサポートするために必要な変更はどれですか?
Mihailo Stupar 2017年

2
素晴らしいライブラリですが、wssに問題があります。プロジェクトにはいくつかの未解決の問題があり、開発者は彼にもう時間がないとコメントしています。
SiKing 2018年

18

Arun GuptaによるこのJava EE 7の例をご覧ください。

githubでフォークしました

メイン

/**
 * @author Arun Gupta
 */
public class Client {

    final static CountDownLatch messageLatch = new CountDownLatch(1);

    public static void main(String[] args) {
        try {
            WebSocketContainer container = ContainerProvider.getWebSocketContainer();
            String uri = "ws://echo.websocket.org:80/";
            System.out.println("Connecting to " + uri);
            container.connectToServer(MyClientEndpoint.class, URI.create(uri));
            messageLatch.await(100, TimeUnit.SECONDS);
        } catch (DeploymentException | InterruptedException | IOException ex) {
            Logger.getLogger(Client.class.getName()).log(Level.SEVERE, null, ex);
        }
    }
}

ClientEndpoint

/**
 * @author Arun Gupta
 */
@ClientEndpoint
public class MyClientEndpoint {
    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected to endpoint: " + session.getBasicRemote());
        try {
            String name = "Duke";
            System.out.println("Sending message to endpoint: " + name);
            session.getBasicRemote().sendText(name);
        } catch (IOException ex) {
            Logger.getLogger(MyClientEndpoint.class.getName()).log(Level.SEVERE, null, ex);
        }
    }

    @OnMessage
    public void processMessage(String message) {
        System.out.println("Received message in client: " + message);
        Client.messageLatch.countDown();
    }

    @OnError
    public void processError(Throwable t) {
        t.printStackTrace();
    }
}

別に出荷されたwebsocket依存関係が必要であることを言及する必要があり
ます


1

このライブラリorg.java_websocketを使用してください

最初に、そのライブラリをbuild.gradleにインポートする必要があります

repositories {
 mavenCentral()
 }

次に、依存関係に実装を追加します{}

implementation "org.java-websocket:Java-WebSocket:1.3.0"

次に、このコードを使用できます

あなたの活動でWebsocketclientのようなオブジェクトを宣言します

private WebSocketClient mWebSocketClient;

次に、このメソッドをコールバックに追加します

 private void ConnectToWebSocket() {
URI uri;
try {
    uri = new URI("ws://your web socket url");
} catch (URISyntaxException e) {
    e.printStackTrace();
    return;
}

mWebSocketClient = new WebSocketClient(uri) {
    @Override
    public void onOpen(ServerHandshake serverHandshake) {
        Log.i("Websocket", "Opened");
        mWebSocketClient.send("Hello from " + Build.MANUFACTURER + " " + Build.MODEL);
    }

    @Override
    public void onMessage(String s) {
        final String message = s;
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                TextView textView = (TextView)findViewById(R.id.edittext_chatbox);
                textView.setText(textView.getText() + "\n" + message);
            }
        });
    }

    @Override
    public void onClose(int i, String s, boolean b) {
        Log.i("Websocket", "Closed " + s);
    }

    @Override
    public void onError(Exception e) {
        Log.i("Websocket", "Error " + e.getMessage());
    }
};
mWebSocketClient.connect();

}


-2

私のプロジェクトにはSpring 4.2があり、多くのSockJS Stomp実装は通常、Spring Boot実装でうまく機能します。Baeldungによるこの実装は機能しました(Spring 4.2から5に変更せずに私にとっては)。彼のブログで言及されている依存関係を使用した後も、ClassNotFoundErrorが発生しました。以下の依存関係を追加して修正しました。

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>4.2.3.RELEASE</version>
    </dependency>
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.