Skip to content

[FLINK-35726][table] Honor @DataTypeHint on POJO fields in type conve… #28288

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

Open
Au-Miner wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FLINK-35726][table] Honor @DataTypeHint on POJO fields in type conve… #28288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions ...table-common/src/main/java/org/apache/flink/table/types/extraction/DataTypeExtractor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,27 @@ public static DataType extractFromMethodReturnType(
// Methods that extract a data type from a JVM Class with prior logical information
// --------------------------------------------------------------------------------------------

/**
* Extracts a data type from a reflective {@link Field}, honoring a {@link DataTypeHint} on the
* field if present and otherwise falling back to reflective extraction with default templates.
*/
public static DataType extractFromField(DataTypeFactory typeFactory, Field field) {
final DataTypeHint hint = field.getAnnotation(DataTypeHint.class);
final DataTypeTemplate template =
hint != null
? DataTypeTemplate.fromDefaults()
.mergeWithInnerAnnotation(typeFactory, hint)
: DataTypeTemplate.fromDefaults();
return extractDataTypeWithClassContext(
typeFactory,
template,
field.getDeclaringClass(),
field.getGenericType(),
String.format(
" in field '%s' of class '%s'",
field.getName(), field.getDeclaringClass().getName()));
}

public static DataType extractFromStructuredClass(
DataTypeFactory typeFactory, Class<?> implementationClass) {
final DataType dataType =
Expand Down
37 changes: 34 additions & 3 deletions ...le-common/src/main/java/org/apache/flink/table/types/utils/TypeInfoDataTypeConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@
import org.apache.flink.api.java.typeutils.PojoTypeInfo;
import org.apache.flink.api.java.typeutils.RowTypeInfo;
import org.apache.flink.api.java.typeutils.TupleTypeInfoBase;
import org.apache.flink.table.annotation.DataTypeHint;
import org.apache.flink.table.api.DataTypes;
import org.apache.flink.table.catalog.DataTypeFactory;
import org.apache.flink.table.types.DataType;
import org.apache.flink.table.types.DataTypeQueryable;
import org.apache.flink.table.types.extraction.DataTypeExtractor;
import org.apache.flink.table.types.extraction.ExtractionUtils;
import org.apache.flink.table.types.logical.LogicalType;
import org.apache.flink.table.types.logical.RawType;
Expand All @@ -54,6 +56,7 @@
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
Expand Down Expand Up @@ -271,13 +274,37 @@ private static DataType convertToStructuredType(
final String[] fieldNames = compositeType.getFieldNames();
final Class<?> typeClass = compositeType.getTypeClass();

final Map<String, Field> hintedPojoFields;
if (compositeType instanceof PojoTypeInfo) {
final PojoTypeInfo<?> pojoTypeInfo = (PojoTypeInfo<?>) compositeType;
hintedPojoFields = new HashMap<>();
for (int pos = 0; pos < arity; pos++) {
final Field field = pojoTypeInfo.getPojoFieldAt(pos).getField();
if (field.isAnnotationPresent(DataTypeHint.class)) {
hintedPojoFields.put(field.getName(), field);
}
}
} else {
hintedPojoFields = Collections.emptyMap();
}

final Map<String, DataType> fieldDataTypes = new LinkedHashMap<>();
IntStream.range(0, arity)
.forEachOrdered(
pos ->
pos -> {
final String name = fieldNames[pos];
final Field hintedField = hintedPojoFields.get(name);
if (hintedField != null) {
fieldDataTypes.put(
name,
DataTypeExtractor.extractFromField(
dataTypeFactory, hintedField));
} else {
fieldDataTypes.put(
fieldNames[pos],
toDataType(dataTypeFactory, compositeType.getTypeAt(pos))));
name,
toDataType(dataTypeFactory, compositeType.getTypeAt(pos)));
}
});

final List<String> fieldNamesReordered;
final boolean isNullable;
Expand All @@ -297,6 +324,10 @@ private static DataType convertToStructuredType(
// therefore we need to check the reflective field for more details
fieldDataTypes.replaceAll(
(name, dataType) -> {
// hinted fields already resolved through DataTypeExtractor
if (hintedPojoFields.containsKey(name)) {
return dataType;
}
final Class<?> fieldClass =
pojoFields.stream()
.filter(f -> f.getName().equals(name))
Expand Down
32 changes: 31 additions & 1 deletion ...able-common/src/test/java/org/apache/flink/table/types/TypeInfoDataTypeConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.api.java.tuple.Tuple3;
import org.apache.flink.table.annotation.DataTypeHint;
import org.apache.flink.table.api.DataTypes;
import org.apache.flink.table.types.utils.DataTypeFactoryMock;
import org.apache.flink.table.types.utils.TypeInfoDataTypeConverter;
Expand All @@ -32,6 +33,7 @@
import org.junit.jupiter.params.provider.MethodSource;

import java.time.DayOfWeek;
import java.util.HashMap;
import java.util.Optional;
import java.util.stream.Stream;

Expand Down Expand Up @@ -111,7 +113,17 @@ private static Stream<TestSpec> testData() {
.lookupExpects(DayOfWeek.class)
.expectDataType(dummyRaw(DayOfWeek.class)),
TestSpec.forType(Types.VARIANT).expectDataType(DataTypes.VARIANT()),
TestSpec.forType(Types.BITMAP).expectDataType(DataTypes.BITMAP()));
TestSpec.forType(Types.BITMAP).expectDataType(DataTypes.BITMAP()),
TestSpec.forType(Types.POJO(PojoWithHintedMapField.class))
.rawFallback(HashMap.class)
.expectDataType(
DataTypes.STRUCTURED(
PojoWithHintedMapField.class,
DataTypes.FIELD(
"headers",
DataTypes.MAP(DataTypes.STRING(), DataTypes.BYTES())
.bridgedTo(HashMap.class)),
DataTypes.FIELD("id", DataTypes.STRING()))));
}

@ParameterizedTest(name = "{index}: {0}")
Expand Down Expand Up @@ -148,6 +160,11 @@ TestSpec lookupExpects(Class<?> lookupClass) {
return this;
}

TestSpec rawFallback(Class<?> rawClass) {
typeFactory.dataType = Optional.of(dummyRaw(rawClass));
return this;
}

TestSpec expectDataType(DataType expectedDataType) {
this.expectedDataType = expectedDataType;
return this;
Expand Down Expand Up @@ -183,6 +200,19 @@ public PojoWithFieldOrder(String name, boolean gender, int age) {
}
}

/** POJO with a field carrying a {@link DataTypeHint} that overrides reflective extraction. */
public static class PojoWithHintedMapField {

public String id;

@DataTypeHint("MAP<STRING, BYTES>")
public HashMap<String, byte[]> headers;

public PojoWithHintedMapField() {
// default constructor
}
}

/** POJO that defines a field order via an additional constructor. */
@SuppressWarnings("unused")
public static class PojoWithDefaultFieldOrder {
Expand Down