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.

Sign up for GitHub

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

refactor(java): remove registerWithCheck function #1424

Merged
merged 3 commits into from
Mar 25, 2024
Merged

refactor(java): remove registerWithCheck function #1424

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5582a42
refactor(java): remove registerWithCheck function
LiangliangSui Mar 24, 2024
d639108
Register frequently used Classes before registerDefaultClasses.
LiangliangSui Mar 25, 2024
a8c1033
fix ci
LiangliangSui Mar 25, 2024
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
166 changes: 73 additions & 93 deletions java/fury-core/src/main/java/org/apache/fury/resolver/ClassResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,46 +263,42 @@ public void initialize() {
register(LambdaSerializer.ReplaceStub.class, LAMBDA_STUB_ID);
register(JdkProxySerializer.ReplaceStub.class, JDK_PROXY_STUB_ID);
register(ReplaceResolveSerializer.ReplaceStub.class, REPLACE_STUB_ID);
registerWithCheck(void.class, PRIMITIVE_VOID_CLASS_ID);
registerWithCheck(boolean.class, PRIMITIVE_BOOLEAN_CLASS_ID);
registerWithCheck(byte.class, PRIMITIVE_BYTE_CLASS_ID);
registerWithCheck(char.class, PRIMITIVE_CHAR_CLASS_ID);
registerWithCheck(short.class, PRIMITIVE_SHORT_CLASS_ID);
registerWithCheck(int.class, PRIMITIVE_INT_CLASS_ID);
registerWithCheck(float.class, PRIMITIVE_FLOAT_CLASS_ID);
registerWithCheck(long.class, PRIMITIVE_LONG_CLASS_ID);
registerWithCheck(double.class, PRIMITIVE_DOUBLE_CLASS_ID);
registerWithCheck(Void.class, VOID_CLASS_ID);
registerWithCheck(Boolean.class, BOOLEAN_CLASS_ID);
registerWithCheck(Byte.class, BYTE_CLASS_ID);
registerWithCheck(Character.class, CHAR_CLASS_ID);
registerWithCheck(Short.class, SHORT_CLASS_ID);
registerWithCheck(Integer.class, INTEGER_CLASS_ID);
registerWithCheck(Float.class, FLOAT_CLASS_ID);
registerWithCheck(Long.class, LONG_CLASS_ID);
registerWithCheck(Double.class, DOUBLE_CLASS_ID);
registerWithCheck(String.class, STRING_CLASS_ID);
registerWithCheck(boolean[].class, PRIMITIVE_BOOLEAN_ARRAY_CLASS_ID);
registerWithCheck(byte[].class, PRIMITIVE_BYTE_ARRAY_CLASS_ID);
registerWithCheck(char[].class, PRIMITIVE_CHAR_ARRAY_CLASS_ID);
registerWithCheck(short[].class, PRIMITIVE_SHORT_ARRAY_CLASS_ID);
registerWithCheck(int[].class, PRIMITIVE_INT_ARRAY_CLASS_ID);
registerWithCheck(float[].class, PRIMITIVE_FLOAT_ARRAY_CLASS_ID);
registerWithCheck(long[].class, PRIMITIVE_LONG_ARRAY_CLASS_ID);
registerWithCheck(double[].class, PRIMITIVE_DOUBLE_ARRAY_CLASS_ID);
registerWithCheck(String[].class, STRING_ARRAY_CLASS_ID);
registerWithCheck(Object[].class, OBJECT_ARRAY_CLASS_ID);
registerWithCheck(ArrayList.class, ARRAYLIST_CLASS_ID);
registerWithCheck(HashMap.class, HASHMAP_CLASS_ID);
registerWithCheck(HashSet.class, HASHSET_CLASS_ID);
registerWithCheck(Class.class, CLASS_CLASS_ID);
registerWithCheck(Object.class, EMPTY_OBJECT_ID);
// Register common class ahead to get smaller class id for serialization.
// TODO(Liangliang Sui): Clean up duplicately registered Classes and throw exceptions when
// Classes are duplicately registered.
registerCommonUsedClasses();
addDefaultSerializers();
register(void.class, PRIMITIVE_VOID_CLASS_ID);
register(boolean.class, PRIMITIVE_BOOLEAN_CLASS_ID);
register(byte.class, PRIMITIVE_BYTE_CLASS_ID);
register(char.class, PRIMITIVE_CHAR_CLASS_ID);
register(short.class, PRIMITIVE_SHORT_CLASS_ID);
register(int.class, PRIMITIVE_INT_CLASS_ID);
register(float.class, PRIMITIVE_FLOAT_CLASS_ID);
register(long.class, PRIMITIVE_LONG_CLASS_ID);
register(double.class, PRIMITIVE_DOUBLE_CLASS_ID);
register(Void.class, VOID_CLASS_ID);
register(Boolean.class, BOOLEAN_CLASS_ID);
register(Byte.class, BYTE_CLASS_ID);
register(Character.class, CHAR_CLASS_ID);
register(Short.class, SHORT_CLASS_ID);
register(Integer.class, INTEGER_CLASS_ID);
register(Float.class, FLOAT_CLASS_ID);
register(Long.class, LONG_CLASS_ID);
register(Double.class, DOUBLE_CLASS_ID);
register(String.class, STRING_CLASS_ID);
register(boolean[].class, PRIMITIVE_BOOLEAN_ARRAY_CLASS_ID);
register(byte[].class, PRIMITIVE_BYTE_ARRAY_CLASS_ID);
register(char[].class, PRIMITIVE_CHAR_ARRAY_CLASS_ID);
register(short[].class, PRIMITIVE_SHORT_ARRAY_CLASS_ID);
register(int[].class, PRIMITIVE_INT_ARRAY_CLASS_ID);
register(float[].class, PRIMITIVE_FLOAT_ARRAY_CLASS_ID);
register(long[].class, PRIMITIVE_LONG_ARRAY_CLASS_ID);
register(double[].class, PRIMITIVE_DOUBLE_ARRAY_CLASS_ID);
register(String[].class, STRING_ARRAY_CLASS_ID);
register(Object[].class, OBJECT_ARRAY_CLASS_ID);
register(ArrayList.class, ARRAYLIST_CLASS_ID);
register(HashMap.class, HASHMAP_CLASS_ID);
register(HashSet.class, HASHSET_CLASS_ID);
register(Class.class, CLASS_CLASS_ID);
register(Object.class, EMPTY_OBJECT_ID);
registerDefaultClasses();
addDefaultSerializers();
shimDispatcher.initialize();
innerEndClassId = extRegistry.classIdGenerator;
}
Expand Down Expand Up @@ -356,20 +352,12 @@ private void addDefaultSerializer(Class type, Serializer serializer) {
register(type);
}

/** Register common class ahead to get smaller class id for serialization. */
private void registerCommonUsedClasses() {
LiangliangSui marked this conversation as resolved.
Show resolved Hide resolved
register(Class.class);
register(ArrayList.class, LinkedList.class, HashSet.class, TreeSet.class);
register(HashMap.class, LinkedHashMap.class, TreeMap.class);
register(ByteBuffer.allocate(1).getClass());
register(Integer[].class, Long[].class);
private void registerDefaultClasses() {
register(LinkedList.class, TreeSet.class);
register(LinkedHashMap.class, TreeMap.class);
register(Date.class, Timestamp.class, LocalDateTime.class, Instant.class);
register(BigInteger.class, BigDecimal.class);
register(Optional.class, OptionalInt.class);
}

private void registerDefaultClasses() {
register(Object.class, Object[].class, Void.class);
register(ByteBuffer.allocate(1).getClass());
register(ByteBuffer.allocateDirect(1).getClass());
register(Comparator.naturalOrder().getClass());
Expand Down Expand Up @@ -436,40 +424,43 @@ public void register(Class<?> cls, String typeTag) {
public void register(Class<?> cls, int classId) {
// class id must be less than Integer.MAX_VALUE/2 since we use bit 0 as class id flag.
Preconditions.checkArgument(classId >= 0 && classId < Short.MAX_VALUE);
Preconditions.checkArgument(
!extRegistry.registeredClassIdMap.containsKey(cls),
String.format(
"Class %s already registered with id %s.",
cls, extRegistry.registeredClassIdMap.get(cls)));
Preconditions.checkArgument(
!extRegistry.registeredClasses.containsKey(cls.getName()),
String.format(
"Class %s with name %s has been registered, registering class with same name are not allowed.",
extRegistry.registeredClasses.get(cls.getName()), cls.getName()));

short id = (short) classId;
if (!extRegistry.registeredClassIdMap.containsKey(cls)) {
if (extRegistry.registeredClasses.containsKey(cls.getName())) {
throw new IllegalArgumentException(
String.format(
"Class %s with name %s has been registered, registering class with same name are not allowed.",
extRegistry.registeredClasses.get(cls.getName()), cls.getName()));
}
if (id < registeredId2ClassInfo.length && registeredId2ClassInfo[id] != null) {
throw new IllegalArgumentException(
String.format(
"Class %s with id %s has been registered, registering class %s with same id are not allowed.",
registeredId2ClassInfo[id].getCls(), id, cls.getName()));
}
extRegistry.registeredClassIdMap.put(cls, id);
if (registeredId2ClassInfo.length <= id) {
ClassInfo[] tmp = new ClassInfo[(id + 1) * 2];
System.arraycopy(registeredId2ClassInfo, 0, tmp, 0, registeredId2ClassInfo.length);
registeredId2ClassInfo = tmp;
}
ClassInfo classInfo = classInfoMap.get(cls);
if (classInfo != null) {
classInfo.classId = id;
} else {
classInfo = new ClassInfo(this, cls, null, null, id);
// make `extRegistry.registeredClassIdMap` and `classInfoMap` share same classInfo
// instances.
classInfoMap.put(cls, classInfo);
}
// serializer will be set lazily in `addSerializer` method if it's null.
registeredId2ClassInfo[id] = classInfo;
extRegistry.registeredClasses.put(cls.getName(), cls);
extRegistry.classIdGenerator++;
if (id < registeredId2ClassInfo.length && registeredId2ClassInfo[id] != null) {
throw new IllegalArgumentException(
String.format(
"Class %s with id %s has been registered, registering class %s with same id are not allowed.",
registeredId2ClassInfo[id].getCls(), id, cls.getName()));
}
extRegistry.registeredClassIdMap.put(cls, id);
if (registeredId2ClassInfo.length <= id) {
ClassInfo[] tmp = new ClassInfo[(id + 1) * 2];
System.arraycopy(registeredId2ClassInfo, 0, tmp, 0, registeredId2ClassInfo.length);
registeredId2ClassInfo = tmp;
}
ClassInfo classInfo = classInfoMap.get(cls);
if (classInfo != null) {
classInfo.classId = id;
} else {
classInfo = new ClassInfo(this, cls, null, null, id);
// make `extRegistry.registeredClassIdMap` and `classInfoMap` share same classInfo
// instances.
classInfoMap.put(cls, classInfo);
}
// serializer will be set lazily in `addSerializer` method if it's null.
registeredId2ClassInfo[id] = classInfo;
extRegistry.registeredClasses.put(cls.getName(), cls);
extRegistry.classIdGenerator++;
}

public void register(Class<?> cls, Short id, boolean createSerializer) {
Expand All @@ -479,17 +470,6 @@ public void register(Class<?> cls, Short id, boolean createSerializer) {
}
}

/** register class with given id. */
public void registerWithCheck(Class<?> cls, short id) {
if (extRegistry.registeredClassIdMap.containsKey(cls)) {
throw new IllegalArgumentException(
String.format(
"Class %s already registered with id %s.",
cls, extRegistry.registeredClassIdMap.get(cls)));
}
register(cls, id);
}

public Short getRegisteredClassId(Class<?> cls) {
return extRegistry.registeredClassIdMap.get(cls);
}
Expand Down
3 changes: 3 additions & 0 deletions java/fury-core/src/test/java/org/apache/fury/resolver/ClassResolverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ public void testRegisterClass() {
Fury fury = Fury.builder().withLanguage(Language.JAVA).requireClassRegistration(false).build();
ClassResolver classResolver = fury.getClassResolver();
classResolver.register(org.apache.fury.test.bean.Foo.class);
Assert.assertThrows(
IllegalArgumentException.class,
() -> classResolver.register(org.apache.fury.test.bean.Foo.class, 100));
Assert.assertThrows(
IllegalArgumentException.class,
() -> classResolver.register(org.apache.fury.test.bean.Foo.createCompatibleClass1()));
Expand Down
Loading