We Keep Coding

Populating custom field through jackson

I have a POJO as below:
#Data
#Builder
#AllArgsConstructor
#NoArgsConstructor
#JsonIgnoreProperties(ignoreUnknown = true)
public class CalendarData {
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy HH:mm:ss")
// field to contain formatted date as per clients requirement - shud be mirror of "date"
private String formattedDate;
private long date;
private String errorCode;
private String subErrorCode;
}
Downstream service is only sending date field as epoch and i want to have the formattedDate populated in run time in given format.
I can always write a custom function to format the data, but want to understand is there any native jackson way or custom setter to do that.

You're almost doing it right. However having a #JsonFormat-Annotation on a String field does not make to much sense, because if it already is String, there is nothing to convert for Jackson anymore. You can just make both fields of type Date and the #JsonFormat annotation on the formattedDate field will serialize it into the proper JSON String representation, exactly in the format you specified in the pattern. Jackson will by default serialize all java.util.Date Object of an object it needs to serialize into the epoch milliseconds as a regular JSON number. So this would work for you. However, as both fields in the final JSON will refer to the exact same Date object it feels weird to have them both as fields of the CalendarData object. I would suggest you just give CalendarData a single field date and then create a getter method for the formattedDate field. Here is what this could look like. By default Jackson will pick up all getter functions and serialize their returned data into the generated json object.
#Data
#JsonIgnoreProperties(ignoreUnknown = true)
public class CalendarData {
CalendarData(final Date date) {
this.date = date;
}
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy HH:mm:ss")
private Date getFormattedDate(){
return this.date;
};
private Date date;
}
UPDATE
As you updates you question I also want to update my answer. I recommend you the following (analogous to what I already explained above).
#Data
#Builder
#AllArgsConstructor
#NoArgsConstructor
#JsonIgnoreProperties(ignoreUnknown = true)
public class CalendarData {
private Date date;
private String errorCode;
private String subErrorCode;
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd/MM/yyyy HH:mm:ss")
// field to contain formatted date as per clients requirement - shud be mirror of "date"
private Date getFormattedDate(){
return this.date;
};
}
Then in my main I tried it out
public static void main(String[] args) throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
CalendarData data = CalendarData.builder()
.errorCode("23")
.subErrorCode("42")
.date(new Date())
.build();
System.out.println(mapper.writeValueAsString(data));
}
Which perfectly prints out
{
"date": 1676642216673,
"errorCode": "23",
"subErrorCode": "42",
"formattedDate": "17/02/2023 13:56:56"
}

Java LocalDate - Time gets appended onto date when saving in MongoDB?

I have the following Java Entity:
public class Round {
private ObjectId _id;
#NotEmpty
#Getter
#Setter
#Accessors(fluent = true)
#JsonProperty("userId")
private String userId;
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy")
#JsonDeserialize(using = LocalDateDeserializer.class)
#JsonSerialize(using = LocalDateSerializer.class)
#Getter
#Setter
#Accessors(fluent = true)
#JsonProperty("date")
private LocalDate date;
//other fields
}
When I do a POST to my Spring Boot REST web app with JSON Body:
{
"userId": "user3",
"date": "20-01-2020"
}
The date is persisted in Mongo as follows:
2020-01-20T00:00:00.000+00:00
How can I get the date to persist as simply:
20-01-2020

It's not Java problem, MongoDB uses Date format similar to JavaScript Date format.
If you want to save just dd-MM-YYYY you may want to change your column type to String.
If it's not possible then you need to rewrite your serializer to return String representation of date (and of course rewrite deserializer to parse that string into LocalDate

JacksonMapper Date deserialization with UTC time zone fails with given format

I know there are many duplicate questions about the same issue, however, I wasn't able to deserialize given date format into java.util.Date object. The client api I am using returns date fields with 6 digit combined with milliseconds and nanoseconds.
2016-12-08T20:09:05.508883Z
2016-12-08T20:09:05.527Z
Sometimes it includes nano seconds sometimes not. I tried to follow deserialization examples from jackson-databind library itself however couldn't found a workaround. Say this is the example json blob
{
"id": "68e6a28f-ae28-4788-8d4f-5ab4e5e5ae08",
"created_at": "2016-12-08T20:09:05.508883Z",
"done_at": "2016-12-08T20:09:05.527Z"
}
Entity.java
#Data
#JsonIgnoreProperties(ignoreUnknown = true)
public class OrderResponse {
private String id;
#JsonProperty("created_at")
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss'*'", timezone = "UTC")
private Date createdAt;
#JsonProperty("done_at")
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss'*'", timezone = "UTC")
private Date doneAt;
}
If I only use format yyyy-MM-dd'T'HH:mm:ss jackson mapper deserializes with timezone coming from jvm itself. But I need to use UTC format and I tried also implementing custom deserializer and serializer which doesn't work as well. My question is java.util.Date correct object type? Additionally, I also tried to create my own object mapper with registering new JavaTimeModule() but it didn't work.
Thanks for help.

I found that java.time.format.DateTimeFormatter has ISO_INSTANT format type which supports the format I was looking for.
https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#ISO_INSTANT
Basically, I wrote my custom deserializer
public class CustomInstantDeserializer extends JsonDeserializer<Instant> {
private DateTimeFormatter fmt = DateTimeFormatter.ISO_INSTANT.withZone(ZoneOffset.UTC);
#Override
public Instant deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
return Instant.from(fmt.parse(p.getText()));
}
}
with #JsonDeserialize annotation on related field.
#JsonProperty("created_at")
#JsonDeserialize(using = CustomInstantDeserializer.class)
private Instant createdAt;

Java json response shows date in numeric value

#Data
public class Reponse {
private String event;
#Temporal(TemporalType.TIMESTAMP)
private Date eventDate;
private Double amount;
}
Json response is like
{
event: "transcation',
eventDate: 1213123434,
amount: 100
}
Here, eventDate is showing numeric value 1540317600000 instead of 2018-10-23

You can annotated the field with #JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm"). Then, response time format will be like "yyyy-MM-dd HH:mm"
import com.fasterxml.jackson.annotation.JsonFormat;
public class Reponse {
private String event;
#Temporal(TemporalType.TIMESTAMP)
#JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm")
private Date eventDate;
private Double amount;
}

If you use Spring boot 2.x instead 1.x ,the default behavior has changed
add spring.jackson.serialization.write-dates-as-timestamps=true to your configuration to return to the previous behavior
Spring Boot 2.0 Migration Guide

spring 2.x flipped a Jackson configuration default to write JSR-310 dates as ISO-8601 strings. If you wish to return to the previous behavior, you can add
spring.jackson.serialization.write-dates-as-timestamps=true
to your application-context configuration file.

I suppose you are using rest framework such as spring boot or jersey which in turn
converts your java date into epoch format before sending it to the client. So while
sending response you can format you date into the format you want. Please refer
the code below.
import java.text.SimpleDateFormat;
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.S");
sdf.setLenient(false);
String responseDate = sdf.format(date);

Spring Data (Rest): Date serialization mapping returns a wrong value

I use Spring Boot and Data Rest to create a simple microservice in Java8 and get a wrong serialized value in a Date attribute in my JSON response.
My entity:
#Entity
public class ArchivedInvoice implements Serializable {
...
#Column
private java.util.Date invoiceDate;
...
}
My repository interface:
#RepositoryRestResource(collectionResourceRel = "archivedinvoices", path = "archivedinvoices")
public interface ArchivedInvoiceRepository extends PagingAndSortingRepository < ArchivedInvoice, Long > {
...
#RestResource(rel = "findByDate", path = "findByDate")
public Page< ArchivedInvoice > findByInvoiceDate(#Param("invoiceDate") #Nullable #DateTimeFormat(iso = ISO.DATE) Date invoiceDate, Pageable pageable);
...
}
Postgres saves the attribute in a simple date (invoice_date date NOT NULL - '2016-02-22') but the JSON response returns:
"invoiceDate" : "2016-02-21T23:00:00.000+0000"
How can I avoid this?

java.util.Date is actually a timestamp:
The class Date represents a specific instant in time, with millisecond
precision.
Use java.sql.Date instead if the SQL type is date.
Or if you use java 8, you can try using java.time.LocalDate. For that to work you will need to register Springs JSR310 JPA converters.