Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(java): deserialize one pojo into another type #2012

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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());
}
}
Loading