spring - SockJS Python Client

Question

I have a website (Java + Spring) that relies on Websockets (Stomp over Websockets for Spring + RabbitMQ + SockJS) for some functionality.

We are creating a command line interface based in Python and we would like to add some of the functionality which is already available using websockets.

Does anyone knows how to use a python client so I can connect using the SockJS protocol ?

PS_ I am aware of a simple library which I did not tested but it does not have the capability to subscribe to a topic

PS2_ As I can connect directly to a STOMP at RabbitMQ from python and subscribe to a topic but exposing RabbitMQ directly does not feel right. Any comments around for second option ?

@Jeef we could not find a good solution, so we had to emulate the functionality over an additional API. — Tk421
@Tk421 We are stuck with the same problem of connecting a python client to SockJS + Spring. We were trying to use websocket lib in python . For Example ws = websocket.WebSocketApp("ws://localhost:8080/socket_name/topic_name/1/websocket", . We were able to connect to the websocket but not receive the messages sent to the topic. Do we need to add any custom Handshake handler in the spring to achieve this? — Raja Vikram
@RajaVikram I posted a working example as an answer of what I did to use websockets and Stomp with a Python client talking to a Spring websockets server. Hope it helps. — Michael

Michael Michael · Accepted Answer · 2018-08-11T19:29:00

The solution I used was to not use the SockJS protocol and instead do "plain ol' web sockets" and used the websockets package in Python and sending Stomp messages over it using the stomper package. The stomper package just generates strings that are "messages" and you just send those messages over websockets using ws.send(message)

Spring Websockets config on the server:

@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        registry.addEndpoint("/my-ws-app"); // Note we aren't doing .withSockJS() here
    }

}

And on the Python client side of code:

import stomper
from websocket import create_connection
ws = create_connection("ws://theservername/my-ws-app")
v = str(random.randint(0, 1000))
sub = stomper.subscribe("/something-to-subscribe-to", v, ack='auto')
ws.send(sub)
while not True:
    d = ws.recv()
    m = MSG(d)

Now d will be a Stomp formatted message, which has a pretty simple format. MSG is a quick and dirty class I wrote to parse it.

class MSG(object):
    def __init__(self, msg):
        self.msg = msg
        sp = self.msg.split("\n")
        self.destination = sp[1].split(":")[1]
        self.content = sp[2].split(":")[1]
        self.subs = sp[3].split(":")[1]
        self.id = sp[4].split(":")[1]
        self.len = sp[5].split(":")[1]
        # sp[6] is just a \n
        self.message = ''.join(sp[7:])[0:-1]  # take the last part of the message minus the last character which is \00

This isn't the most complete solution. There isn't an unsubscribe and the id for the Stomp subscription is randomly generated and not "remembered." But, the stomper library provides you the ability to create unsubscribe messages.

Anything on the server side that is sent to /something-to-subscribe-to will be received by all the Python clients subscribed to it.

@Controller
public class SomeController {

    @Autowired
    private SimpMessagingTemplate template;

    @Scheduled(fixedDelayString = "1000")
    public void blastToClientsHostReport(){
            template.convertAndSend("/something-to-subscribe-to", "hello world");
        }
    }

}

spring - SockJS Python Client

2 Answers