Exception when serializing `java.time.Instant` properties annotated with `@JsonFormat` #2980

acisternino · 2024-07-29T14:27:53Z

In our app we'd like to annotate a bean's j.t.Instant property with Jackson's @JsonFormat in order to have a precise format that's needed by the message receiver.

In particular, the annotated property is this:

@JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSZ")
private Instant timestamp;

However, when sending a Message containing the aforementioned bean we get an exception:

java.lang.NullPointerException: Cannot invoke "Object.getClass()" because "result" is null
        at org.springframework.cloud.function.cloudevent.CloudEventsFunctionInvocationHelper.doPostProcessResult(CloudEventsFunctionInvocationHelper.java:138) ~[spring-cloud-function-context-4.1.3.jar:4.1.3]
        at org.springframework.cloud.function.cloudevent.CloudEventsFunctionInvocationHelper.postProcessResult(CloudEventsFunctionInvocationHelper.java:114) ~[spring-cloud-function-context-4.1.3.jar:4.1.3]
        at org.springframework.cloud.function.cloudevent.CloudEventsFunctionInvocationHelper.postProcessResult(CloudEventsFunctionInvocationHelper.java:48) ~[spring-cloud-function-context-4.1.3.jar:4.1.3]
        at org.springframework.cloud.stream.function.StreamBridge.send(StreamBridge.java:214) ~[spring-cloud-stream-4.1.3.jar:4.1.3]
        at org.springframework.cloud.stream.function.StreamBridge.send(StreamBridge.java:168) ~[spring-cloud-stream-4.1.3.jar:4.1.3]
        at org.springframework.cloud.stream.function.StreamBridge.send(StreamBridge.java:163) ~[spring-cloud-stream-4.1.3.jar:4.1.3]
        at com.example.demo_cloud.DemoController.sendDomainObjectInstant(DemoController.java:57) ~[main/:na]
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103) ~[na:na]
        at java.base/java.lang.reflect.Method.invoke(Method.java:580) ~[na:na]
        at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:255) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:188) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:118) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:926) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:831) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1089) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:979) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1014) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:914) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:590) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:885) ~[spring-webmvc-6.1.11.jar:6.1.11]
        at jakarta.servlet.http.HttpServlet.service(HttpServlet.java:658) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:195) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:51) ~[tomcat-embed-websocket-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116) ~[spring-web-6.1.11.jar:6.1.11]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116) ~[spring-web-6.1.11.jar:6.1.11]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.springframework.web.filter.ServerHttpObservationFilter.doFilterInternal(ServerHttpObservationFilter.java:113) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116) ~[spring-web-6.1.11.jar:6.1.11]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201) ~[spring-web-6.1.11.jar:6.1.11]
        at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:116) ~[spring-web-6.1.11.jar:6.1.11]
        at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:164) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:140) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:167) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:90) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:483) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:115) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:93) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:74) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:344) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:389) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:63) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:904) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1741) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:52) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1190) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:63) ~[tomcat-embed-core-10.1.26.jar:10.1.26]
        at java.base/java.lang.Thread.run(Thread.java:1583) ~[na:na]

The demo application I used to get the stack trace is a very simple Spring Boot project where a simple controller reacts to a POST request by creating a Message and sending it with the default StreamBridge to a simple output binding to a RabbitMQ broker.

This is the code in the controller's method:

// Object containing a few time-related properties
var domObj = new DomainObjectInstant();

Message<DomainObjectInstant> payload = MessageBuilder.withPayload(domObj).build();

// Simple output binding configured in application.yml
// StreamBridge is the default one injected in the controller
streamBridge.send("testError-out-0", payload);

Spring Cloud configuration:

spring:
  cloud:
    stream:
      bindings:
        testError-out-0:
          destination: dummyexchange.test

Versions

Java 21
Spring Boot: 3.3.2
Spring Cloud: 2023.0.3

Notes

The stange thing is that java.util.Date and other java.time classes work as expected!
The issue is specific of java.time.Instant.

The same happens with Spring Boot 3.3.1 and/or Spring Cloud 2023.0.2.

Possibly related to spring-cloud/spring-cloud-function#1189?

The text was updated successfully, but these errors were encountered:

sobychacko · 2024-07-30T15:41:57Z

@acisternino, could you provide a minimal application where we can reproduce the issue? Thanks!

acisternino · 2024-07-31T09:17:39Z

Yes, but I might need a couple of days.

acisternino · 2024-08-02T12:03:58Z

Here it is:

https://github.com/acisternino/spring-cloud-serialization-bugs

sobychacko · 2024-10-02T15:21:30Z

Backport to 4.1.x.

olegz · 2024-10-07T11:55:31Z

I am not sure what we can do here as Instant could not be serialized without specifying Timezone.
In other words this is the wrong formatting

@JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSZ")
private Instant timestamp;

. . . however if you add timezone than it works

@JsonFormat(shape = Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSSZ", timezone = "UTC")
private Instant instant;

olegz · 2024-10-07T14:31:45Z

Also, you can see that you don't need much to reproduce it

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());
String value = mapper.writeValueAsString(new AnnotatedInstantThrows());
// wil end up in exception unless timezone is specified in `AnnotatedInstantThrows`

olegz · 2024-10-16T17:56:06Z

@acisternino Have you seen my last comment? We will certainly fix the Cannot invoke "Object.getClass()" because "result" is null issue, but the root issue is that your annotated format instruction must contain timezone. . .

Let me know your thoughts

acisternino · 2024-10-22T07:13:07Z

Hi @olegz

I agree. the correct behavior is to specify the timezone in the annotation.

I don't know why it used to work before. Maybe Jackson was more lenient in a previous release.

Thank you for the support. I think this can be closed.

olegz self-assigned this Aug 20, 2024

olegz added this to the 4.1.4 milestone Aug 20, 2024

sobychacko mentioned this issue Oct 2, 2024

Change in serialization format for j.u.Date and java.time classes spring-cloud/spring-cloud-function#1189

Closed

sobychacko modified the milestones: 4.1.4, 4.2.0-M2 Oct 2, 2024

olegz added the waiting-on-feedback label Oct 7, 2024

olegz removed this from the 4.2.0-M2 milestone Oct 8, 2024

acisternino closed this as completed Oct 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Exception when serializing `java.time.Instant` properties annotated with `@JsonFormat` #2980

Exception when serializing `java.time.Instant` properties annotated with `@JsonFormat` #2980

acisternino commented Jul 29, 2024

sobychacko commented Jul 30, 2024

acisternino commented Jul 31, 2024

acisternino commented Aug 2, 2024

sobychacko commented Oct 2, 2024

olegz commented Oct 7, 2024

olegz commented Oct 7, 2024

olegz commented Oct 16, 2024

acisternino commented Oct 22, 2024

Exception when serializing java.time.Instant properties annotated with @JsonFormat #2980

Exception when serializing java.time.Instant properties annotated with @JsonFormat #2980

Comments

acisternino commented Jul 29, 2024

Versions

Notes

sobychacko commented Jul 30, 2024

acisternino commented Jul 31, 2024

acisternino commented Aug 2, 2024

sobychacko commented Oct 2, 2024

olegz commented Oct 7, 2024

olegz commented Oct 7, 2024

olegz commented Oct 16, 2024

acisternino commented Oct 22, 2024

Exception when serializing `java.time.Instant` properties annotated with `@JsonFormat` #2980

Exception when serializing `java.time.Instant` properties annotated with `@JsonFormat` #2980