Skip to content

Commit

Permalink
feat(core): Jackson配置优化 (#761)
Browse files Browse the repository at this point in the history 
* feat(core): Jackson配置优化

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

* test: 测试示例修改

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>

---------

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
  • Loading branch information
@unknowIfGuestInDream
unknowIfGuestInDream committed Sep 24, 2023
1 parent 8f97804 commit 11efd7c
Show file tree
Hide file tree
Showing 5 changed files with 300 additions and 58 deletions.
16 changes: 16 additions & 0 deletions core/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -186,4 +186,20 @@
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>${maven-surefire-plugin.version}</version>
<configuration>
<excludes>
<!-- 执行测试时由于引用了Assertions以及jackson在module.info中是static, 执行会失败，因此排除 -->
<exclude>**/JacksonTest.java</exclude>
</excludes>
</configuration>
</plugin>
</plugins>
</build>

</project>
114 changes: 104 additions & 10 deletions core/src/main/java/com/tlcsdm/core/util/JacksonUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,26 @@
package com.tlcsdm.core.util;

import cn.hutool.log.StaticLog;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.json.JsonReadFeature;
import com.fasterxml.jackson.core.json.JsonWriteFeature;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.json.JsonMapper;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.TimeZone;

/**
* 转换bean时，需要opens bean所在包
Expand All @@ -62,19 +70,105 @@ public class JacksonUtil {
private static final JsonMapper mapper = JsonMapper.builder()
// 反序列化时忽略json中存在但Java对象不存在的属性
.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
// 序列化时日期格式默认为yyyy-MM-dd'T'HH:mm:ss.SSSZ
.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false).build();

static {
// 序列化时自定义时间日期格式
mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
// 序列化时忽略值为null的属性
mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
// 将null反序列化为基本数据类型是否报错
.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, false)
// 无明确类型时，是否将json数组反序列化为java数组（若是true，就对应Object[] ,反之就是List<?>）
.configure(DeserializationFeature.USE_JAVA_ARRAY_FOR_JSON_ARRAY, false)
// 出现重复的json字段是否报错
.configure(DeserializationFeature.FAIL_ON_READING_DUP_TREE_KEY, false)
// 如果json中出现了java实体字段中已显式标记应当忽略的字段，是否报错
.configure(DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES, false)
// 是否将空字符("")串当作null对象
.configure(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT, false)
// 是否接受将空数组("[]")作为null
.configure(DeserializationFeature.ACCEPT_EMPTY_ARRAY_AS_NULL_OBJECT, false)
// 是否接受将浮点数作为整数
.configure(DeserializationFeature.ACCEPT_FLOAT_AS_INT, true)
// 读取到未知的枚举当作null
.configure(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_AS_NULL, false)
// 反序列化是否会适应DeserializationContext#getTimeZone()提供的时区 （此特性仅对java8的时间/日期有效）
.configure(DeserializationFeature.ADJUST_DATES_TO_CONTEXT_TIME_ZONE, true)
// 返回的java.util.date转换成时间戳
.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, true)
// 将DURATIONS转换成时间戳
.configure(SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS, true)
// 是否将单个元素的集合展开，（即：去除数组符号"[]"）
.configure(SerializationFeature.WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED, false)
// map序列化后，是否用key对其排序
.configure(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS, false)
// 是否使用缩进，格式化输出
.configure(SerializationFeature.INDENT_OUTPUT, false)
// 使用getter取代setter探测属性，这是针对集合类型，可以直接修改集合的属性
.configure(MapperFeature.USE_GETTERS_AS_SETTERS, true)
// 如何处理transient字段，如果true(不能访问此属性) ，若是false则不能通过字段访问（还是可以使用getter和setter访问）
.configure(MapperFeature.PROPAGATE_TRANSIENT_MARKER, false)
// 是否自动检测字段 （若true,则将所有public实例字段视为为属性）
.configure(MapperFeature.AUTO_DETECT_FIELDS, true)
// getter方法必需要有对应的setter或字段或构造方法参数，才能视为一个属性
.configure(MapperFeature.REQUIRE_SETTERS_FOR_GETTERS, false)
// 是否可以修改final成员字段
.configure(MapperFeature.ALLOW_FINAL_FIELDS_AS_MUTATORS, true)
// 是否能推断属性，(即使用字段和setter是不可见的，但getter可见即可推断属性)
.configure(MapperFeature.INFER_PROPERTY_MUTATORS, true)
// 调用AccessibleObject#setAccessible设为true .将原来不可见的属性，变为可见
.configure(MapperFeature.CAN_OVERRIDE_ACCESS_MODIFIERS, true)
// 按字母表顺序序列化字段（若false，按字段声明的顺序）
.configure(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY, false)
// 反序列化属性时不区分大小写 （true时，会影响性能）
.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, false)
// 枚举反序列化不区别大小写
.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_ENUMS, false)
// 允许解析一些枚举的基于文本的值类型但忽略反序列化值的大小写 如日期/时间类型反序列化器
.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_VALUES, false)
// 是否允许json注解（Json规范是不能加注释的，但这里可以配置）
.enable(JsonReadFeature.ALLOW_JAVA_COMMENTS)
// 是否允许对所有字符都可加反斜杠转义
.enable(JsonReadFeature.ALLOW_BACKSLASH_ESCAPING_ANY_CHARACTER)
// 是否允许出现字段名不带引号
.enable(JsonReadFeature.ALLOW_UNQUOTED_FIELD_NAMES)
// 是否允许json数组中出现缺失值 （如["value1",,"value3",]将被反序列化为["value1", null, "value3", null]）
.disable(JsonReadFeature.ALLOW_MISSING_VALUES)
// 是否允许出现yaml注释
.disable(JsonReadFeature.ALLOW_YAML_COMMENTS)
// 是否允许json尾部有逗号 （如{"a": true,}）
.disable(JsonReadFeature.ALLOW_TRAILING_COMMA)
// 确定分析程序是否允许 JSON 字符串包含不带引号的控制字符（值小于 32 的 ASCII 字符，包括制表符和换行符）的功能。
// 如果功能设置为 false，则在遇到此类字符时将引发异常
.enable(JsonReadFeature.ALLOW_UNESCAPED_CONTROL_CHARS)
// 是否允许出现单引号,默认false
.enable(JsonReadFeature.ALLOW_SINGLE_QUOTES)
// 是否自动关闭不属于生成器的底层输出流
.enable(JsonGenerator.Feature.AUTO_CLOSE_TARGET)
// 是否自动补全json(当有不匹配的JsonToken#START_ARRAY JsonToken#START_OBJECT时)
.enable(JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT)
// 是否刷新generator
.enable(JsonGenerator.Feature.FLUSH_PASSED_TO_STREAM)
// 非ASCII码是否需要转义
.disable(JsonWriteFeature.ESCAPE_NON_ASCII)
// 属性序列化的可见范围
.visibility(PropertyAccessor.GETTER, JsonAutoDetect.Visibility.NON_PRIVATE)
// 属性反序列化的可见范围
.visibility(PropertyAccessor.SETTER, JsonAutoDetect.Visibility.PROTECTED_AND_PUBLIC)
// 静态工厂方法的反序列化
.visibility(PropertyAccessor.CREATOR, JsonAutoDetect.Visibility.PUBLIC_ONLY)
// 字段
.visibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.PUBLIC_ONLY)
// 布尔的序列化
.visibility(PropertyAccessor.IS_GETTER, JsonAutoDetect.Visibility.PUBLIC_ONLY)
// 时区
.defaultTimeZone(TimeZone.getTimeZone("GMT+:08:00"))
// 当地时区
.defaultLocale(Locale.getDefault())
// 序列化时忽略值为默认值的属性
mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);
}
.defaultPropertyInclusion(JsonInclude.Value.construct(JsonInclude.Include.NON_DEFAULT, JsonInclude.Include.NON_DEFAULT))
// 序列化时忽略值为null的属性
.serializationInclusion(JsonInclude.Include.NON_NULL)
// 序列化时自定义时间日期格式
.defaultDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"))
.build();

private JacksonUtil() {

}

/**
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/module-info.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@

opens com.tlcsdm.core.javafx.controller to javafx.fxml;
opens com.tlcsdm.core.javafx.view to javafx.fxml;
opens com.tlcsdm.core.util to org.junit.platform.engine;
opens com.tlcsdm.core.util to org.junit.platform.engine, org.junit.jupiter.api;

exports com.tlcsdm.core.javafx;
exports com.tlcsdm.core.javafx.control;
Expand Down
Loading

0 comments on commit 11efd7c

Please sign in to comment.