Skip to content

Commit

Permalink
feat(java): deserialize one pojo into another type (#2012)
Browse files Browse the repository at this point in the history
<!--
**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]>
  • Loading branch information
orisgarno and chaokunyang authored Feb 1, 2025
1 parent b4f5a2a commit 8889203
Show file tree
Hide file tree
Showing 7 changed files with 161 additions and 25 deletions.
4 changes: 1 addition & 3 deletions docs/guide/java_serialization_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -521,9 +521,7 @@ consistent between serialization and deserialization.
### Deserialize POJO into another type

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

### Use wrong API for deserialization

Expand Down
2 changes: 1 addition & 1 deletion java/fury-core/src/main/java/org/apache/fury/Fury.java
Original file line number Diff line number Diff line change
Expand Up @@ -1131,7 +1131,7 @@ public <T> T deserializeJavaObject(MemoryBuffer buffer, Class<T> cls) {
if (nextReadRefId >= NOT_NULL_VALUE_FLAG) {
ClassInfo classInfo;
if (shareMeta) {
classInfo = classResolver.readClassInfo(buffer);
classInfo = classResolver.readClassInfoWithMetaShare(buffer, cls);
} else {
classInfo = classResolver.getClassInfo(cls);
}
Expand Down
18 changes: 18 additions & 0 deletions java/fury-core/src/main/java/org/apache/fury/meta/ClassDef.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import java.util.Map;
import java.util.Objects;
import java.util.SortedMap;
import java.util.stream.Collectors;
import org.apache.fury.Fury;
import org.apache.fury.builder.MetaSharedCodecBuilder;
import org.apache.fury.collection.Tuple2;
Expand Down Expand Up @@ -787,4 +788,21 @@ public static ClassDef buildClassDef(
ClassResolver classResolver, Class<?> type, List<Field> fields, boolean isObjectType) {
return ClassDefEncoder.buildClassDef(classResolver, type, fields, isObjectType);
}

public ClassDef replaceRootClassTo(ClassResolver classResolver, Class<?> targetCls) {
String name = targetCls.getName();
List<FieldInfo> fieldInfos =
fieldsInfo.stream()
.map(
fieldInfo -> {
if (fieldInfo.definedClass.equals(classSpec.entireClassName)) {
return new FieldInfo(name, fieldInfo.fieldName, fieldInfo.fieldType);
} else {
return fieldInfo;
}
})
.collect(Collectors.toList());
return ClassDefEncoder.buildClassDefWithFieldInfos(
classResolver, targetCls, fieldInfos, isObjectType);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,15 @@ static List<FieldInfo> buildFieldsInfo(ClassResolver resolver, List<Field> field
/** Build class definition from fields of class. */
static ClassDef buildClassDef(
ClassResolver classResolver, Class<?> type, List<Field> fields, boolean isObjectType) {
List<FieldInfo> fieldInfos = buildFieldsInfo(classResolver, fields);
return buildClassDefWithFieldInfos(
classResolver, type, buildFieldsInfo(classResolver, fields), isObjectType);
}

static ClassDef buildClassDefWithFieldInfos(
ClassResolver classResolver,
Class<?> type,
List<ClassDef.FieldInfo> fieldInfos,
boolean isObjectType) {
Map<String, List<FieldInfo>> classLayers = getClassFields(type, fieldInfos);
fieldInfos = new ArrayList<>(fieldInfos.size());
classLayers.values().forEach(fieldInfos::addAll);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,8 @@ private static class ExtRegistry {
private final Map<Class<?>, FieldResolver> fieldResolverMap = new HashMap<>();
private final LongMap<Tuple2<ClassDef, ClassInfo>> classIdToDef = new LongMap<>();
private final Map<Class<?>, ClassDef> currentLayerClassDef = new HashMap<>();
// Tuple2<Class, Class>: Tuple2<From Class, To Class>
private final Map<Tuple2<Class<?>, Class<?>>, ClassInfo> transformedClassInfo = new HashMap<>();
// TODO(chaokunyang) Better to use soft reference, see ObjectStreamClass.
private final ConcurrentHashMap<Tuple2<Class<?>, Boolean>, SortedMap<Field, Descriptor>>
descriptorsCache = new ConcurrentHashMap<>();
Expand Down Expand Up @@ -1411,6 +1413,27 @@ private ClassInfo readClassInfoWithMetaShare(MetaContext metaContext, int index)
return classInfo;
}

public ClassInfo readClassInfoWithMetaShare(MemoryBuffer buffer, Class<?> targetClass) {
assert metaContextShareEnabled;
ClassInfo classInfo =
readClassInfoWithMetaShare(buffer, fury.getSerializationContext().getMetaContext());
Class<?> readClass = classInfo.getCls();
// replace target class if needed
if (targetClass != readClass) {
Tuple2<Class<?>, Class<?>> key = Tuple2.of(readClass, targetClass);
ClassInfo newClassInfo = extRegistry.transformedClassInfo.get(key);
if (newClassInfo == null) {
// similar to create serializer for `NonexistentMetaShared`
newClassInfo =
getMetaSharedClassInfo(
classInfo.classDef.replaceRootClassTo(this, targetClass), targetClass);
extRegistry.transformedClassInfo.put(key, newClassInfo);
}
return newClassInfo;
}
return classInfo;
}

private ClassInfo buildMetaSharedClassInfo(
Tuple2<ClassDef, ClassInfo> classDefTuple, ClassDef classDef) {
ClassInfo classInfo;
Expand Down Expand Up @@ -1439,6 +1462,7 @@ private ClassInfo getMetaSharedClassInfo(ClassDef classDef, Class<?> clz) {
Short classId = extRegistry.registeredClassIdMap.get(cls);
ClassInfo classInfo =
new ClassInfo(this, cls, null, classId == null ? NO_CLASS_ID : classId, NOT_SUPPORT_XLANG);
classInfo.classDef = classDef;
if (NonexistentClass.class.isAssignableFrom(TypeUtils.getComponentIfArray(cls))) {
if (cls == NonexistentMetaShared.class) {
classInfo.setSerializer(this, new NonexistentClassSerializer(fury, classDef));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@

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

Expand Down Expand Up @@ -61,9 +60,9 @@ void testTargetHasLessFieldComparedToSourceClass() throws InterruptedException {
ClassCompleteField<String> subclass = new ClassCompleteField<>("subclass", "subclass2");
ClassCompleteField<ClassCompleteField<String>> classCompleteField =
new ClassCompleteField<>(subclass, subclass);
byte[] serialized = getFury(ClassCompleteField.class).serializeJavaObject(classCompleteField);
byte[] serialized = getFury().serializeJavaObject(classCompleteField);
ClassMissingField<ClassMissingField<String>> classMissingField =
getFury(ClassMissingField.class).deserializeJavaObject(serialized, ClassMissingField.class);
getFury().deserializeJavaObject(serialized, ClassMissingField.class);

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

ClassMissingField<String> subclass = new ClassMissingField<>("subclass");
ClassMissingField classMissingField = new ClassMissingField(subclass);
byte[] serialized = getFury(ClassMissingField.class).serializeJavaObject(classMissingField);
byte[] serialized = getFury().serializeJavaObject(classMissingField);

ClassCompleteField classCompleteField =
getFury(ClassCompleteField.class)
.deserializeJavaObject(serialized, ClassCompleteField.class);
getFury().deserializeJavaObject(serialized, ClassCompleteField.class);

assertEq(classCompleteField, classMissingField);
}

void assertEq(ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
assertEqSubClass(
(ClassCompleteField) classCompleteField.getPrivateFieldSubClass(),
(ClassMissingField) classMissingField.getPrivateFieldSubClass());
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
}

void assertEqSubClass(
ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
assertEquals(
classCompleteField.getPrivateFieldSubClass(), classMissingField.getPrivateFieldSubClass());
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/*
* 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.fury.serializer.compatible;

import org.apache.fury.Fury;
import org.apache.fury.config.CompatibleMode;
import org.apache.fury.config.Language;
import org.apache.fury.serializer.compatible.classes.ClassCompleteField;
import org.apache.fury.serializer.compatible.classes.ClassMissingField;
import org.testng.Assert;
import org.testng.annotations.Test;

/**
* Test COMPATIBILITY mode that supports - same field type and name can be deserialized to other
* also test generic class
*/
public class DifferentPOJOCompatibleSerializerWithRegistrationTest extends Assert {

Fury getFury(Class<?>... classes) {
Fury instance =
Fury.builder()
.withLanguage(Language.JAVA)
.withRefTracking(true)
.withCompatibleMode(CompatibleMode.COMPATIBLE)
.withMetaShare(true)
.withScopedMetaShare(true)
.requireClassRegistration(false)
.withAsyncCompilation(true)
.serializeEnumByName(true)
.build();
if (classes != null) {
for (Class<?> clazz : classes) {
instance.register(clazz);
}
}
;
return instance;
}

@Test
void testTargetHasLessFieldComparedToSourceClass() throws InterruptedException {

ClassCompleteField<String> subclass = new ClassCompleteField<>("subclass", "subclass2");
ClassCompleteField<ClassCompleteField<String>> classCompleteField =
new ClassCompleteField<>(subclass, subclass);
byte[] serialized = getFury(ClassCompleteField.class).serializeJavaObject(classCompleteField);
ClassMissingField<ClassMissingField<String>> classMissingField =
getFury(ClassMissingField.class).deserializeJavaObject(serialized, ClassMissingField.class);

assertEq(classCompleteField, classMissingField);
}

@Test
void testTargetHasMoreFieldComparedToSourceClass() throws InterruptedException {

ClassMissingField<String> subclass = new ClassMissingField<>("subclass");
ClassMissingField classMissingField = new ClassMissingField(subclass);
byte[] serialized = getFury(ClassMissingField.class).serializeJavaObject(classMissingField);

ClassCompleteField classCompleteField =
getFury(ClassCompleteField.class)
.deserializeJavaObject(serialized, ClassCompleteField.class);

assertEq(classCompleteField, classMissingField);
}

void assertEq(ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
assertEqSubClass(
(ClassCompleteField) classCompleteField.getPrivateFieldSubClass(),
(ClassMissingField) classMissingField.getPrivateFieldSubClass());
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
}

void assertEqSubClass(
ClassCompleteField classCompleteField, ClassMissingField classMissingField) {
assertEquals(
classCompleteField.getPrivateFieldSubClass(), classMissingField.getPrivateFieldSubClass());
assertEquals(classCompleteField.getPrivateMap(), classMissingField.getPrivateMap());
assertEquals(classCompleteField.getPrivateList(), classMissingField.getPrivateList());
assertEquals(classCompleteField.getPrivateString(), classMissingField.getPrivateString());
assertEquals(classCompleteField.getPrivateInt(), classMissingField.getPrivateInt());
}
}

0 comments on commit 8889203

Please sign in to comment.