Spring integration: Splitter

The splitter is a component, whose role is to partition a message into several parts and send the resulting messages to be processed independently.

 

In brief, a splitter

a.   Receive the message from input channel

b.   Split the message into multiple messages

c.    Send each of the messages to output channel.

 

 

You can define a splitter using @Splitter annotation.

 

Example

@Splitter(inputChannel = "inputChannel", outputChannel = "outputChannel")
List<Message<String>> splitMessage(Message<?> message) {

	List<Message<String>> messages = new ArrayList<>();

	String[] msgSplits = message.getPayload().toString().split(",");

	for (String split : msgSplits) {
		Message<String> msg = MessageBuilder.withPayload(split).build();
		messages.add(msg);
	}

	return messages;
}

 

Find the below working application.

 

Step 1: Create new maven project ‘splitter-demo’.

 

Step 2: Update pom.xml with maven dependencies.

 

pom.xml

 

<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.sample.app</groupId>
	<artifactId>splitter-demo</artifactId>
	<version>1</version>

	<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-parent -->
	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.4.0</version>
	</parent>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-integration</artifactId>
		</dependency>

	</dependencies>

</project>

 

Step 3: Define gateway.

 

CustomGateway.java

package com.sample.app.gateway;

import org.springframework.integration.annotation.Gateway;
import org.springframework.integration.annotation.MessagingGateway;
import org.springframework.messaging.Message;

@MessagingGateway
public interface CustomGateway {

	@Gateway(requestChannel = "inputChannel")
	public void print(Message<String> message);

}

 

Step 4: Define consumer endpoint.

 

ConsumerEndpoint.java

package com.sample.app.endpoints;

import org.springframework.integration.annotation.ServiceActivator;
import org.springframework.messaging.Message;
import org.springframework.stereotype.Component;

@Component
public class ConsumerEndpoint {

	@ServiceActivator(inputChannel = "outputChannel")
	public void consumeStringMessage(Message<String> message) {
		System.out.println("Received message from outputChannel : " + message.getPayload());
	}
}

Step 5: Define main application class.

 

App.java

package com.sample.app;

import java.util.ArrayList;
import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.integration.annotation.Splitter;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.messaging.Message;

import com.sample.app.gateway.CustomGateway;

@SpringBootApplication
@Configuration
public class App {

	@Splitter(inputChannel = "inputChannel", outputChannel = "outputChannel")
	List<Message<String>> splitMessage(Message<?> message) {

		List<Message<String>> messages = new ArrayList<>();

		String[] msgSplits = message.getPayload().toString().split(",");

		for (String split : msgSplits) {
			Message<String> msg = MessageBuilder.withPayload(split).build();
			messages.add(msg);
		}

		return messages;
	}

	@Autowired
	private CustomGateway customGateway;

	public static void main(String[] args) {
		SpringApplication.run(App.class, args);
	}

	@Bean
	public CommandLineRunner demo() {
		return (args) -> {

			Message<String> msg = MessageBuilder.withPayload("Cricket,Football,Tennis").build();

			customGateway.print(msg);
		};

	};

}

Total project structure looks like below.

Run App.java, you will see below messages in console.

 

Received message from outputChannel : Cricket
Received message from outputChannel : Football
Received message from outputChannel : Tennis

 

You can download complete working application from below link.

https://github.com/harikrishna553/springboot/tree/master/spring-integration/splitter-demo

 

  

Previous                                                    Next                                                    Home