[#10114] Add Jackson Util

commons-server/pom.xml

@@ -93,6 +93,10 @@
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework</groupId>
+            <artifactId>spring-web</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot</artifactId>

commons-server/src/main/java/com/navercorp/pinpoint/common/server/util/json/Jackson.java

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2023 NAVER Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.navercorp.pinpoint.common.server.util.json;
+
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.databind.Module;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import org.springframework.beans.BeanUtils;
+import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
+import org.springframework.util.ClassUtils;
+
+import java.lang.reflect.Constructor;
+
+public final class Jackson {
+
+    private static final Module parameterNamesModule = getParameterNamesModule();
+
+    private Jackson() {
+    }
+
+    @SuppressWarnings("unchecked")
+    private static Module getParameterNamesModule() {
+        try {
+            Class<? extends Module> parameterNamesModuleClass = (Class<? extends Module>)
+                    ClassUtils.forName("com.fasterxml.jackson.module.paramnames.ParameterNamesModule", Jackson.class.getClassLoader());
+            Constructor<? extends Module> constructor = parameterNamesModuleClass.getConstructor(JsonCreator.Mode.class);
+            return BeanUtils.instantiateClass(constructor, JsonCreator.Mode.DEFAULT);
+        } catch (ReflectiveOperationException ignore) {
+            return null;
+        }
+    }
+
+    public static ObjectMapper newMapper() {
+        Jackson2ObjectMapperBuilder builder = newBuilder();
+        return builder.build();
+    }
+
+    public static Jackson2ObjectMapperBuilder newBuilder() {
+        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
+        if (parameterNamesModule != null ) {
+            builder.modulesToInstall(parameterNamesModule);
+        }
+        builder.featuresToDisable(
+                SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,
+                SerializationFeature.WRITE_DURATIONS_AS_TIMESTAMPS
+        );
+        return builder;
+    }
+
+
+}

commons-server/src/test/java/com/navercorp/pinpoint/common/server/util/json/JacksonTest.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2023 NAVER Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.navercorp.pinpoint.common.server.util.json;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.util.Objects;
+
+class JacksonTest {
+
+    @Test
+    void newMapper() throws JsonProcessingException {
+        ObjectMapper mapper = Jackson.newMapper();
+
+        User user1 = new User();
+        user1.setName("abc");
+
+        String json = mapper.writeValueAsString(user1);
+
+        User user2 = mapper.readValue(json, User.class);
+
+        Assertions.assertThat(user1).isEqualTo(user2);
+    }
+
+    static class User {
+        private String name;
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        @Override
+        public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+
+            User user = (User) o;
+
+            return Objects.equals(name, user.name);
+        }
+
+        @Override
+        public int hashCode() {
+            return name != null ? name.hashCode() : 0;
+        }
+    }
+}

inspector-module/inspector-web/pom.xml

@@ -23,6 +23,10 @@
             <artifactId>pinpoint-commons</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.navercorp.pinpoint</groupId>
+            <artifactId>pinpoint-commons-server</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.navercorp.pinpoint</groupId>
             <artifactId>pinpoint-web</artifactId>

inspector-module/inspector-web/src/main/java/com/navercorp/pinpoint/inspector/web/dao/pinot/MultiValueTagTypeHandler.java

@@ -18,41 +18,37 @@
 
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.DeserializationContext;
 import com.fasterxml.jackson.databind.JsonDeserializer;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
-import com.fasterxml.jackson.databind.type.TypeFactory;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.metric.common.model.Tag;
 import com.navercorp.pinpoint.metric.web.util.TagUtils;
 import org.apache.ibatis.type.JdbcType;
 import org.apache.ibatis.type.TypeHandler;
-import org.apache.pinot.common.utils.PinotDataType;
 
-import java.io.ByteArrayInputStream;
 import java.io.IOException;
-import java.io.ObjectInputStream;
-import java.sql.Array;
 import java.sql.CallableStatement;
 import java.sql.PreparedStatement;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Map;
 
 /**
  * @author minwoo.jung
  */
 public class MultiValueTagTypeHandler implements TypeHandler<List<Tag>> {
 
-    private final static ObjectMapper OBJECT_MAPPER;
+    private final static ObjectMapper OBJECT_MAPPER = getMapper();
+    private final TypeReference<List<Tag>> REF_LIST_TAG = new TypeReference<>() {
+    };
 
-    static {
-        OBJECT_MAPPER = new ObjectMapper();
-        SimpleModule module = new SimpleModule();
-        module.addDeserializer(List.class, new CustomObjectListDeserializer());
-        OBJECT_MAPPER.registerModule(module);
+    private static ObjectMapper getMapper() {
+        return Jackson.newBuilder()
+                .deserializerByType(List.class, new CustomObjectListDeserializer())
+                .build();
     }
 
     @Override
@@ -65,8 +61,7 @@ public List<Tag> getResult(ResultSet rs, String columnName) throws SQLException
         String jsonString = rs.getString(columnName);
 
         try {
-            List<Tag> tagList = OBJECT_MAPPER.readValue(jsonString, TypeFactory.defaultInstance().constructCollectionType(List.class, Tag.class));
-            return tagList;
+            return OBJECT_MAPPER.readValue(jsonString, REF_LIST_TAG);
         } catch (JsonProcessingException e) {
             throw new SQLException(e);
         }
@@ -87,10 +82,14 @@ private List<Tag> createTagList(Object tagValues) {
     }
 
     static class CustomObjectListDeserializer extends JsonDeserializer<List<Tag>> {
+
+        private static final TypeReference<List<String>> REF = new TypeReference<>() {
+        };
+
         @Override
         public List<Tag> deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
-            List<String> list = jsonParser.readValueAs(ArrayList.class);
 
+            List<String> list = jsonParser.readValueAs(REF);
             List<Tag> tagList = new ArrayList<>();
             for (String tagString : list) {
                 Tag tag = TagUtils.parseTag(tagString);

metric-module/metric/src/main/java/com/navercorp/pinpoint/metric/common/model/mybatis/TagListTypeHandler.java

@@ -17,7 +17,7 @@
 package com.navercorp.pinpoint.metric.common.model.mybatis;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.module.SimpleModule;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.metric.common.model.Tag;
 import com.navercorp.pinpoint.metric.common.model.json.Tags;
 import org.apache.ibatis.type.JdbcType;
@@ -37,19 +37,16 @@
  * @author minwoo.jung
  */
 @MappedJdbcTypes({JdbcType.VARCHAR})
-public class  TagListTypeHandler implements TypeHandler<List<Tag>> {
+public class TagListTypeHandler implements TypeHandler<List<Tag>> {
 
     private final Logger logger = LogManager.getLogger(this.getClass());
-    private final static ObjectMapper OBJECT_MAPPER = createObjectMapper();
+    private final static ObjectMapper OBJECT_MAPPER = getMapper();
 
 
-    public static ObjectMapper createObjectMapper() {
-        ObjectMapper objectMapper = new ObjectMapper();
-
-        SimpleModule module = new SimpleModule();
-        Class<List<Tag>> type = ((Class) List.class);
-        module.addSerializer(type, new TagMySqlSerializer());
-        return objectMapper.registerModule(module);
+    static ObjectMapper getMapper() {
+        return Jackson.newBuilder()
+                .serializerByType(List.class, new TagMySqlSerializer())
+                .build();
     }
 
     @Override

metric-module/metric/src/test/java/com/navercorp/pinpoint/metric/collector/model/serialize/TelegrafJsonDeserializerTest.java

@@ -1,6 +1,7 @@
 package com.navercorp.pinpoint.metric.collector.model.serialize;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.metric.collector.model.TelegrafMetric;
 import com.navercorp.pinpoint.metric.collector.model.TelegrafMetrics;
 import org.apache.logging.log4j.LogManager;
@@ -17,7 +18,7 @@
 public class TelegrafJsonDeserializerTest {
     private final Logger logger = LogManager.getLogger(this.getClass());
 
-    private final ObjectMapper mapper = new ObjectMapper();
+    private final ObjectMapper mapper = Jackson.newMapper();
 
 
     @Test

metric-module/metric/src/test/java/com/navercorp/pinpoint/metric/common/model/SystemMetricSerializerTest.java

@@ -18,7 +18,7 @@
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.navercorp.pinpoint.metric.common.model.Tag;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.metric.collector.view.SystemMetricView;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -33,7 +33,7 @@
 public class SystemMetricSerializerTest {
 
     private final Logger logger = LogManager.getLogger(this.getClass());
-    private final ObjectMapper mapper = new ObjectMapper();
+    private final ObjectMapper mapper = Jackson.newMapper();
 
     @Test
     public void testLongCounterWithTags() throws JsonProcessingException {

metric-module/metric/src/test/java/com/navercorp/pinpoint/metric/common/model/mybatis/TagListTypeHandlerTest.java

@@ -17,7 +17,7 @@ public class TagListTypeHandlerTest {
 
     @Test
     public void test() throws JsonProcessingException {
-        ObjectMapper mapper = TagListTypeHandler.createObjectMapper();
+        ObjectMapper mapper = TagListTypeHandler.getMapper();
 
         List<Tag> list = List.of(
                 new Tag("a", "1"),

web/src/main/java/com/navercorp/pinpoint/web/websocket/message/PinpointWebSocketMessageConverter.java

@@ -19,10 +19,11 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.common.server.util.json.TypeRef;
 import com.navercorp.pinpoint.common.util.StringUtils;
-import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 
 import java.io.IOException;
 import java.util.Map;
@@ -40,7 +41,7 @@ public class PinpointWebSocketMessageConverter {
 
     private static final Logger LOGGER = LogManager.getLogger(PinpointWebSocketMessageConverter.class);
 
-    private static final ObjectMapper JSON_SERIALIZER = new ObjectMapper();
+    private static final ObjectMapper JSON_SERIALIZER = Jackson.newMapper();
 
     private final String pingMessage;
     private final String pongMessage;

web/src/test/java/com/navercorp/pinpoint/web/applicationmap/ApplicationMapTest.java

@@ -17,7 +17,7 @@
 package com.navercorp.pinpoint.web.applicationmap;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.common.server.util.time.Range;
 import com.navercorp.pinpoint.web.applicationmap.link.LinkList;
 import com.navercorp.pinpoint.web.applicationmap.nodes.NodeList;
@@ -33,19 +33,12 @@
 public class ApplicationMapTest {
     private final Logger logger = LogManager.getLogger(this.getClass());
 
-    private final ObjectMapper MAPPER = newObjectMapper();
-
-    private ObjectMapper newObjectMapper() {
-        ObjectMapper mapper = new ObjectMapper();
-        mapper.registerModule(new JavaTimeModule());
-        return mapper;
-    }
-
+    private final ObjectMapper mapper = Jackson.newMapper();
 
     @Test
     public void root() throws IOException {
         ApplicationMap app = new DefaultApplicationMap(Range.between(0, 1), new NodeList(), new LinkList());
-        String s = MAPPER.writeValueAsString(app);
+        String s = mapper.writeValueAsString(app);
         logger.debug(s);
     }
 }

web/src/test/java/com/navercorp/pinpoint/web/applicationmap/histogram/AgentTimeHistogramTest.java

@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.core.JsonFactory;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.navercorp.pinpoint.common.server.util.json.Jackson;
 import com.navercorp.pinpoint.common.server.util.time.Range;
 import com.navercorp.pinpoint.common.trace.ServiceType;
 import com.navercorp.pinpoint.web.util.TimeWindow;
@@ -46,7 +47,7 @@ public class AgentTimeHistogramTest {
 
     private final Logger logger = LogManager.getLogger(this.getClass());
 
-    private final ObjectMapper mapper = new ObjectMapper();
+    private final ObjectMapper mapper = Jackson.newMapper();
 
     @Test
     public void testViewModel() throws IOException {