You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by tk...@apache.org on 2025/06/25 12:57:13 UTC
(ignite-3) branch ignite-25764 created (now 556fcb3a3de)
This is an automated email from the ASF dual-hosted git repository.
tkalkirill pushed a change to branch ignite-25764
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
at 556fcb3a3de IGNITE-25764 wip
This branch includes the following new commits:
new 556fcb3a3de IGNITE-25764 wip
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(ignite-3) 01/01: IGNITE-25764 wip
Posted by tk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
tkalkirill pushed a commit to branch ignite-25764
in repository https://gitbox.apache.org/repos/asf/ignite-3.git
commit 556fcb3a3dee73fccb089ebd3051708dadb2ebde
Author: Kirill Tkalenko <tk...@yandex.ru>
AuthorDate: Wed Jun 25 15:56:56 2025 +0300
IGNITE-25764 wip
---
.../serialization/BaseMethodNameResolver.java | 36 +++++++++++++++++++
.../MessageDeserializerGenerator.java | 7 +++-
.../serialization/MessageReaderMethodResolver.java | 19 +++++-----
.../serialization/MessageSerializerGenerator.java | 10 ++++--
.../serialization/MessageWriterMethodResolver.java | 40 ++++++++++++----------
.../internal/network/annotations/PropertyName.java | 28 +++++++++++++++
6 files changed, 108 insertions(+), 32 deletions(-)
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
index 98612d56eb0..70a0a0b2e02 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/BaseMethodNameResolver.java
@@ -20,11 +20,13 @@ package org.apache.ignite.internal.network.processor.serialization;
import java.nio.ByteBuffer;
import java.util.BitSet;
import java.util.Collection;
+import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import javax.annotation.processing.ProcessingEnvironment;
+import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.PrimitiveType;
@@ -33,6 +35,7 @@ import javax.lang.model.type.TypeMirror;
import org.apache.ignite.internal.hlc.HybridTimestamp;
import org.apache.ignite.internal.lang.IgniteUuid;
import org.apache.ignite.internal.network.NetworkMessage;
+import org.apache.ignite.internal.network.annotations.PropertyName;
import org.apache.ignite.internal.network.processor.ProcessingException;
import org.apache.ignite.internal.network.processor.TypeUtils;
@@ -147,4 +150,37 @@ class BaseMethodNameResolver {
throw new ProcessingException("Unsupported reference type for message (de-)serialization: " + parameterType);
}
+
+ static String propertyName(ExecutableElement getter) {
+ PropertyName propertyNameAnnotation = getter.getAnnotation(PropertyName.class);
+
+ return propertyNameAnnotation == null ? getter.getSimpleName().toString() : propertyNameAnnotation.value();
+ }
+
+ static void checkPropertyNames(List<ExecutableElement> getters) {
+ checkPropertyNamesValue(getters);
+ checkThatPropertyNamesDoNotMatch(getters);
+ }
+
+ private static void checkPropertyNamesValue(List<ExecutableElement> getters) {
+ for (ExecutableElement getter : getters) {
+ String propertyName = propertyName(getter);
+
+ if (propertyName.isBlank()) {
+ throw new ProcessingException("Property name cannot be blank: " + getter);
+ }
+ }
+ }
+
+ private static void checkThatPropertyNamesDoNotMatch(List<ExecutableElement> getters) {
+ var getterByPropertyName = new HashMap<String, ExecutableElement>();
+
+ for (ExecutableElement getter : getters) {
+ ExecutableElement previous = getterByPropertyName.put(propertyName(getter), getter);
+
+ if (previous != null) {
+ throw new ProcessingException(String.format("Property names must not be the same for %s and %s.", getter, previous));
+ }
+ }
+ }
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
index 610fc54de5a..55f9005a7af 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageDeserializerGenerator.java
@@ -19,6 +19,8 @@ package org.apache.ignite.internal.network.processor.serialization;
import static java.util.stream.Collectors.toList;
import static org.apache.ignite.internal.network.processor.MessageGeneratorUtils.addByteArrayPostfix;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.checkPropertyNames;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.propertyName;
import com.squareup.javapoet.ArrayTypeName;
import com.squareup.javapoet.ClassName;
@@ -137,12 +139,15 @@ public class MessageDeserializerGenerator {
.addCode("\n");
if (!getters.isEmpty()) {
+ checkPropertyNames(getters);
+
method.beginControlFlow("switch (reader.state())");
for (int i = 0; i < getters.size(); ++i) {
ExecutableElement getter = getters.get(i);
String getterName = getter.getSimpleName().toString();
+ String propertyName = propertyName(getter);
if (getter.getAnnotation(Marshallable.class) != null) {
getterName = addByteArrayPostfix(getterName);
@@ -155,7 +160,7 @@ public class MessageDeserializerGenerator {
// At the beginning we read the shifted ID, shifted by +1 to efficiently transfer null (since we use "var int").
// If we read garbage then we should not convert to an enumeration, the check below does this.
- method.addStatement("int shiftedId = reader.readInt($S)", getterName);
+ method.addStatement("int shiftedId = reader.readInt($S)", propertyName);
} else {
method.addStatement(readMessageCodeBlock(getter));
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
index 54e27494714..defa2da67a7 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageReaderMethodResolver.java
@@ -18,6 +18,7 @@
package org.apache.ignite.internal.network.processor.serialization;
import static org.apache.ignite.internal.network.processor.MessageGeneratorUtils.addByteArrayPostfix;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.propertyName;
import com.squareup.javapoet.CodeBlock;
import java.util.List;
@@ -59,12 +60,12 @@ class MessageReaderMethodResolver {
CodeBlock resolveReadMethod(ExecutableElement getter) {
TypeMirror parameterType = getter.getReturnType();
- String parameterName = getter.getSimpleName().toString();
+ String propertyName = propertyName(getter);
if (getter.getAnnotation(Marshallable.class) != null) {
- parameterName = addByteArrayPostfix(parameterName);
+ propertyName = addByteArrayPostfix(propertyName);
return CodeBlock.builder()
- .add("readByteArray($S)", parameterName)
+ .add("readByteArray($S)", propertyName)
.build();
}
@@ -72,17 +73,17 @@ class MessageReaderMethodResolver {
switch (methodName) {
case "ObjectArray":
- return resolveReadObjectArray((ArrayType) parameterType, parameterName);
+ return resolveReadObjectArray((ArrayType) parameterType, propertyName);
case "Collection":
- return resolveReadCollection((DeclaredType) parameterType, parameterName);
+ return resolveReadCollection((DeclaredType) parameterType, propertyName);
case "List":
- return resolveReadList((DeclaredType) parameterType, parameterName);
+ return resolveReadList((DeclaredType) parameterType, propertyName);
case "Set":
- return resolveReadSet((DeclaredType) parameterType, parameterName);
+ return resolveReadSet((DeclaredType) parameterType, propertyName);
case "Map":
- return resolveReadMap((DeclaredType) parameterType, parameterName);
+ return resolveReadMap((DeclaredType) parameterType, propertyName);
default:
- return CodeBlock.builder().add("read$L($S)", methodName, parameterName).build();
+ return CodeBlock.builder().add("read$L($S)", methodName, propertyName).build();
}
}
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
index 4d6d12933e9..c2414b887a7 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageSerializerGenerator.java
@@ -18,6 +18,8 @@
package org.apache.ignite.internal.network.processor.serialization;
import static java.util.stream.Collectors.toList;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.checkPropertyNames;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.propertyName;
import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.CodeBlock;
@@ -128,6 +130,8 @@ public class MessageSerializerGenerator {
.addCode("\n");
if (!getters.isEmpty()) {
+ checkPropertyNames(getters);
+
method.beginControlFlow("switch (writer.state())");
for (int i = 0; i < getters.size(); ++i) {
@@ -153,15 +157,15 @@ public class MessageSerializerGenerator {
CodeBlock.Builder writerMethodCallBuilder = CodeBlock.builder();
if (typeUtils.isEnum(getter.getReturnType())) {
- String fieldName = getter.getSimpleName().toString();
+ String getterName = getter.getSimpleName().toString();
checkIdMethodExists(getter.getReturnType());
// Let's write the shifted id to efficiently transfer null (since we use "var int").
writerMethodCallBuilder
- .add("int idShifted = message.$L() == null ? 0 : message.$L().id() + 1;", fieldName, fieldName)
+ .add("int idShifted = message.$L() == null ? 0 : message.$L().id() + 1;", getterName, getterName)
.add("\n")
- .add("boolean written = writer.writeInt($S, idShifted)", fieldName);
+ .add("boolean written = writer.writeInt($S, idShifted)", propertyName(getter));
} else {
writerMethodCallBuilder
.add("boolean written = writer.")
diff --git a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
index 15814bb3843..b5c5f28b2f7 100644
--- a/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
+++ b/modules/network-annotation-processor/src/main/java/org/apache/ignite/internal/network/processor/serialization/MessageWriterMethodResolver.java
@@ -18,6 +18,7 @@
package org.apache.ignite.internal.network.processor.serialization;
import static org.apache.ignite.internal.network.processor.MessageGeneratorUtils.addByteArrayPostfix;
+import static org.apache.ignite.internal.network.processor.serialization.BaseMethodNameResolver.propertyName;
import com.squareup.javapoet.CodeBlock;
import java.util.Collection;
@@ -72,12 +73,13 @@ class MessageWriterMethodResolver {
TypeMirror getterReturnType = getter.getReturnType();
- String parameterName = getter.getSimpleName().toString();
+ String getterName = getter.getSimpleName().toString();
+ String propertyName = propertyName(getter);
if (getter.getAnnotation(Marshallable.class) != null) {
- parameterName = addByteArrayPostfix(parameterName);
+ getterName = addByteArrayPostfix(getterName);
return CodeBlock.builder()
- .add("writeByteArray($S, message.$L())", parameterName, parameterName)
+ .add("writeByteArray($S, message.$L())", propertyName, getterName)
.build();
}
@@ -85,18 +87,18 @@ class MessageWriterMethodResolver {
switch (methodName) {
case "ObjectArray":
- return resolveWriteObjectArray((ArrayType) getterReturnType, parameterName);
+ return resolveWriteObjectArray((ArrayType) getterReturnType, getterName, propertyName);
case "Collection":
- return resolveWriteCollection((DeclaredType) getterReturnType, parameterName);
+ return resolveWriteCollection((DeclaredType) getterReturnType, getterName, propertyName);
case "List":
- return resolveWriteList((DeclaredType) getterReturnType, parameterName);
+ return resolveWriteList((DeclaredType) getterReturnType, getterName, propertyName);
case "Set":
- return resolveWriteSet((DeclaredType) getterReturnType, parameterName);
+ return resolveWriteSet((DeclaredType) getterReturnType, getterName, propertyName);
case "Map":
- return resolveWriteMap((DeclaredType) getterReturnType, parameterName);
+ return resolveWriteMap((DeclaredType) getterReturnType, getterName, propertyName);
default:
return CodeBlock.builder()
- .add("write$L($S, message.$L())", methodName, parameterName, parameterName)
+ .add("write$L($S, message.$L())", methodName, propertyName, getterName)
.build();
}
}
@@ -104,13 +106,13 @@ class MessageWriterMethodResolver {
/**
* Creates a {@link MessageWriter#writeObjectArray(String, Object[], MessageCollectionItemType)} method call.
*/
- private CodeBlock resolveWriteObjectArray(ArrayType parameterType, String parameterName) {
+ private CodeBlock resolveWriteObjectArray(ArrayType parameterType, String parameterName, String propertyName) {
TypeMirror componentType = parameterType.getComponentType();
return CodeBlock.builder()
.add(
"writeObjectArray($S, message.$L(), $T.$L)",
- parameterName,
+ propertyName,
parameterName,
MessageCollectionItemType.class,
typeConverter.fromTypeMirror(componentType)
@@ -121,13 +123,13 @@ class MessageWriterMethodResolver {
/**
* Creates a {@link MessageWriter#writeCollection(String, Collection, MessageCollectionItemType)} method call.
*/
- private CodeBlock resolveWriteCollection(DeclaredType parameterType, String parameterName) {
+ private CodeBlock resolveWriteCollection(DeclaredType parameterType, String parameterName, String propertyName) {
TypeMirror collectionGenericType = parameterType.getTypeArguments().get(0);
return CodeBlock.builder()
.add(
"writeCollection($S, message.$L(), $T.$L)",
- parameterName,
+ propertyName,
parameterName,
MessageCollectionItemType.class,
typeConverter.fromTypeMirror(collectionGenericType)
@@ -138,13 +140,13 @@ class MessageWriterMethodResolver {
/**
* Creates a {@link MessageWriter#writeList(String, List, MessageCollectionItemType)} method call.
*/
- private CodeBlock resolveWriteList(DeclaredType parameterType, String parameterName) {
+ private CodeBlock resolveWriteList(DeclaredType parameterType, String parameterName, String propertyName) {
TypeMirror listGenericType = parameterType.getTypeArguments().get(0);
return CodeBlock.builder()
.add(
"writeList($S, message.$L(), $T.$L)",
- parameterName,
+ propertyName,
parameterName,
MessageCollectionItemType.class,
typeConverter.fromTypeMirror(listGenericType)
@@ -155,13 +157,13 @@ class MessageWriterMethodResolver {
/**
* Creates a {@link MessageWriter#writeSet(String, Set, MessageCollectionItemType)} method call.
*/
- private CodeBlock resolveWriteSet(DeclaredType parameterType, String parameterName) {
+ private CodeBlock resolveWriteSet(DeclaredType parameterType, String parameterName, String propertyName) {
TypeMirror setGenericType = parameterType.getTypeArguments().get(0);
return CodeBlock.builder()
.add(
"writeSet($S, message.$L(), $T.$L)",
- parameterName,
+ propertyName,
parameterName,
MessageCollectionItemType.class,
typeConverter.fromTypeMirror(setGenericType)
@@ -172,7 +174,7 @@ class MessageWriterMethodResolver {
/**
* Creates a {@link MessageWriter#writeMap(String, Map, MessageCollectionItemType, MessageCollectionItemType)} method call.
*/
- private CodeBlock resolveWriteMap(DeclaredType parameterType, String parameterName) {
+ private CodeBlock resolveWriteMap(DeclaredType parameterType, String parameterName, String propertyName) {
List<? extends TypeMirror> typeArguments = parameterType.getTypeArguments();
MessageCollectionItemType mapKeyType = typeConverter.fromTypeMirror(typeArguments.get(0));
@@ -181,7 +183,7 @@ class MessageWriterMethodResolver {
return CodeBlock.builder()
.add(
"writeMap($S, message.$L(), $T.$L, $T.$L)",
- parameterName,
+ propertyName,
parameterName,
MessageCollectionItemType.class,
mapKeyType,
diff --git a/modules/network-api/src/main/java/org/apache/ignite/internal/network/annotations/PropertyName.java b/modules/network-api/src/main/java/org/apache/ignite/internal/network/annotations/PropertyName.java
new file mode 100644
index 00000000000..4e521203e42
--- /dev/null
+++ b/modules/network-api/src/main/java/org/apache/ignite/internal/network/annotations/PropertyName.java
@@ -0,0 +1,28 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.ignite.internal.network.annotations;
+
+/**
+ * Annotation for methods of {@link Transferable} interface, that generated serializer/deserializer use a different name instead of the
+ * method name. This can be very useful for support backwards compatibility so that we can change the name of a method and not break
+ * serialization/deserialization.
+ */
+public @interface PropertyName {
+ /** Property name. */
+ String value();
+}