Azure / Azure/azure-functions-java-worker

[FeatureRequest] Allow customizing the Gson instance for Json serialization

Open
#424 18 comments 3 reactions 1 assignee Claimed by @kaibocai View on GitHub
area:java-functions Enhancement needs-discussion Needs: Attention :wave: New Feature reviewed
Dominant language
Java
Stars
103
Forks
74
Avg merge
4d 8h
Merged PRs (30d)
2

Description

Hi all,

**Current problem**
The Gson instance used by `RpcUnspecifiedDataTarget` is hardcoded in `RpcJsonDataSource`
https://github.com/Azure/azure-functions-java-worker/blob/3ec27b2b82ba96adef593d51b0bb0e9c0063bfaa/src/main/java/com/microsoft/azure/functions/worker/binding/RpcUnspecifiedDataTarget.java#L68
https://github.com/Azure/azure-functions-java-worker/blob/3ec27b2b82ba96adef593d51b0bb0e9c0063bfaa/src/main/java/com/microsoft/azure/functions/worker/binding/RpcJsonDataSource.java#L20
This means that customizing the way the runtime Json-serializes objects (especially dates) is impossible. See #419 and [this on stackoverflow](https://stackoverflow.com/questions/60688436/spring-cloud-function-azure-json-output-with-datetimes).

**Workaround**
I came up with a dirty workaround to replace the used Gson instance with the spring-provided one via Reflection:

`AzureGsonConfig.java`:
```java
@Configuration
@ConditionalOnClass(RpcJsonDataSource.class)
public class AzureGsonConfig {

@SneakyThrows
public AzureGsonConfig(Gson gson) {
final Field gsonField = RpcJsonDataSource.class.getField("gson");
gsonField.setAccessible(true);
final Field modifiersField = Field.class.getDeclaredField("modifiers");
modifiersField.setAccessible(true);
modifiersField.setInt(gsonField, gsonField.getModifiers() & ~Modifier.FINAL);

gsonField.set(null, gson);
}
}
```

This requires a compile-time dependency like this
```grovy
compileOnly files('libs/azure-functions-java-worker.jar')
```
(referencing the runtime as a jar file because I couldn't find it in maven central).

Having replaced the Gson instance means you can have a second configuration that customizes the date serialization behaviour of the one from spring.

`GsonConfig.java`:
```java
@Configuration
public class GsonConfig {

@Bean
GsonBuilderCustomizer dateFormatGsonBuilderCustomizer() {
return gsonBuilder -> {
gsonBuilder.registerTypeAdapter(
LocalDate.class, new LocalDateAdapter()
);
gsonBuilder.registerTypeAdapter(
LocalDateTime.class, new LocalDateTimeAdapter()
);
};
}

static class LocalDateAdapter extends TypeAdapter {

@Override
public void write(final JsonWriter jsonWriter, final LocalDate localDate) throws IOException {
if (localDate == null) {
jsonWriter.nullValue();
} else {
jsonWriter.value(localDate.toString());
}
}

@Override
public LocalDate read(final JsonReader jsonReader) throws IOException {
if (jsonReader.peek() == JsonToken.NULL) {
jsonReader.nextNull();
return null;
} else {
return LocalDate.parse(jsonReader.nextString());
}
}
}

static class LocalDateTimeAdapter extends TypeAdapter {

@Override
public void write(final JsonWriter jsonWriter, final LocalDateTime localDateTime) throws IOException {
if (localDateTime == null) {
jsonWriter.nullValue();
} else {
jsonWriter.value(localDateTime.toString());
}
}

@Override
public LocalDateTime read(final JsonReader jsonReader) throws IOException {
if (jsonReader.peek() == JsonToken.NULL) {
jsonReader.nextNull();
return null;
} else {
return LocalDateTime.parse(jsonReader.nextString());
}
}
}
}
```

While this works, it's not very clean and can break easily.

**Alternative**
Serialize the objects to strings in the functions or handlers and return them as such. Personally, I don't like this approach.

**Feature request**
Somehow allow injecting or customizing the Gson instance used in the azure-functions-worker runtime.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.