Search code examples
springspring-annotationsspring-jms

Spring 4.1 @JmsListener configuration


I would like to use the new annotations and features provided in Spring 4.1 for an application that needs a JMS listener.

I've carefully read the notes in the Spring 4.1 JMS improvements post but I continue to miss the relationship between @JmsListener and maybe the DestinationResolver and how I would setup the application to indicate the proper Destination or Endpoint.

Here is the suggested use of @JmsListener

@Component
public class MyService {

    @JmsListener(containerFactory = "myContainerFactory", destination = "myQueue")
    public void processOrder(String data) { ... }
}

Now, I can't use this in my actual code because the "myQueue" needs to be read from a configuration file using Environment.getProperty().

I can setup an appropriate myContainerFactory with a DestinationResolver but mostly, it seems you would just use DynamicDestinationResolver if you don't need JNDI to lookup a queue in an app server and didn't need to do some custom reply logic. I'm simply trying to understand how Spring wants me to indicate the name of the queue in a parameterized fashion using the @JmsListener annotation.

Further down the blog post, I find a reference to this Configurer:

@Configuration
@EnableJms
public class AppConfig implements JmsListenerConfigurer {

@Override
public void configureJmsListeners(JmsListenerEndpointRegistrar registrar) {
    registrar.setDefaultContainerFactory(defaultContainerFactory());

    SimpleJmsListenerEndpoint endpoint = new SimpleJmsListenerEndpoint();
    endpoint.setDestination("anotherQueue");
    endpoint.setMessageListener(message -> {
        // processing
    });
    registrar.registerEndpoint(endpoint);
}

Now, this makes some amount of sense and I could see where this would allow me to set a Destination at runtime from some external string, but this seems to be in conflict with using @JmsListener as it appears to be overriding the annotation in favor of endpoint.setMessageListener in the code above.

Any tips on how to specify the appropriate queue name using @JmsListener?


Solution

  • You could eventually do that right now but it's a bit convoluted. You can set a custom JmsListenerEndpointRegistry using JmsListenerConfigurer

    @Configuration
    @EnableJms
    public class AppConfig implements JmsListenerConfigurer {
    
        @Override
        public void configureJmsListeners(JmsListenerEndpointRegistrar registrar) {
            registrar.setEndpointRegistry(customRegistry());
        }
    
    }
    

    and then override the registerListenerContainer method, something like

    public void registerListenerContainer(JmsListenerEndpoint endpoint, JmsListenerContainerFactory<?> factory) {
        // resolve destination according to whatever -> resolvedDestination
        ((AbstractJmsListenerEndpoint)endpoint).setDestination(resolvedDestination);
        super.registerListenerContainer(endpoint, factory);
    }
    

    But we could do better. Please watch/vote for SPR-12280