Skip to content

Commit 8889203

Browse files
orisgarnochaokunyang
orisgarno
and
chaokunyang
authored
feat(java): deserialize one pojo into another type (#2012)
<!-- **Thanks for contributing to Fury.** **If this is your first time opening a PR on fury, you can refer to [CONTRIBUTING.md](https://github.com/apache/fury/blob/main/CONTRIBUTING.md).** Contribution Checklist - The **Apache Fury (incubating)** community has restrictions on the naming of pr titles. You can also find instructions in [CONTRIBUTING.md](https://github.com/apache/fury/blob/main/CONTRIBUTING.md). - Fury has a strong focus on performance. If the PR you submit will have an impact on performance, please benchmark it first and provide the benchmark result here. --> ## What does this PR do? replace class def if target class is different type with the actual serialized one, so it can be deserialized to another type #1998 <!-- Describe the purpose of this PR. --> ## Related issues <!-- Is there any related issue? Please attach here. - #xxxx0 - #xxxx1 - #xxxx2 --> ## Does this PR introduce any user-facing change? <!-- If any user-facing interface changes, please [open an issue](https://github.com/apache/fury/issues/new/choose) describing the need to do so and update the document if necessary. --> - [ ] Does this PR introduce any public API change? - [ ] Does this PR introduce any binary protocol compatibility change? ## Benchmark <!-- When the PR has an impact on performance (if you don't know whether the PR will have an impact on performance, you can submit the PR first, and if it will have impact on performance, the code reviewer will explain it), be sure to attach a benchmark data here. --> --------- Co-authored-by: chaokunyang <[email protected]>
1 parent b4f5a2a commit 8889203

File tree

7 files changed

+161
-25
lines changed

7 files changed

+161
-25
lines changed

‎docs/guide/java_serialization_guide.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -521,9 +521,7 @@ consistent between serialization and deserialization.
521521
### Deserialize POJO into another type
522522

523523
Fury allows you to serialize one POJO and deserialize it into a different POJO. To achieve this, configure Fury with
524-
`CompatibleMode` set to `org.apache.fury.config.CompatibleMode.COMPATIBLE`. Additionally, you only need to register the
525-
specific classes you want to serialize or deserialize to setup type mapping relationship; there's no need to register any nested classes within them.
526-
[See example here](/java/fury-core/src/test/java/org/apache/fury/serializer/compatible/DifferentPOJOCompatibleSerializerTest.java)
524+
`CompatibleMode` set to `org.apache.fury.config.CompatibleMode.COMPATIBLE`.
527525

528526
### Use wrong API for deserialization
529527

‎java/fury-core/src/main/java/org/apache/fury/Fury.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1131,7 +1131,7 @@ public <T> T deserializeJavaObject(MemoryBuffer buffer, Class<T> cls) {
11311131
if (nextReadRefId >= NOT_NULL_VALUE_FLAG) {
11321132
ClassInfo classInfo;
11331133
if (shareMeta) {
1134-
classInfo = classResolver.readClassInfo(buffer);
1134+
classInfo = classResolver.readClassInfoWithMetaShare(buffer, cls);
11351135
} else {
11361136
classInfo = classResolver.getClassInfo(cls);
11371137
}

‎java/fury-core/src/main/java/org/apache/fury/meta/ClassDef.java‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
import java.util.Map;
3838
import java.util.Objects;
3939
import java.util.SortedMap;
40+
import java.util.stream.Collectors;
4041
import org.apache.fury.Fury;
4142
import org.apache.fury.builder.MetaSharedCodecBuilder;
4243
import org.apache.fury.collection.Tuple2;
@@ -787,4 +788,21 @@ public static ClassDef buildClassDef(
787788
ClassResolver classResolver, Class<?> type, List<Field> fields, boolean isObjectType) {
788789
return ClassDefEncoder.buildClassDef(classResolver, type, fields, isObjectType);
789790
}
791+
792+
public ClassDef replaceRootClassTo(ClassResolver classResolver, Class<?> targetCls) {
793+
String name = targetCls.getName();
794+
List<FieldInfo> fieldInfos =
795+
fieldsInfo.stream()
796+
.map(
797+
fieldInfo -> {
798+
if (fieldInfo.definedClass.equals(classSpec.entireClassName)) {
799+
return new FieldInfo(name, fieldInfo.fieldName, fieldInfo.fieldType);
800+
} else {
801+
return fieldInfo;
802+
}
803+
})
804+
.collect(Collectors.toList());
805+
return ClassDefEncoder.buildClassDefWithFieldInfos(
806+
classResolver, targetCls, fieldInfos, isObjectType);
807+
}
790808
}

‎java/fury-core/src/main/java/org/apache/fury/meta/ClassDefEncoder.java‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,15 @@ static List<FieldInfo> buildFieldsInfo(ClassResolver resolver, List<Field> field
105105
/** Build class definition from fields of class. */
106106
static ClassDef buildClassDef(
107107
ClassResolver classResolver, Class<?> type, List<Field> fields, boolean isObjectType) {
108-
List<FieldInfo> fieldInfos = buildFieldsInfo(classResolver, fields);
108+
return buildClassDefWithFieldInfos(
109+
classResolver, type, buildFieldsInfo(classResolver, fields), isObjectType);
110+
}
111+
112+
static ClassDef buildClassDefWithFieldInfos(
113+
ClassResolver classResolver,
114+
Class<?> type,
115+
List<ClassDef.FieldInfo> fieldInfos,
116+
boolean isObjectType) {
109117
Map<String, List<FieldInfo>> classLayers = getClassFields(type, fieldInfos);
110118
fieldInfos = new ArrayList<>(fieldInfos.size());
111119
classLayers.values().forEach(fieldInfos::addAll);

‎java/fury-core/src/main/java/org/apache/fury/resolver/ClassResolver.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,8 @@ private static class ExtRegistry {
247247
private final Map<Class<?>, FieldResolver> fieldResolverMap = new HashMap<>();
248248
private final LongMap<Tuple2<ClassDef, ClassInfo>> classIdToDef = new LongMap<>();
249249
private final Map<Class<?>, ClassDef> currentLayerClassDef = new HashMap<>();
250+
// Tuple2<Class, Class>: Tuple2<From Class, To Class>
251+
private final Map<Tuple2<Class<?>, Class<?>>, ClassInfo> transformedClassInfo = new HashMap<>();
250252
// TODO(chaokunyang) Better to use soft reference, see ObjectStreamClass.
251253
private final ConcurrentHashMap<Tuple2<Class<?>, Boolean>, SortedMap<Field, Descriptor>>
252254
descriptorsCache = new ConcurrentHashMap<>();
@@ -1411,6 +1413,27 @@ private ClassInfo readClassInfoWithMetaShare(MetaContext metaContext, int index)
14111413
return classInfo;
14121414
}
14131415

1416+
public ClassInfo readClassInfoWithMetaShare(MemoryBuffer buffer, Class<?> targetClass) {
1417+
assert metaContextShareEnabled;
1418+
ClassInfo classInfo =
1419+
readClassInfoWithMetaShare(buffer, fury.getSerializationContext().getMetaContext());
1420+
Class<?> readClass = classInfo.getCls();
1421+
// replace target class if needed
1422+
if (targetClass != readClass) {
1423+
Tuple2<Class<?>, Class<?>> key = Tuple2.of(readClass, targetClass);
1424+
ClassInfo newClassInfo = extRegistry.transformedClassInfo.get(key);
1425+
if (newClassInfo == null) {
1426+
// similar to create serializer for `NonexistentMetaShared`
1427+
newClassInfo =
1428+
getMetaSharedClassInfo(
1429+
classInfo.classDef.replaceRootClassTo(this, targetClass), targetClass);
1430+
extRegistry.transformedClassInfo.put(key, newClassInfo);
1431+
}
1432+
return newClassInfo;
1433+
}
1434+
return classInfo;
1435+
}
1436+
14141437
private ClassInfo buildMetaSharedClassInfo(
14151438
Tuple2<ClassDef, ClassInfo> classDefTuple, ClassDef classDef) {
14161439
ClassInfo classInfo;
@@ -1439,6 +1462,7 @@ private ClassInfo getMetaSharedClassInfo(ClassDef classDef, Class<?> clz) {
14391462
Short classId = extRegistry.registeredClassIdMap.get(cls);
14401463
ClassInfo classInfo =
14411464
new ClassInfo(this, cls, null, classId == null ? NO_CLASS_ID : classId, NOT_SUPPORT_XLANG);
1465+
classInfo.classDef = classDef;
14421466
if (NonexistentClass.class.isAssignableFrom(TypeUtils.getComponentIfArray(cls))) {
14431467
if (cls == NonexistentMetaShared.class) {
14441468
classInfo.setSerializer(this, new NonexistentClassSerializer(fury, classDef));

‎java/fury-core/src/test/java/org/apache/fury/serializer/compatible/DifferentPOJOCompatibleSerializerTest.java‎

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@
2929

3030
/**
3131
* Test COMPATIBILITY mode that supports - same field type and name can be deserialized to other
32-
* class with different name - scrambled field order to make sure it could handle different field
33-
* order - missing or extra field from source class to target class - generic class
32+
* class with different name
3433
*/
3534
public class DifferentPOJOCompatibleSerializerTest extends Assert {
3635

@@ -61,9 +60,9 @@ void testTargetHasLessFieldComparedToSourceClass() throws InterruptedException {
6160
ClassCompleteField<String> subclass = new ClassCompleteField<>("subclass", "subclass2");
6261
ClassCompleteField<ClassCompleteField<String>> classCompleteField =
6362
new ClassCompleteField<>(subclass, subclass);
64-
byte[] serialized = getFury(ClassCompleteField.class).serializeJavaObject(classCompleteField);
63+
byte[] serialized = getFury().serializeJavaObject(classCompleteField);
6564
ClassMissingField<ClassMissingField<String>> classMissingField =
66-
getFury(ClassMissingField.class).deserializeJavaObject(serialized, ClassMissingField.class);
65+
getFury().deserializeJavaObject(serialized, ClassMissingField.class);
6766

6867
assertEq(classCompleteField, classMissingField);
6968
}
@@ -73,29 +72,15 @@ void testTargetHasMoreFieldComparedToSourceClass() throws InterruptedException {
7372

7473
ClassMissingField<String> subclass = new ClassMissingField<>("subclass");
7574
ClassMissingField classMissingField = new ClassMissingField(subclass);
76-
byte[] serialized = getFury(ClassMissingField.class).serializeJavaObject(classMissingField);
75+
byte[] serialized = getFury().serializeJavaObject(classMissingField);
7776

7877
ClassCompleteField classCompleteField =
79-
getFury(ClassCompleteField.class)
80-
.deserializeJavaObject(serialized, ClassCompleteField.class);
78+
getFury().deserializeJavaObject(serialized, ClassCompleteField.class);
8179

8280
assertEq(classCompleteField, classMissingField);
8381
}
8482

8583
void assertEq(ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
86-
assertEqSubClass(
87-
(ClassCompleteField) classCompleteField.getPrivateFieldSubClass(),
88-
(ClassMissingField) classMissingField.getPrivateFieldSubClass());
89-
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
90-
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
91-
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
92-
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
93-
}
94-
95-
void assertEqSubClass(
96-
ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
97-
assertEquals(
98-
classCompleteField.getPrivateFieldSubClass(), classMissingField.getPrivateFieldSubClass());
9984
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
10085
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
10186
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());

‎java/fury-core/src/test/java/org/apache/fury/serializer/compatible/DifferentPOJOCompatibleSerializerWithRegistrationTest.java‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.apache.fury.serializer.compatible;
21+
22+
import org.apache.fury.Fury;
23+
import org.apache.fury.config.CompatibleMode;
24+
import org.apache.fury.config.Language;
25+
import org.apache.fury.serializer.compatible.classes.ClassCompleteField;
26+
import org.apache.fury.serializer.compatible.classes.ClassMissingField;
27+
import org.testng.Assert;
28+
import org.testng.annotations.Test;
29+
30+
/**
31+
* Test COMPATIBILITY mode that supports - same field type and name can be deserialized to other
32+
* also test generic class
33+
*/
34+
public class DifferentPOJOCompatibleSerializerWithRegistrationTest extends Assert {
35+
36+
Fury getFury(Class<?>... classes) {
37+
Fury instance =
38+
Fury.builder()
39+
.withLanguage(Language.JAVA)
40+
.withRefTracking(true)
41+
.withCompatibleMode(CompatibleMode.COMPATIBLE)
42+
.withMetaShare(true)
43+
.withScopedMetaShare(true)
44+
.requireClassRegistration(false)
45+
.withAsyncCompilation(true)
46+
.serializeEnumByName(true)
47+
.build();
48+
if (classes != null) {
49+
for (Class<?> clazz : classes) {
50+
instance.register(clazz);
51+
}
52+
}
53+
;
54+
return instance;
55+
}
56+
57+
@Test
58+
void testTargetHasLessFieldComparedToSourceClass() throws InterruptedException {
59+
60+
ClassCompleteField<String> subclass = new ClassCompleteField<>("subclass", "subclass2");
61+
ClassCompleteField<ClassCompleteField<String>> classCompleteField =
62+
new ClassCompleteField<>(subclass, subclass);
63+
byte[] serialized = getFury(ClassCompleteField.class).serializeJavaObject(classCompleteField);
64+
ClassMissingField<ClassMissingField<String>> classMissingField =
65+
getFury(ClassMissingField.class).deserializeJavaObject(serialized, ClassMissingField.class);
66+
67+
assertEq(classCompleteField, classMissingField);
68+
}
69+
70+
@Test
71+
void testTargetHasMoreFieldComparedToSourceClass() throws InterruptedException {
72+
73+
ClassMissingField<String> subclass = new ClassMissingField<>("subclass");
74+
ClassMissingField classMissingField = new ClassMissingField(subclass);
75+
byte[] serialized = getFury(ClassMissingField.class).serializeJavaObject(classMissingField);
76+
77+
ClassCompleteField classCompleteField =
78+
getFury(ClassCompleteField.class)
79+
.deserializeJavaObject(serialized, ClassCompleteField.class);
80+
81+
assertEq(classCompleteField, classMissingField);
82+
}
83+
84+
void assertEq(ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
85+
assertEqSubClass(
86+
(ClassCompleteField) classCompleteField.getPrivateFieldSubClass(),
87+
(ClassMissingField) classMissingField.getPrivateFieldSubClass());
88+
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
89+
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
90+
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
91+
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
92+
}
93+
94+
void assertEqSubClass(
95+
ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
96+
assertEquals(
97+
classCompleteField.getPrivateFieldSubClass(), classMissingField.getPrivateFieldSubClass());
98+
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
99+
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
100+
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
101+
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
102+
}
103+
}

0 commit comments

Comments
 (0)