Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goodforgod/gson-configuration
⚙️ Gson Configuration and DateTime serializers/deserializers for java.time.*
https://github.com/goodforgod/gson-configuration
date datetime deserializer gson gson-adapter java java-8 jsr310 localdatetime serializer time
Last synced: 17 days ago
JSON representation
⚙️ Gson Configuration and DateTime serializers/deserializers for java.time.*
- Host: GitHub
- URL: https://github.com/goodforgod/gson-configuration
- Owner: GoodforGod
- License: mit
- Created: 2021-04-25T20:32:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-23T06:50:07.000Z (over 1 year ago)
- Last Synced: 2024-10-11T19:18:01.543Z (about 1 month ago)
- Topics: date, datetime, deserializer, gson, gson-adapter, java, java-8, jsr310, localdatetime, serializer, time
- Language: Java
- Homepage:
- Size: 229 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Gson Configuration
[](https://github.com/GoodforGod/gson-configuration/actions?query=workflow%3A%22Java+CI%22)
[](https://sonarcloud.io/dashboard?id=GoodforGod_gson-configuration)
[](https://sonarcloud.io/dashboard?id=GoodforGod_gson-configuration)
[](https://sonarcloud.io/dashboard?id=GoodforGod_gson-configuration)
Gson configuration and serializers/deserializers for Date/Time in [java.time.*](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/package-summary.html) package.
## Dependency :rocket:
**Gradle**
```groovy
implementation "io.goodforgod:gson-configuration:2.0.0"
```
**Maven**
```xml
io.goodforgod
gson-configuration
2.0.0
```
## Serializers\Deserializers
Library include serializers & deserializers for most [java.time.*](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/package-summary.html)
datetime objects, supported list:
- Instant
- LocalDate
- LocalTime
- LocalDateTime
- OffsetTime
- OffsetDateTime
- ZonedDateTime
- Year
- YearMonth
- Month
- MonthDay
- DayOfWeek
- ZoneId
- ZoneOffset
## Formatters
Gson Configuration by default comes with [ISO8601 with millis precision](https://goodforgod.dev/posts/2/)
(basically default Java ISO8601 formatters but with millis precision)
Here is list of such formatters:
- LocalDateTime - *uuuu-MM-dd'T'HH:mm:ss[.SSS]*
- LocalDate - *uuuu-MM-dd*
- LocalTime - *HH:mm:ss[.SSS]*
- OffsetDateTime - *uuuu-MM-dd'T'HH:mm:ss[.SSS]XXX*
- OffsetTime - *HH:mm:ss[.SSS]XXX*
- ZonedDateTime - *uuuu-MM-dd'T'HH:mm:ss[.SSS]XXX['['VV']']*
If you want to know more about why use such Java Date & Time formats, you can [read more here](https://goodforgod.dev/posts/2/)
```java
GsonConfiguration configuration = new GsonConfiguration();
```
## Gson Configuration
Library provides configuration for configuring *GsonBuilder* for most properties:
```java
GsonBuilder builder = new GsonConfiguration()
.setDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX")
.setInstantFormat("uuuu-MM-dd HH:mm:ss")
.setComplexMapKeySerialization(true)
.setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE)
.setLongSerializationPolicy(LongSerializationPolicy.STRING)
.setLenient(true)
.setEscapeHtmlChars(false)
.setPrettyPrinting(true)
.setGenerateNonExecutableJson(true)
.setSerializeNulls(true)
.setSerializeSpecialFloatingPointValues(true)
.setExcludeFieldsWithoutExposeAnnotation(true)
.setExcludeFieldsWithModifiers(GsonConfiguration.FieldModifiers.TRANSIENT)
.builder();
```
You can configure DateTimeFormatters for provided adapters:
```java
GsonBuilder builder = new GsonConfiguration()
.setInstantFormat("uuuu-MM-dd HH:mm:ss")
.builder();
```
### Properties file
**By default** Gson or GsonBuilder that is build via GsonConfiguration or GsonFactory **doesn't serialize/deserialize** transient, static, volatile, synchronized fields.
You need to use configuration setters to configure it otherwise.
GsonConfiguration also can be filled from *properties* file.
How to build GsonConfiguration from Properties:
```java
InputStream resource = getClass().getClassLoader().getResourceAsStream("gson.properties");
Properties properties = new Properties();
properties.load(resource);
GsonConfiguration configuration = GsonConfiguration.ofProperties(properties);
```
Full list of properties ([check GsonProperties](https://github.com/GoodforGod/gson-configuration/blob/master/src/main/java/io/gson/adapters/config/GsonProperties.java)):
```properties
gson.format.instant=uuuu-MM-dd'T'HH:mm:ssX
gson.format.localDate=uuuu-MM-dd
gson.format.localTime=HH:mm:ss.SSS
gson.format.localDateTime=uuuu-MM-dd'T'HH:mm:ss.SSS
gson.format.offsetTime=HH:mm:ss.SSSXXX
gson.format.offsetDateTime=uuuu-MM-dd'T'HH:mm:ss.SSSXXX
gson.format.zonedDateTime=uuuu-MM-dd'T'HH:mm:ss.SSSXXX
gson.format.year=uuuu
gson.format.yearMonth=uuuu-MM
gson.format.monthDay=MM-dd
gson.format.date=yyyy-MM-dd'T'HH:mm:ss.SSSXXX
gson.forceIsoChronology=true
gson.forceResolverStrict=true
gson.lenient=true
gson.serializeNulls=true
gson.prettyPrinting=true
gson.escapeHtmlChars=false
gson.generateNonExecutableJson=true
gson.serializeComplexMapKey=true
gson.serializeSpecialFloatingPointValues=true
gson.excludeFieldsWithoutExposeAnnotation=false
gson.excludeFieldsWithModifiers=TRANSIENT,STATIC,SYNCHRONIZED,VOLATILE
gson.policy.fieldNaming=UPPER_CAMEL_CASE
gson.policy.longSerialization=STRING
```
#### Factory
Gson can also be instantiated via properties using *GsonFactory*.
*GsonFactory* is looking for property file in root *resource*: **gson.properties**
```java
Gson gson = new GsonFactory().build();
```
## Gson Builder
All adapters already registered via when using *GsonConfiguration#builder*.
You can register them manually:
```java
GsonBuilder builder = new GsonBuilder()
.registerTypeAdapter(LocalDate.class, LocalDateSerializer.INSTANCE)
```
You can register with custom formatter also:
```java
GsonBuilder builder = new GsonBuilder()
.registerTypeAdapter(LocalDate.class, new LocalDateSerializer(DateTimeFormatters.ISO_LOCAL_DATE))
```
## License
This project licensed under the MIT - see the [LICENSE](LICENSE) file for details.