Простой пример клиента javax.websocket

104

Может ли кто-нибудь предоставить мне очень простой пример использования клиента websocket javax.websocket?

Я хочу подключиться к websocket (ws: //socket.example.com: 1234), отправить сообщение (добавить канал) и прослушать сообщения. Все сообщения (отправленные и прослушанные) находятся в формате JSON.

И, кстати, эта библиотека лучше всего подходит для простой связи через веб-сокеты?

Мартин
источник

Ответы:

121

Я нашел здесь отличный пример 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 должен принимать сообщения одно за другим? Я получаю сообщение об ошибке «Декодированное текстовое сообщение слишком велико для выходного буфера, а конечная точка не поддерживает частичные сообщения» после запуска кода в течение примерно минуты
firstpostcommenter 01
Обязательно maven-import org.java-websocket.
Альберт Хендрикс,
9
Этот код не работает с ошибкой: не удалось найти класс реализации.
Кирк Сефчик 05
2
@deathgaze javax.websocket api - это только спецификация, не имеющая полной реализации, вам может потребоваться взять файл jar tyrus-standalone-client-1.9.jar и попробовать тот же пример, который должен решить вашу проблему. Я тестировал свой пример, и он работает нормально. Надеюсь, что это поможет вам.
SRK
@Martin Как я могу отправить сообщение на Open. Пример: мне нужно отправить '{"type": "subscribe", "symbol": "AAPL"}' при открытии веб-сокета для подписки.
Buddhika
40

TooTallNate имеет простую клиентскую часть https://github.com/TooTallNate/Java-WebSocket

Просто добавьте java_websocket.jar в папку dist в свой проект.

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

// и закрыть веб-сокет

 mWs.close();
TCassells
источник
4
Работал в Windows 7, Windows 8 и OS X mountain lion с использованием eclipse, сервер был Ubuntu.
TCassells
1
почему бы вам выбрать эту библиотеку вместо javax?
BvuRVKyUVlViVIc7
2
потому что это очевидно проще
Кайл Люк
4
какие изменения необходимы для поддержки протокола wss (защищенный протокол ws)?
Stupar
2
Отличная библиотека, но есть проблемы с wss. В проекте есть несколько нерешенных вопросов, и на комментарии разработчика у него больше нет времени.
SiKing
18

Взгляните на эти примеры Java EE 7 от Аруна Гупты.

Раздвоил на гитхабе .

Основной

/**
 * @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
источник
Вы должны упомянуть, что для этого требуется, чтобы зависимость от веб-сокета поставлялась отдельно
Java Main
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>
Veritas
источник