Prosty przykład klienta javax.websocket

104

Czy ktoś może mi podać bardzo prosty przykład wykorzystania klienta WebSocket javax.websocket?

Chcę połączyć się z websocket (ws: //socket.example.com: 1234), wysłać wiadomość (dodać kanał) i odsłuchać wiadomości. Wszystkie wiadomości (wysłane i odsłuchane) są w formacie JSON.

A tak przy okazji, czy ta biblioteka jest najlepsza do prostej komunikacji przez websocket?

Jaskółka oknówka
źródło

Odpowiedzi:

122

Znalazłem świetny przykład używając javax.websockettutaj:

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

Tutaj kod oparty na powyższym przykładzie:

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);
    }
}
Jaskółka oknówka
źródło
1
Cześć, jak sprawić, by ten kod działał, jeśli websocketServer wysyła ciągły strumień komunikatów, a websocketClient musi zużywać wiadomości jeden po drugim? Otrzymuję błąd „Odkodowana wiadomość tekstowa była zbyt duża dla bufora wyjściowego, a punkt końcowy nie obsługuje częściowych wiadomości” po uruchomieniu kodu przez około minutę
firstpostcommenter
Upewnij się, że importujesz plik org.java-websocket.
Albert Hendriks,
9
Ten kod kończy się niepowodzeniem z powodu błędu: nie można znaleźć klasy implementacji.
Kirk Sefchik,
2
@deathgaze javax.websocket api to tylko specyfikacja, która nie ma pełnej implementacji, może być konieczne pobranie pliku jar tyrus-standalone-client-1.9.jar i wypróbowanie tego samego przykładu, który powinien rozwiązać twój problem. Testowałem na moim przykładzie i działa dobrze. mam nadzieję, że to ci pomoże.
SRK
@Martin Jak mogę wysłać wiadomość na Open. Przykład: muszę wysłać '{"type": "subscribe", "symbol": "AAPL"}' po otwarciu websocket, aby zasubskrybować.
Buddhika
40

TooTallNate ma prostą stronę klienta https://github.com/TooTallNate/Java-WebSocket

Po prostu dodaj java_websocket.jar w folderze dist do swojego projektu.

 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);

// i zamknąć websocket

 mWs.close();
TCassells
źródło
4
Działał w Windows 7, Windows 8 i OS X Mountain Lion przy użyciu Eclipse, serwerem był Ubuntu.
TCassells
1
dlaczego miałbyś wybrać tę bibliotekę zamiast javax?
BvuRVKyUVlViVIc7
2
bo to oczywiście prostsze
Kyle Luke
4
jakie zmiany są potrzebne do obsługi protokołu wss (zabezpieczonego ws)?
Mihailo Stupar
2
Świetna biblioteka, ale ma problemy z wss. Projekt ma kilka otwartych kwestii, a deweloper komentuje, że nie ma już czasu.
SiKing
18

Spójrz na przykłady Java EE 7 od Arun Gupta.

Rozwidliłem to na githubie .

Główny

/**
 * @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();
    }
}
Koekiebox
źródło
Należy wspomnieć, że wymaga to zależności od gniazda sieciowego dostarczonej osobno
główna Java
1

Użyj tej biblioteki org.java_websocket

Najpierw należy zaimportować tę bibliotekę do pliku build.gradle

repositories {
 mavenCentral()
 }

następnie dodaj implementację w zależności {}

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

Następnie możesz użyć tego kodu

W swojej aktywności zadeklaruj obiekt dla Websocketclient jak

private WebSocketClient mWebSocketClient;

następnie dodaj tę metodę do wywołania zwrotnego

 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();

}

Muhammed Fasil
źródło
-2

Mam w swoim projekcie Spring 4.2 i wiele implementacji SockJS Stomp zazwyczaj dobrze działa z implementacjami Spring Boot. Ta implementacja z Baeldung działała (dla mnie bez zmiany z wiosny 4.2 na 5). Po użyciu zależności wspomnianych na jego blogu nadal otrzymałem ClassNotFoundError. Dodałem poniższą zależność, aby to naprawić.

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-core</artifactId>
        <version>4.2.3.RELEASE</version>
    </dependency>
veritas
źródło