Skip to content

Commit a62a7d1

Browse files
artembilangaryrussell
artembilan
and
garyrussell
authored
INT-3045: Add in & out ZeroMq channel adapters (#3388)
* INT-3045: Add in & out ZeroMq channel adapters JIRA: https://jira.spring.io/browse/INT-3045 * Add `ZeroMqMessageHandler` to produce messages into one-way ZeroMq sockets * Add `ZeroMqMessageProducer` to consumer messages from one-way ZeroMq sockets * Add `ConvertingBytesMessageMapper` impl for the `BytesMessageMapper` to delegate an actual conversion into the provided `MessageConverter` * Add `ZeroMqHeaders` for message headers constants representing ZeroMq message attributes * Fix `ZeroMqChannel` for the proper deferred `zeroMqProxy` evaluation * Add more JavaDocs * Fix `ZeroMqChannelTests.testPubSubBind()` to be sure that really all the subscribed channels get the same message from the `PUB` socket * * Fix typo in the `ConvertingBytesMessageMapper` * Add `this` for `doOnError()` in the `ZeroMqChannel` & `ZeroMqMessageProducer` * Change the bind logic in the `ZeroMqMessageProducer` to `port` and let it to bind to random port. The actual port is available later via `getBoundPort()` * Introduce a `ZeroMqMessageProducer.receiveRaw()` to let received `ZMsg` to be produce as a `payload` * Add a logic into `ZeroMqMessageHandler` to treat `ZMsg` in the payload of request message as is without any conversion * Fix race condition in the `ZeroMqMessageProducer` to destroy `consumerScheduler` when the main `Flux` is complete * * Add Java DSL for ZeroMq components * Extract `ReactiveMessageHandlerSpec` for `ReactiveMessageHandler` impls * Add debug message into `EmbeddedJsonHeadersMessageMapper` when cannot `decodeNativeFormat()` * Make `ReactiveMongoDbMessageHandlerSpec` extending `ReactiveMessageHandlerSpec` * Make `ZeroMqProxy` `autoStartup` by default * Add `ZeroMqDslTests` to cover all the Java DSL for ZeroMq * Introduce a `MimeTypeSerializer` to serialize a `MimeType` into JSON as a plain string; use it as extra serializer in the `JacksonJsonUtils.messagingAwareMapper()` * Fix typo for the `AllowListTypeResolverBuilder` inner class * * Add some docs * Fix Checkstyle violations * * More docs * Fix language in Docs Co-authored-by: Gary Russell <[email protected]> Co-authored-by: Gary Russell <[email protected]>
1 parent 9d34cfd commit a62a7d1

File tree

24 files changed

+1864
-53
lines changed

24 files changed

+1864
-53
lines changed

‎spring-integration-core/src/main/java/org/springframework/integration/dsl/ReactiveMessageHandlerSpec.java‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* Copyright 2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.integration.dsl;
18+
19+
import java.util.Collections;
20+
import java.util.Map;
21+
22+
import org.springframework.integration.handler.ReactiveMessageHandlerAdapter;
23+
import org.springframework.messaging.ReactiveMessageHandler;
24+
25+
/**
26+
* The {@link MessageHandlerSpec} extension for {@link ReactiveMessageHandler}.
27+
*
28+
* @author Artem Bilan
29+
*
30+
* @since 5.4
31+
*/
32+
public abstract class ReactiveMessageHandlerSpec<S extends ReactiveMessageHandlerSpec<S, H>, H extends ReactiveMessageHandler>
33+
extends MessageHandlerSpec<S, ReactiveMessageHandlerAdapter>
34+
implements ComponentsRegistration {
35+
36+
protected final H reactiveMessageHandler; // NOSONAR - final
37+
38+
protected ReactiveMessageHandlerSpec(H reactiveMessageHandler) {
39+
this.reactiveMessageHandler = reactiveMessageHandler;
40+
this.target = new ReactiveMessageHandlerAdapter(this.reactiveMessageHandler);
41+
}
42+
43+
@Override
44+
public Map<Object, String> getComponentsToRegister() {
45+
return Collections.singletonMap(this.reactiveMessageHandler, null);
46+
}
47+
48+
}

‎spring-integration-core/src/main/java/org/springframework/integration/mapping/ConvertingBytesMessageMapper.java‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/*
2+
* Copyright 2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.integration.mapping;
18+
19+
import java.nio.charset.StandardCharsets;
20+
import java.util.Arrays;
21+
import java.util.Map;
22+
23+
import org.springframework.lang.NonNull;
24+
import org.springframework.lang.Nullable;
25+
import org.springframework.messaging.Message;
26+
import org.springframework.messaging.MessageHeaders;
27+
import org.springframework.messaging.converter.MessageConverter;
28+
import org.springframework.util.Assert;
29+
30+
/**
31+
* The {@link BytesMessageMapper} implementation to delegate to/from {@link Message}
32+
* conversion into the provided {@link MessageConverter}.
33+
* <p>
34+
* The {@link MessageConverter} must not return {@code null} from its
35+
* {@link MessageConverter#fromMessage(Message, Class)} and {@link MessageConverter#toMessage(Object, MessageHeaders)}
36+
* methods.
37+
* <p>
38+
* If {@link MessageConverter#fromMessage(Message, Class)} returns {@link String}, it is converted to {@link byte[]}
39+
* using a {@link StandardCharsets#UTF_8} encoding.
40+
*
41+
* @author Artem Bilan
42+
*
43+
* @since 5.4
44+
*/
45+
public class ConvertingBytesMessageMapper implements BytesMessageMapper {
46+
47+
private final MessageConverter messageConverter;
48+
49+
public ConvertingBytesMessageMapper(MessageConverter messageConverter) {
50+
Assert.notNull(messageConverter, "'messageConverter' must not be null");
51+
this.messageConverter = messageConverter;
52+
}
53+
54+
@Override
55+
@NonNull
56+
public Message<?> toMessage(byte[] bytes, @Nullable Map<String, Object> headers) {
57+
MessageHeaders messageHeaders = null;
58+
if (headers != null) {
59+
messageHeaders = new MessageHeaders(headers);
60+
}
61+
Message<?> message = this.messageConverter.toMessage(bytes, messageHeaders);
62+
Assert.state(message != null, () ->
63+
"the '" + this.messageConverter + "' produced null for bytes:" + Arrays.toString(bytes));
64+
return message;
65+
}
66+
67+
@Override
68+
@NonNull
69+
public byte[] fromMessage(Message<?> message) {
70+
Object result = this.messageConverter.fromMessage(message, byte[].class);
71+
Assert.state(result != null, () -> "the '" + this.messageConverter + "' produced null for message: " + message);
72+
return result instanceof String
73+
? ((String) result).getBytes(StandardCharsets.UTF_8)
74+
: (byte[]) result;
75+
}
76+
77+
}

‎spring-integration-core/src/main/java/org/springframework/integration/support/json/EmbeddedJsonHeadersMessageMapper.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -224,16 +224,14 @@ public Message<?> toMessage(byte[] bytes, @Nullable Map<String, Object> headers)
224224
message = decodeNativeFormat(bytes, headers);
225225
}
226226
catch (@SuppressWarnings("unused") Exception e) {
227-
// empty
227+
this.logger.debug("Failed to decode native format", e);
228228
}
229229
if (message == null) {
230230
try {
231231
message = (Message<?>) this.objectMapper.readValue(bytes, Object.class);
232232
}
233233
catch (Exception e) {
234-
if (this.logger.isDebugEnabled()) {
235-
this.logger.debug("Failed to decode JSON", e);
236-
}
234+
this.logger.debug("Failed to decode JSON", e);
237235
}
238236
}
239237
if (message != null) {

‎spring-integration-core/src/main/java/org/springframework/integration/support/json/JacksonJsonUtils.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public static ObjectMapper messagingAwareMapper(String... trustedPackages) {
6767
if (JacksonPresent.isJackson2Present()) {
6868
ObjectMapper mapper = new Jackson2JsonObjectMapper().getObjectMapper();
6969

70-
mapper.setDefaultTyping(new AllowlistTypeResolverBuilder(trustedPackages));
70+
mapper.setDefaultTyping(new AllowListTypeResolverBuilder(trustedPackages));
7171

7272
GenericMessageJacksonDeserializer genericMessageDeserializer = new GenericMessageJacksonDeserializer();
7373
genericMessageDeserializer.setMapper(mapper);
@@ -83,6 +83,7 @@ public static ObjectMapper messagingAwareMapper(String... trustedPackages) {
8383

8484
SimpleModule simpleModule = new SimpleModule()
8585
.addSerializer(new MessageHeadersJacksonSerializer())
86+
.addSerializer(new MimeTypeSerializer())
8687
.addDeserializer(GenericMessage.class, genericMessageDeserializer)
8788
.addDeserializer(ErrorMessage.class, errorMessageDeserializer)
8889
.addDeserializer(AdviceMessage.class, adviceMessageDeserializer)
@@ -107,13 +108,13 @@ public static ObjectMapper messagingAwareMapper(String... trustedPackages) {
107108
*
108109
* @since 4.3.11
109110
*/
110-
private static final class AllowlistTypeResolverBuilder extends ObjectMapper.DefaultTypeResolverBuilder {
111+
private static final class AllowListTypeResolverBuilder extends ObjectMapper.DefaultTypeResolverBuilder {
111112

112113
private static final long serialVersionUID = 1L;
113114

114115
private final String[] trustedPackages;
115116

116-
AllowlistTypeResolverBuilder(String... trustedPackages) {
117+
AllowListTypeResolverBuilder(String... trustedPackages) {
117118
super(ObjectMapper.DefaultTyping.NON_FINAL,
118119
//we do explicit validation in the TypeIdResolver
119120
BasicPolymorphicTypeValidator.builder()

‎spring-integration-core/src/main/java/org/springframework/integration/support/json/MimeTypeSerializer.java‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
* Copyright 2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.integration.support.json;
18+
19+
import java.io.IOException;
20+
21+
import org.springframework.util.MimeType;
22+
23+
import com.fasterxml.jackson.core.JsonGenerator;
24+
import com.fasterxml.jackson.databind.JsonSerializer;
25+
import com.fasterxml.jackson.databind.SerializerProvider;
26+
import com.fasterxml.jackson.databind.jsontype.TypeSerializer;
27+
import com.fasterxml.jackson.databind.ser.std.StdSerializer;
28+
29+
/**
30+
* Simple {@link JsonSerializer} extension to represent a {@link MimeType} object in the
31+
* target JSON as a plain string.
32+
*
33+
* @author Artem Bilan
34+
*
35+
* @since 5.4
36+
*/
37+
public class MimeTypeSerializer extends StdSerializer<MimeType> {
38+
39+
private static final long serialVersionUID = 1L;
40+
41+
public MimeTypeSerializer() {
42+
super(MimeType.class);
43+
}
44+
45+
@Override
46+
public void serializeWithType(MimeType value, JsonGenerator generator, SerializerProvider serializers,
47+
TypeSerializer typeSer) throws IOException {
48+
49+
serialize(value, generator, serializers);
50+
}
51+
52+
@Override
53+
public void serialize(MimeType value, JsonGenerator generator, SerializerProvider provider) throws IOException {
54+
generator.writeString(value.toString());
55+
}
56+
57+
}

‎spring-integration-mongodb/src/main/java/org/springframework/integration/mongodb/dsl/ReactiveMongoDbMessageHandlerSpec.java‎

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616

1717
package org.springframework.integration.mongodb.dsl;
1818

19-
import java.util.Collections;
20-
import java.util.Map;
2119
import java.util.function.Function;
2220

2321
import org.springframework.data.mongodb.ReactiveMongoDatabaseFactory;
@@ -27,8 +25,8 @@
2725
import org.springframework.expression.common.LiteralExpression;
2826
import org.springframework.integration.dsl.ComponentsRegistration;
2927
import org.springframework.integration.dsl.MessageHandlerSpec;
28+
import org.springframework.integration.dsl.ReactiveMessageHandlerSpec;
3029
import org.springframework.integration.expression.FunctionExpression;
31-
import org.springframework.integration.handler.ReactiveMessageHandlerAdapter;
3230
import org.springframework.integration.mongodb.outbound.ReactiveMongoDbStoringMessageHandler;
3331
import org.springframework.messaging.Message;
3432

@@ -41,22 +39,15 @@
4139
* @since 5.3
4240
*/
4341
public class ReactiveMongoDbMessageHandlerSpec
44-
extends MessageHandlerSpec<ReactiveMongoDbMessageHandlerSpec, ReactiveMessageHandlerAdapter>
42+
extends ReactiveMessageHandlerSpec<ReactiveMongoDbMessageHandlerSpec, ReactiveMongoDbStoringMessageHandler>
4543
implements ComponentsRegistration {
4644

47-
protected final ReactiveMongoDbStoringMessageHandler messageHandler; // NOSONAR - final
48-
4945
protected ReactiveMongoDbMessageHandlerSpec(ReactiveMongoDatabaseFactory mongoDbFactory) {
50-
this(new ReactiveMongoDbStoringMessageHandler(mongoDbFactory));
46+
super(new ReactiveMongoDbStoringMessageHandler(mongoDbFactory));
5147
}
5248

5349
protected ReactiveMongoDbMessageHandlerSpec(ReactiveMongoOperations reactiveMongoOperations) {
54-
this(new ReactiveMongoDbStoringMessageHandler(reactiveMongoOperations));
55-
}
56-
57-
private ReactiveMongoDbMessageHandlerSpec(ReactiveMongoDbStoringMessageHandler messageHandler) {
58-
this.messageHandler = messageHandler;
59-
this.target = new ReactiveMessageHandlerAdapter(this.messageHandler);
50+
super(new ReactiveMongoDbStoringMessageHandler(reactiveMongoOperations));
6051
}
6152

6253
/**
@@ -65,7 +56,7 @@ private ReactiveMongoDbMessageHandlerSpec(ReactiveMongoDbStoringMessageHandler m
6556
* @return the spec
6657
*/
6758
public ReactiveMongoDbMessageHandlerSpec mongoConverter(MongoConverter mongoConverter) {
68-
this.messageHandler.setMongoConverter(mongoConverter);
59+
this.reactiveMessageHandler.setMongoConverter(mongoConverter);
6960
return this;
7061
}
7162

@@ -96,13 +87,8 @@ public <P> ReactiveMongoDbMessageHandlerSpec collectionNameFunction(
9687
* @return the spec
9788
*/
9889
public ReactiveMongoDbMessageHandlerSpec collectionNameExpression(Expression collectionNameExpression) {
99-
this.messageHandler.setCollectionNameExpression(collectionNameExpression);
90+
this.reactiveMessageHandler.setCollectionNameExpression(collectionNameExpression);
10091
return this;
10192
}
10293

103-
@Override
104-
public Map<Object, String> getComponentsToRegister() {
105-
return Collections.singletonMap(this.messageHandler, null);
106-
}
107-
10894
}

‎spring-integration-zeromq/src/main/java/org/springframework/integration/zeromq/ZeroMqHeaders.java‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright 2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.integration.zeromq;
18+
19+
/**
20+
* The message headers constants to repsent ZeroMq message attributes.
21+
*
22+
* @author Artem Bilan
23+
*
24+
* @since 5.4
25+
*/
26+
public final class ZeroMqHeaders {
27+
28+
public static final String PREFIX = "zeromq_";
29+
30+
/**
31+
* A ZeroMq pub/sub message topic header.
32+
*/
33+
public static final String TOPIC = PREFIX + "topic";
34+
35+
private ZeroMqHeaders() {
36+
}
37+
38+
}

‎spring-integration-zeromq/src/main/java/org/springframework/integration/zeromq/ZeroMqProxy.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public class ZeroMqProxy implements InitializingBean, SmartLifecycle, BeanNameAw
9797

9898
private String beanName;
9999

100-
private boolean autoStartup;
100+
private boolean autoStartup = true;
101101

102102
private int phase;
103103

0 commit comments

Comments
 (0)