{"id":398,"date":"2011-04-27T20:42:00","date_gmt":"2011-04-27T20:42:00","guid":{"rendered":"http:\/\/www.javacodegeeks.com\/2012\/10\/rabbitmq-module-for-play-framework.html"},"modified":"2012-10-21T19:41:57","modified_gmt":"2012-10-21T19:41:57","slug":"rabbitmq-module-play-framework","status":"publish","type":"post","link":"https:\/\/www.javacodegeeks.com\/2011\/04\/rabbitmq-module-play-framework.html","title":{"rendered":"RabbitMQ Module for Play! Framework"},"content":{"rendered":"
RabbitMQ offers a highly available, scalable and portable messaging system with predictable and consistent throughput and latency. RabbitMQ is the leading implementation of AMQP<\/a>, the open standard for business messaging, and, through adapters<\/a>, supports XMPP, SMTP, STOMP and HTTP for lightweight web messaging.<\/p>\n

This new module allows you to consume and produce messages on a RabbitMQ instance from your Play! Framework application.<\/p>\n

Installation<\/strong><\/p>\n

play install rabbitmq\r\n<\/pre>\n
Configuration<\/strong><\/p>\n
module.rabbitmq=${play.path}\/modules\/rabbitmq-0.0.1\r\nrabbitmq.host=localhost\r\nrabbitmq.port=5672\r\nrabbitmq.userName=guest\r\nrabbitmq.password=guest\r\nrabbitmq.vhost=\/\r\nrabbitmq.exchangeType=direct\r\nrabbitmq.durable=true\r\nrabbitmq.autoAck=false\r\nrabbitmq.basicQos=true\r\n<\/pre>\n
Define Message that will be used by the Queue (just a simple POJO)<\/strong><\/p>\n
public class SampleMessage implements Serializable {\r\n\r\n    \/** The field1. *\/\r\n    private String field1;\r\n\r\n    \/** The field2. *\/\r\n    private String field2;\r\n\r\n    \/**\r\n     * Instantiates a new sample message.\r\n     *\/\r\n    public SampleMessage() {\r\n\r\n    }\r\n\r\n    \/**\r\n     * Instantiates a new sample message.\r\n     *\r\n     * @param field1 the field1\r\n     * @param field2 the field2\r\n     *\/\r\n    public SampleMessage(String field1, String field2) {\r\n        super();\r\n        this.field1 = field1;\r\n        this.field2 = field2;\r\n    }\r\n\r\n    \/**\r\n     * Gets the field1.\r\n     *\r\n     * @return the field1\r\n     *\/\r\n    public String getField1() {\r\n        return field1;\r\n    }\r\n\r\n    \/**\r\n     * Sets the field1.\r\n     *\r\n     * @param field1 the new field1\r\n     *\/\r\n    public void setField1(String field1) {\r\n        this.field1 = field1;\r\n    }\r\n\r\n    \/**\r\n     * Gets the field2.\r\n     *\r\n     * @return the field2\r\n     *\/\r\n    public String getField2() {\r\n        return field2;\r\n    }\r\n\r\n    \/**\r\n     * Sets the field2.\r\n     *\r\n     * @param field2 the new field2\r\n     *\/\r\n    public void setField2(String field2) {\r\n        this.field2 = field2;\r\n    }\r\n\r\n    \/**\r\n     * To String\r\n     *\r\n     * @see java.lang.Object#toString()\r\n     *\/\r\n    @Override\r\n    public String toString() {\r\n        return \"SampleMessage [field1=\" + field1 + \", field2=\" + field2 + \"]\";\r\n    }\r\n}\r\n<\/pre>\n
Publish a Message<\/strong>
 
<\/div> <\/div><\/p>\n
public static void publish(String q) {\r\n     RabbitMQPublisher.publish(\"myQueue\", new SampleMessage(q, q));\r\n     render(q);\r\n    }\r\n<\/pre>\n
Creating a Message Consumer<\/strong><\/p>\n
@OnApplicationStart(async=true)\r\npublic class RabbitMQSampleConsumer extends RabbitMQConsumer {\r\n\r\n    \/**\r\n     * Consume Message\r\n     *\r\n     * @see play.modules.rabbitmq.consumer.RabbitMQConsumer#consume(T)\r\n     *\/\r\n    @Override\r\n    protected void consume(SampleMessage message) {\r\n        System.out.println(\"******************************\");\r\n        System.out.println(\"* Message Consumed: \" + message);\r\n        System.out.println(\"******************************\");\r\n    }\r\n\r\n    \/**\r\n     * Name of the Queue that this consumer will be listening to.\r\n     *\r\n     * @return the string\r\n     * @see play.modules.rabbitmq.consumer.RabbitMQConsumer#queue()\r\n     *\/\r\n    @Override\r\n    protected String queue() {\r\n        return \"myQueue\";\r\n    }\r\n\r\n    \/**\r\n     * Return message type.\r\n     *\r\n     * @return the message type\r\n     * @see play.modules.rabbitmq.consumer.RabbitMQConsumer#getMessageType()\r\n     *\/\r\n    protected Class getMessageType() {\r\n        return SampleMessage.class;\r\n    }\r\n}\r\n<\/pre>\n
* Please note this is a Play! job so you can start it manualy or you can use the other annotations provided by Play! like @On or @Every. More information available at Asynchronous Jobs documentation<\/a>.<\/p>\n
Firehose \u2013 Another way to publish messages in batch<\/strong><\/p>\n
@OnApplicationStart(async = true)\r\npublic class RabbitMQSampleFirehose extends RabbitMQFirehose {\r\n\r\n    \/** The count. *\/\r\n    public int count = 0;\r\n\r\n    \/**\r\n     * Get data to be loaded.\r\n     *\r\n     * @param n the n\r\n     * @return the data\r\n     * @throws Exception the exception\r\n     * @see play.modules.rabbitmq.producer.RabbitMQFirehose#getData(int)\r\n     *\/\r\n    @Override\r\n    protected List getData(int n) throws Exception {\r\n        if ( count >= 10 ) {\r\n            return null;\r\n        }\r\n        List results = new ArrayList();\r\n        for (int i = 0; i < n; i++) {\r\n            results.add(new SampleMessage(\"field1\", \"field2\"));\r\n            count++;\r\n        }\r\n        return results;\r\n    }\r\n\r\n    \/**\r\n     * Batch Size - How many records we will select at the time?.\r\n     *\r\n     * @return the int\r\n     * @see play.modules.rabbitmq.producer.RabbitMQFirehose#batchSize()\r\n     *\/\r\n    @Override\r\n    protected int batchSize() {\r\n        return 2;\r\n    }\r\n\r\n    \/**\r\n     * Queue Name.\r\n     *\r\n     * @return the string\r\n     * @see play.modules.rabbitmq.producer.RabbitMQFirehose#queueName()\r\n     *\/\r\n    @Override\r\n    protected String queueName() {\r\n        return \"myQueue\";\r\n    }\r\n\r\n}\r\n<\/pre>\n
* Please note this is a Play! job so you can start it manualy or you can use the other annotations provided by Play! like @On or @Every. More information available at Asynchronous Jobs documentation<\/a>.  Of course the code is available on Github<\/a>.<\/p>\n
Now Go Play!<\/a><\/p>\n
Reference :<\/i><\/strong> RabbitMQ Module for Play! Framework<\/a> from our JCG partner<\/a> Felipe Oliveira<\/a> at Geeks Are Totally In<\/a>.<\/p>\n
Related Articles:<\/strong><\/p>\n