【Java】Vert.x Jackson 序列化后日期数据正常展示

有段时间没有更新了，年尾嘛大家都懂的。

其实最近有个想法，想将自己的 vtx_fw 框架给开源了。但开源之前还是有很多收尾的工作需要做的（总不能让各位笑话吧 o(╥﹏╥)o），这不今天就发现了一个问题，立刻就归纳一下给各位分享。

这个问题就是 Vert.x 框架中日期类型数据在 Jackson 序列化下的展示问题。有玩过 Vert.x 的小伙伴都知道在 vertx-core 包中会默认依赖 jackson-core 包。如果实体类中只包含数字、字符串字段的情况下是可以直接用 Json.encode 进行序列化的。不过一旦遇到日期类型，如 LocalDateTime、Date 这些数据类型就会出现以下抛错，如下图：

io.vertx.core.json.EncodeException: Mapping io.kida.yuen.utils.system.router.RouterValue  is not available without Jackson Databind on the classpath
	at io.vertx.core.json.jackson.JacksonCodec.encodeJson(JacksonCodec.java:329)
	at io.vertx.core.json.jackson.JacksonCodec.toString(JacksonCodec.java:95)
	at io.vertx.core.spi.json.JsonCodec.toString(JsonCodec.java:47)
	at io.vertx.core.json.Json.encode(Json.java:49)
	at io.kida.yuen.dao.crud.SelectDaoMapper.lambda$2(SelectDaoMapper.java:80)
 ...
1
2
3
4
5
6
7

如上图所示，抛错定位到我的一个名为 SelectDaoMapper 类中的 Json.encode 方法，经过排查发现 Json.encode 方法无法将实体进行映射。它建议我引入 jackson-databind 依赖，如下图：

<dependency>
  <groupId>com.fasterxml.jackson.coregroupId>
  <artifactId>jackson-databindartifactId>
dependency>
1
2
3
4

在加入了 jackson-databind 依赖后重新执行方法得出新的报错信息，如下图：

io.vertx.core.json.EncodeException: Failed to encode as JSON: Java 8 date/time type `java.time.LocalDateTime` not supported by default: add Module "com.fasterxml.jackson.datatype:jackson-datatype-jsr310" to enable handling (through reference chain: io.kida.yuen.utils.system.router.RouterValue["retData"]->io.kida.yuen.vo.datasource.DynamicRetData["rows"]->java.util.ArrayList[0]->java.util.TreeMap["accessDate"])
	at io.vertx.core.json.jackson.DatabindCodec.toString(DatabindCodec.java:163)
	at io.vertx.core.spi.json.JsonCodec.toString(JsonCodec.java:47)
	at io.vertx.core.json.Json.encode(Json.java:49)
	at io.kida.yuen.dao.crud.SelectDaoMapper.lambda$2(SelectDaoMapper.java:80)
...
1
2
3
4
5
6

根据错误信息可知，Jackson 不支持 Java 8 的日期类型，想做 Java 日期类型处理需再引入 jackson-datatype-jsr310 依赖。(⊙o⊙)…好吧，如下图：

<dependency>
  <groupId>com.fasterxml.jackson.coregroupId>
  <artifactId>jackson-databindartifactId>
dependency>
<dependency>
  <groupId>com.fasterxml.jackson.datatypegroupId>
  <artifactId>jackson-datatype-jsr310artifactId>
dependency>
1
2
3
4
5
6
7
8
9

在加入依赖后重新执行方法发现报错依然存在（不是说加入 jackson-datatype-jsr310 依赖就可以了吗），于是网上查了查得知在加入 jackson-datatype-jsr310 依赖后还需开启日期模块才能正常解析。如下图：

ObjectMapper mapper = DatabindCodec.mapper();
mapper.registerModule(new JavaTimeModule());
1
2

于是创建一个名为 JacksonConfig 的类并让其继承 AbstractVerticle ，之后重写 start 方法将代码加到里面去就可以了（系统部署 JacksonConfig 时会自动执行 start 方法内代码从而实现自动加载），如下图：

public class JacksonConfig extends AbstractVerticle {

    @Override
    public void start() {
        ObjectMapper mapper = DatabindCodec.mapper();
        mapper.registerModule(new JavaTimeModule());
    }
}
1
2
3
4
5
6
7
8

本以为这次调用方法肯定能够得到自己想要的结果，结果…虽然有返回了，但是日期字段返回的格式并不是我们“想要”的格式，如下图：

{
  "retCode": 1,
  "retMsg": "Search Complete",
  "retData": {
    "rows": [
      {
        "accessDate": [
          2023,
          10,
          17,
          17,
          23,
          21
        ],
        "buzzId": 1,
        "id": 1,
        "ip": "127.0.0.1",
        "operType": "insert"
      }
    ],
    "numRows": 1
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

accessDate 字段在 Java 实体中是一个 LocalDateTime 类型，如下图：

...

@Column(name = "ACCESS_DATE")
private LocalDateTime accessDate;

...
1
2
3
4
5
6

后来得知 Jackson 默认会将日期型数据自动序列化成数组。那么要怎样解决呢？网上能找到的基本有三种解决方案：

1. @JsonFormat 注解来指定格式；
2. 重写 JsonSerializer 来自定义序列化逻辑；
3. 在ObjectMapper中注册自定义序列化器；

但由于我这次是将查询方法封装成工具的，这 3 种方法并不是我心中最优解。最终，我是通过“再转换”来解决这个事情的，如下图：

public static void query(DataSourceExecParam dbem, Handler<DynamicRetData> resultHandler) {
        if (!DataSourceConstants.JDBC_CLIENT_MAP.isEmpty()) {
            DataSourceClientUtil.dbClient(dbem).getConnection(ar -> {
                if (ar.succeeded()) {
                    SQLConnection connection = ar.result();
                    connection.query(dbem.getExecSql(), reHandler -> {
                        if (reHandler.succeeded()) {
                            ResultSet rs = reHandler.result();
                            DynamicRetData add = new DynamicRetData();

                            // 将返回的resultset分解并存入AjaxDyncData中方便后续使用
                            if (null != rs) {
                                // 返回的行数有多少条
                                add.setNumRows(rs.getNumRows());
                                // 获取返回数据集，格式是jsonobject能够与columnName字段做映射 这里设定返回字段大小写不敏感，这样方便统一处理
                                List<JsonObject> list = rs.getRows(true);


                                // ----- 开始
                                list.stream().forEach(jsonObj -> {
                                    jsonObj.stream().filter(entry -> entry.getValue() instanceof LocalDateTime
                                        || entry.getValue() instanceof Date).forEach(entry -> {
                                            LocalDateTime ldt = LocalDateTime.parse(jsonObj.getString(entry.getKey()));
                                            jsonObj.put(entry.getKey(),
                                                ldt.format(DateTimeFormatter.ISO_LOCAL_DATE_TIME).replace("T", " "));
                                        });
                                });
								// ----- 结束

                                
                                add.setRows(list);
                            }
                            resultHandler.handle(add);
                        } else {
                            log.error(QUERY_EXCEPTION_OUTPUT + reHandler.cause());
                            resultHandler.handle(null);
                        }
                    }).close();
                } else {
                    log.error(CREATE_CLIENT_EXCEPTION_OUTPUT + ar.cause());
                    resultHandler.handle(null);
                }
            });
        } else {
            log.error(CREATE_NO_PREPARE_OUTPUT);
            resultHandler.handle(null);
        }
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

上面是我的查询方法，中间用“// ----- 开始”、“// ----- 结束”注释括住的代码就是“再转换”的代码。数据在 rs 也就是 ResultSet 时，时间字段是通过 TreeMap 存储的。这时候它还是“正常”的“日期型”，在 getRows 方法调用后就会自动通过 Jackson 转换了，所以在 list 变量中得到的是日期转换后的数组。

这时我们需要做的就是将转换后的“日期”再重新转换回来，这个时候我们就要用到 LocalDateTime.parse 方法了。调用 LocalDateTime.parse 时会要求传入转换后的时间数组，之后再调用 format 方法将其按照 DateTimeFormatter.ISO_LOCAL_DATE_TIME 格式进行转换，最终出来的日期数据会在“日期”和“时间”中间补一个 “T”关键字，但这个 “T”我们并不需要，于是通过 replace 方法替换掉成空就可以了。这样就能够生成“正常”的日期输出了，如下图：

{
  "retCode": 1,
  "retMsg": "Search Complete",
  "retData": {
    "rows": [
      {
        "accessDate": "2023-10-17 17:23:21",
        "buzzId": 1,
        "id": 1,
        "ip": "127.0.0.1",
        "operType": "insert"
      }
    ],
    "numRows": 1
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16