STOMP protocol via WebSocket for Android
Overview
This library provide support for STOMP protocol https://stomp.github.io/ At now library works only as client for backend with support STOMP, such as NodeJS (stompjs or other) or Spring Boot (SockJS).
Add library as gradle dependency
repositories {
jcenter()
maven { url "https://jitpack.io" }
}
dependencies {
implementation 'com.github.NaikSoftware:StompProtocolAndroid:{latest version}'
}Example backend (Spring Boot)
WebSocketConfig.groovy
@Configuration
@EnableWebSocket
@EnableWebSocketMessageBroker
class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
@Override
void configureMessageBroker(MessageBrokerRegistry config) {
config.enableSimpleBroker("/topic", "/queue", "/exchange");
// config.enableStompBrokerRelay("/topic", "/queue", "/exchange"); // Uncomment for external message broker (ActiveMQ, RabbitMQ)
config.setApplicationDestinationPrefixes("/topic", "/queue"); // prefix in client queries
config.setUserDestinationPrefix("/user");
}
@Override
void registerStompEndpoints(StompEndpointRegistry registry) {
registry.addEndpoint("/example-endpoint").withSockJS()
}
}SocketController.groovy
@Slf4j
@RestController
class SocketController {
@MessageMapping('/hello-msg-mapping')
@SendTo('/topic/greetings')
EchoModel echoMessageMapping(String message) {
log.debug("React to hello-msg-mapping")
return new EchoModel(message.trim())
}
}Check out the full example server https://github.com/NaikSoftware/stomp-protocol-example-server
Example library usage
Basic usage
private StompClient mStompClient;
// ...
mStompClient = Stomp.over(Stomp.ConnectionProvider.OKHTTP, "ws://10.0.2.2:8080/example-endpoint/websocket");
mStompClient.connect();
mStompClient.topic("/topic/greetings").subscribe(topicMessage -> {
Log.d(TAG, topicMessage.getPayload());
});
mStompClient.send("/topic/hello-msg-mapping", "My first STOMP message!").subscribe();
// ...
mStompClient.disconnect();See the full example https://github.com/NaikSoftware/StompProtocolAndroid/tree/master/example-client
Method Stomp.over consume class for create connection as first parameter.
You must provide dependency for lib and pass class.
At now supported connection providers:
org.java_websocket.WebSocket.class('org.java-websocket:Java-WebSocket:1.3.0')okhttp3.WebSocket.class('com.squareup.okhttp3:okhttp:3.8.0')
You can add own connection provider. Just implement interface ConnectionProvider.
If you implement new provider, please create pull request :)
Subscribe lifecycle connection
mStompClient.lifecycle().subscribe(lifecycleEvent -> {
switch (lifecycleEvent.getType()) {
case OPENED:
Log.d(TAG, "Stomp connection opened");
break;
case ERROR:
Log.e(TAG, "Error", lifecycleEvent.getException());
break;
case CLOSED:
Log.d(TAG, "Stomp connection closed");
break;
}
});Library support just send & receive messages. ACK messages, transactions not implemented yet.