目錄
文章目錄
- 一,Fastjson到Jackson的替換方案
- 方案代碼
- 序列化
- 反序列化
- 通過key獲取某種類型的值
- 類型替換
- 二,Springboot工程中序列化的使用場景
- 三,SpringMVC框架中的Http消息轉換器
- 1,原理:
- 2,自定義消息轉換器
- Fastjson序列化消息轉換器定義:
- Jackson序列化消息轉換器定義:
- 3,Jackson常用注解自定義序列化規則
一,Fastjson到Jackson的替換方案
方案代碼
package main.java.solutions;import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.MapperFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.extern.slf4j.Slf4j;import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;/*** json工具類* @Date: 2023/7/4 14:38*/
@Slf4j
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class JsonUtil {/*** 這個是提供給http接口使用的對象*/private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();static {// 通過該方法對mapper對象進行設置,所有序列化的對象都將按改規則進行系列化// Include.Include.ALWAYS 默認// Include.NON_DEFAULT 屬性為默認值不序列化// Include.NON_EMPTY 屬性為 空("") 或者為 NULL 都不序列化,則返回的json是沒有這個字段的。這樣對移動端會更省流量// Include.NON_NULL 屬性為NULL 不序列化OBJECT_MAPPER.setSerializationInclusion(JsonInclude.Include.NON_NULL);OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);OBJECT_MAPPER.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS, true);OBJECT_MAPPER.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);OBJECT_MAPPER.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);OBJECT_MAPPER.configure(MapperFeature.ACCEPT_CASE_INSENSITIVE_PROPERTIES, true);SimpleModule module = new SimpleModule();module.addSerializer(BigDecimal.class, ToStringSerializer.instance);module.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer());module.addSerializer(LocalDate.class, new LocalDateSerializer());module.addDeserializer(LocalDateTime.class, new LocalDateTimeDeSerializer());module.addDeserializer(LocalDate.class, new LocalDateDeSerializer());OBJECT_MAPPER.registerModule(module);}/*** 直接獲取ObjectMapper對象*/public static ObjectMapper getObjectMapper() {return OBJECT_MAPPER;}/*** 序列化一個對象,序列化失敗時僅僅打印日志并且返回null。** @param object 對象* @return String*/public static String toJsonOrNull(Object object) {if (object == null) {return null;}try {return OBJECT_MAPPER.writeValueAsString(object);} catch (JsonProcessingException e) {log.error("Json serialize error :", e);}return null;}/*** 序列化一個對象,序列化失敗則拋異常** @param object 對象* @return String*/public static String toJsonString(Object object) throws Exception {if (object == null) {return null;}try {return OBJECT_MAPPER.writeValueAsString(object);} catch (JsonProcessingException e) {log.error("Json serialize error :", e);throw new Exception("Json serialize error");}}/*** 反序列化,失敗則拋異常*/public static <T> T parseObject(String json, Class<T> classType) throws Exception {if (StringUtils.isEmpty(json)) {return null;}try {return OBJECT_MAPPER.readValue(json, classType);} catch (Exception e) {log.error("Json de-serialize error :", e);throw new Exception("Json de-serialize error");}}/*** 自定義復雜的泛型對象,反序列化,失敗則拋異常*/public static <T> T parseObject(String json, TypeReference<T> typeReference) throws Exception{if (StringUtils.isEmpty(json)) {return null;}try {return OBJECT_MAPPER.readValue(json, typeReference);} catch (Exception e) {log.error("Json de-serialize error :", e);throw new Exception("Json de-serialize error");}}/*** 反序列化為Map*/public static Map<String, Object> parseMap(String json) throws Exception{return parseObject(json, new TypeReference<Map<String, Object>>() {});}/*** 自定義 List 類型的反序列化** @param json JSON 字符串* @param classType List 中元素的類類型* @param <T> List 中元素的泛型類型* @return 反序列化后的 List 對象*/@SuppressWarnings("unchecked")public static <T> List<T> parseArray(String json, Class<T> classType) throws Exception {if (StringUtils.isEmpty(json)) {return null;}try {return parseCollection(json, ArrayList.class, classType);} catch (Exception e) {log.error("Error occurred during json deserialization for List: ", e);throw new Exception("Error occurred during json deserialization");}}/*** 通用的集合類型反序列化** @param jsonStr JSON 字符串* @param resultClass 結果集合的類類型* @param classType 集合元素的類類型* @param <C> 返回結果的泛型類型,必須是 Collection 的子類* @param <T> 集合元素的泛型類型* @return 反序列化后的集合對象* @throws IOException 如果反序列化過程中出現 I/O 錯誤*/public static <C extends Collection<T>, T> C parseCollection(String jsonStr, Class<C> resultClass, Class<T> classType) throws IOException {return OBJECT_MAPPER.readValue(jsonStr, OBJECT_MAPPER.getTypeFactory().constructCollectionType(resultClass, classType));}public static Long getLong(Map<String, Object> map, String key) throws Exception {return TypeUtils.castToLong(map.get(key));}public static Integer getInteger(Map<String, Object> map, String key) throws Exception{return TypeUtils.castToInt(map.get(key));}public static String getString(Map<String, Object> map, String key) {return TypeUtils.castToString(map.get(key));}}
package main.java.solutions;import java.math.BigDecimal;
import java.util.Iterator;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;/*** 類型轉換類* @Date: 2023/7/4 14:38*/
public class TypeUtils {private static final Pattern NUMBER_WITH_TRAILING_ZEROS_PATTERN = Pattern.compile("\\.0*$");public static String castToString(Object value) {if (value == null) {return null;}return value.toString();}public static Integer castToInt(Object value) throws Exception{if (value == null) {return null;}if (value instanceof Integer) {return (Integer)value;}if (value instanceof BigDecimal) {return intValue((BigDecimal)value);}if (value instanceof Number) {return ((Number)value).intValue();}if (value instanceof String) {String strVal = (String)value;if (strVal.length() == 0 //|| "null".equals(strVal) //|| "NULL".equals(strVal)) {return null;}if (strVal.indexOf(',') != -1) {strVal = strVal.replaceAll(",", "");}Matcher matcher = NUMBER_WITH_TRAILING_ZEROS_PATTERN.matcher(strVal);if (matcher.find()) {strVal = matcher.replaceAll("");}return Integer.parseInt(strVal);}if (value instanceof Boolean) {return (Boolean)value ? 1 : 0;}if (value instanceof Map) {Map map = (Map)value;if (map.size() == 2&& map.containsKey("andIncrement")&& map.containsKey("andDecrement")) {Iterator iter = map.values().iterator();iter.next();Object value2 = iter.next();return castToInt(value2);}}throw new Exception("Cast type error: "+value);}public static Long castToLong(Object value) throws Exception {if (value == null) {return null;}if (value instanceof BigDecimal) {return longValue((BigDecimal)value);}if (value instanceof Number) {return ((Number)value).longValue();}if (value instanceof String) {String strVal = (String)value;if (strVal.length() == 0 //|| "null".equals(strVal) //|| "NULL".equals(strVal)) {return null;}if (strVal.indexOf(',') != -1) {strVal = strVal.replaceAll(",", "");}try {return Long.parseLong(strVal);} catch (NumberFormatException ex) {//}}if (value instanceof Map) {Map map = (Map)value;if (map.size() == 2&& map.containsKey("andIncrement")&& map.containsKey("andDecrement")) {Iterator iter = map.values().iterator();iter.next();Object value2 = iter.next();return castToLong(value2);}}if (value instanceof Boolean) {return (Boolean)value ? 1L : 0L;}throw new Exception("Cast type error: "+value);}public static int intValue(BigDecimal decimal) {if (decimal == null) {return 0;}int scale = decimal.scale();if (scale >= -100 && scale <= 100) {return decimal.intValue();}return decimal.intValueExact();}public static long longValue(BigDecimal decimal) {if (decimal == null) {return 0;}int scale = decimal.scale();if (scale >= -100 && scale <= 100) {return decimal.longValue();}return decimal.longValueExact();}
}
序列化
1,JSON.toJSONString(this)和JSON.toJSON(this); if為null,則返回null,如果轉換異常,就拋異常。
如果是日志打印就使用JsonUtils.toJsonOrNull(this)替換,否則使用JsonUtils.toJsonString(this)
反序列化
1,JSON.parseObject(deviceInfoStr, DeviceInfo.class); if為null,則返回null,如果轉換異常,就拋異常
使用**JsonUtils.parseObject(deviceInfoStr, DeviceInfo.class)**替換
2,JSON.parseObject(String text);if為null,則返回null,如果轉換異常,就拋異常
使用 **JsonUtils.parseMap(String json)**替換
3,JSONObject.parseArray(String text, Class<T> clazz);if為null,則返回null,如果轉換異常,就拋異常
使用 **JsonUtils.parseArray(String text, Class<T> clazz)**替換;
通過key獲取某種類型的值
1,jsonObject.getLong(String key) ;if為null,則返回null,如果轉換異常,就拋異常
使用**JsonUtils.getLong(map, key)**替換;
2,jsonObject.getInteger(String key) ;if為null,則返回null,如果轉換異常,就拋異常
使用 **JsonUtils.getInteger(map, key)**替換;
3,jsonObject.getString(String key) ;if為null,則返回null,如果轉換異常,就拋異常
使用 **JsonUtils.getString(map, key)**替換;
類型替換
7,返回給前端的是JSONObject使用**Map<String, Object>**替換
8,返回給前端的是JSONArray使用**List<Object>**替換
二,Springboot工程中序列化的使用場景
- 控制器(Controller):控制器負責處理 HTTP 請求和響應,其中涉及到請求參數的反序列化和響應結果的序列化。SpringMVC 使用消息轉換器(MessageConverter)來處理請求和響應的序列化和反序列化,常見的消息轉換器包括 JSON、XML、Form 表單等。
- RESTful API:如果您的 Spring Boot 項目是基于 RESTful API 架構的,那么在請求和響應的過程中,需要進行對象和 JSON/XML 數據之間的序列化和反序列化。Spring Boot 使用消息轉換器來自動處理這些轉換過程。
- 數據庫操作:當使用對象關系映射(ORM)框架(如 Hibernate、Spring Data JPA)進行數據庫操作時,需要將 Java 對象與數據庫記錄之間進行序列化和反序列化。ORM 框架會自動將對象轉換為數據庫記錄(序列化),或將數據庫記錄轉換為對象(反序列化)。
- 緩存操作:在使用緩存(如 Redis、Memcached)時,需要將對象存儲到緩存中或從緩存中獲取對象。這涉及到將對象進行序列化和反序列化,以便在緩存中進行存儲和檢索。
- 消息隊列:如果在 Spring Boot 項目中使用消息隊列(如 RabbitMQ、Kafka)進行異步消息處理,那么消息的生產者和消費者之間需要進行對象的序列化和反序列化,以便在消息傳遞過程中正確地傳遞和處理對象數據。
- 文件存儲:當將Java對象以文件形式存儲時,可能需要將其序列化為JSON或其他格式,以便于讀取和寫入。
三,SpringMVC框架中的Http消息轉換器
1,原理:
利用SpringMVC框架,可以使得我們在開發時,只要在代碼中使用**@RequestBody和@ResponseBody兩個注解,就可以分別完成從請求報文到對象和從對象到響應報文的轉換。而在源碼內部,其實這種靈活的消息轉換機制就是利用HttpMessageConverter**來實現的。
HttpMessageConverter的調用是在RequestResponseBodyMethodProcessor類的解析請求參數的方法resolveArgument()和處理返回值的方法handleReturnValue()中進行調用的。
Http消息轉換器接口
org.springframework.http.converter.HttpMessageConverter 3
public interface HttpMessageConverter<T> {boolean canRead(Class<?> var1, @Nullable MediaType var2);boolean canWrite(Class<?> var1, @Nullable MediaType var2);List<MediaType> getSupportedMediaTypes();T read(Class<? extends T> var1, HttpInputMessage var2) throws IOException, HttpMessageNotReadableException;void write(T var1, @Nullable MediaType var2, HttpOutputMessage var3) throws IOException, HttpMessageNotWritableException;
}
鏈路
http請求 -》 DispatcherServlet -》RequestMappingHandlerAdapter(處理請求映射的適配器)-》ArgumentResolver(參數解析器)/ReturnValueHandlers(返回值處理器)-》RequestResponseBodyMethodProcessor(處理請求和返回的參數)-》HttpMessageConverter的read,write方法
org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport#requestMappingHandlerAdapter 1
protected final List<HttpMessageConverter<?>> getMessageConverters() {if (this.messageConverters == null) {this.messageConverters = new ArrayList();//這是一個抽象方法,允許子類覆蓋它來配置HTTP消息轉換器。開發者可以在子類中實現這個方法來添加自定義的消息轉換器。this.configureMessageConverters(this.messageConverters);if (this.messageConverters.isEmpty()) {//中添加一組默認的HTTP消息轉換器。這些默認轉換器是Spring MVC框架提供的,用于支持常見的數據格式,如JSON、XML等。this.addDefaultHttpMessageConverters(this.messageConverters);}//這是一個可選的方法,允許子類進一步擴展或修改已經配置的HTTP消息轉換器。開發者可以在子類中實現這個方法來對已有的消息轉換器進行額外的定制。this.extendMessageConverters(this.messageConverters);}return this.messageConverters;}
有幾種類型的轉換器:
ByteArrayHttpMessageConverter:負責讀取二進制格式的數據和寫出二進制格式的數據;
StringHttpMessageConverter:負責讀取字符串格式的數據和寫出二進制格式的數據(當返回值是或者接受值是String類型時,是由這個處理)
ResourceHttpMessageConverter:負責讀取資源文件和寫出資源文件數據;
ResourceRegionHttpMessageConverter:用于支持分塊傳輸(Chunked Transfer Encoding)的響應。它允許將資源按照指定的區塊大小進行切分,分塊傳輸響應給客戶端。
SourceHttpMessageConverter:用于處理以XML格式或其他文本格式表示的數據。它支持處理一些Java源數據(Source)類型,如javax.xml.transform.Source(XML數據的源表示)和org.springframework.core.io.Resource(資源文件的源表示)。
AllEncompassingFormHttpMessageConverter:它是一個綜合性的表單數據轉換器,用于處理表單數據的請求和響應。
Jaxb2RootElementHttpMessageConverter:用于處理XML數據,并支持Java對象與XML數據之間的轉換。它主要依賴于Java Architecture for XML Binding (JAXB) API來實現XML數據的序列化和反序列化。
MappingJackson2HttpMessageConverter:負責讀取和寫入json格式的數據;(當返回值是對象或者List,就由這個處理)
org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor 2
2,自定義消息轉換器
一般默認的轉換器不能滿足我們的需求,需要自定義消息轉換器,可以創建自己的轉換器類(Fastjson,Jackson消息轉換器),并在 Spring Boot 配置中進行注冊。通常情況下,只需要注冊您的自定義轉換器,Spring Boot 將自動將其應用于適當的請求和響應。
Fastjson序列化消息轉換器定義:
@Configuration
public class WebConfig implements WebMvcConfigurer {@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {//使用fastjson converterFastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();FastJsonConfig config = new FastJsonConfig();config.setSerializerFeatures(SerializerFeature.DisableCircularReferenceDetect,SerializerFeature.WriteNullListAsEmpty,SerializerFeature.WriteMapNullValue,SerializerFeature.WriteNullStringAsEmpty,SerializerFeature.WriteBigDecimalAsPlain);config.setSerializeFilters(ValueDesensitizeFilter.INSTANCE);// serialize configSerializeConfig serializeConfig = SerializeConfig.getGlobalInstance();serializeConfig.put(BigDecimal.class, ToStringSerializer.instance);serializeConfig.put(LocalDateTime.class, LocalDateTimeSerializer.instance);serializeConfig.put(Long.class, ToStringSerializer.instance);serializeConfig.put(Long.TYPE, ToStringSerializer.instance);config.setSerializeConfig(serializeConfig);converter.setFastJsonConfig(config);converters.add(0, converter);}
}
Jackson序列化消息轉換器定義:
@Configuration
public class JacksonConfig {@Bean@ConditionalOnMissingBean(ObjectMapper.class)public ObjectMapper objectMapper() {ObjectMapper objectMapper = new ObjectMapper();// 通過該方法對mapper對象進行設置,所有序列化的對象都將按改規則進行序列化// Include.Include.ALWAYS 默認// Include.NON_DEFAULT 屬性為默認值不序列化// Include.NON_EMPTY 屬性為 空("") 或者為 NULL 都不序列化,則返回的json是沒有這個字段的。這樣對移動端會更省流量// Include.NON_NULL 屬性為NULL 不序列化objectMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);objectMapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);//解析數組集合、List對象 為[]objectMapper.setSerializerFactory(objectMapper.getSerializerFactory().withSerializerModifier(new SerializerModifier()));SimpleModule simpleModule = new SimpleModule();simpleModule.addSerializer(BigDecimal.class, ToStringSerializer.instance);simpleModule.addSerializer(Long.class, ToStringSerializer.instance);simpleModule.addSerializer(Long.TYPE, ToStringSerializer.instance);simpleModule.addSerializer(LocalDateTime.class, new LocalDateTimeToTimestampSerializer());simpleModule.addSerializer(LocalDate.class, new LocalDateSerializer());simpleModule.addDeserializer(LocalDateTime.class, new LocalDateTimeDeSerializer());simpleModule.addDeserializer(LocalDate.class, new LocalDateDeSerializer());objectMapper.registerModule(simpleModule);return objectMapper;}
}
如何優雅地使用Jackson進行序列化和反序列化操作?
定義一個通用的工具類,對于屬性特殊的規則,可以在屬性上加注解。
3,Jackson常用注解自定義序列化規則
@JsonFormat 注解來自定義日期格式。
public class User {private String name;@JsonFormat(pattern = "yyyy-MM-dd")private Date birthday;
}
@JsonIgnore 注解來排除不想序列化的字段。
public class User {private String name;@JsonIgnoreprivate String password;
}
@JsonProperty 注解來自定義字段名稱。
public class User {@JsonProperty("username")private String name;
}
@JsonInclude 注解來指定字段的空值處理策略。
public class User {private String name;@JsonInclude(JsonInclude.Include.NON_NULL)private String email;
}
使用 @JsonSerialize 和 @JsonDeserialize 注解來指定自定義的序列化器和反序列化器。
public class User {private String name;@JsonSerialize(using = LocalDateTimeSerializer.class)@JsonDeserialize(using = LocalDateTimeDeSerializer.class)private LocalDateTime birthday;
}
自定義反序列化器:
/*** 新建這個反序列化器的目的:源String串中extendFieldJson屬性是對象類型,目標對象DeviceInfo中的extendFieldJson屬性是String類型,轉換的時候會報類型不匹配的錯誤。** @Date: 2023/9/19 18:00*/
public class ObjectToStringDeSerializer extends JsonDeserializer<String> {@Overridepublic String deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {// 從 JSON 中讀取屬性的對象值Object objectValue = jsonParser.readValueAs(Object.class);// 將對象值轉換為json字符串if (objectValue != null) {return JsonUtil.toJsonString(objectValue);}return null;}
}