這篇文章主要講解了“Jackson的組成部分有哪些”,文中的講解內(nèi)容簡單清晰,易于學(xué)習(xí)與理解,下面請大家跟著小編的思路慢慢深入,一起來研究和學(xué)習(xí)“Jackson的組成部分有哪些”吧!
成都創(chuàng)新互聯(lián),為您提供成都網(wǎng)站建設(shè)、成都網(wǎng)站制作、網(wǎng)站營銷推廣、網(wǎng)站開發(fā)設(shè)計,對服務(wù)混凝土攪拌機等多個行業(yè)擁有豐富的網(wǎng)站建設(shè)及推廣經(jīng)驗。成都創(chuàng)新互聯(lián)網(wǎng)站建設(shè)公司成立于2013年,提供專業(yè)網(wǎng)站制作報價服務(wù),我們深知市場的競爭激烈,認(rèn)真對待每位客戶,為客戶提供賞心悅目的作品。 與客戶共同發(fā)展進(jìn)步,是我們永遠(yuǎn)的責(zé)任!
Jackson是比較主流的基于Java的JSON類庫,可用于Json和XML與JavaBean之間的序列化和反序列化。
沒看錯,Jackson也可以處理JavaBean與XML之間的轉(zhuǎn)換,基于jackson-dataformat-xml組件,而且比較JDK自帶XML實現(xiàn)更加高效和安全。而我們使用比較多的是處理JSON與JavaBean之間的功能。
Jackson主流到什么程度?單從Maven倉庫中的統(tǒng)計來看,Jackson的使用量排位第一。而Spring Boot支持的三個JSON庫(Gson、Jackson、JSON-B)中,Jackson是首選默認(rèn)庫。
Jackson也有以下特點:依賴少,簡單易用,解析大Json速度快、內(nèi)存占用比較低、擁有靈活的API、方便擴展與定制。
Jackson的核心模塊由三部分組成(從Jackson 2.x開始):jackson-core、jackson-annotations、jackson-databind。
jackson-core:核心包,定義了低級流(Streaming)API,提供基于"流模式"解析。Jackson內(nèi)部實現(xiàn)正是通過高性能的流模式API的JsonGenerator和JsonParser來生成和解析json。
jackson-annotations,注解(Annotations)包,提供標(biāo)準(zhǔn)的Jackson注解功能;
jackson-databind:數(shù)據(jù)綁定(Databind)包,實現(xiàn)了數(shù)據(jù)綁定(和對象序列化)支持,它依賴于Streaming和Annotations包。提供基于“對象綁定”解析的API(ObjectMapper)和"樹模型"解析的API(JsonNode);基于"對象綁定"解析的API和"樹模型"解析的API依賴基于“流模式”解析的API。
下面看一下不同環(huán)境下相關(guān)組件的依賴引入情況。
在SpringBoot當(dāng)中,spring-boot-starter-web間接引入了Jackson組件,也就是如果你使用了SpringBoot框架,那么你的項目中已經(jīng)有了Jackson依賴。下面的依賴省略了version和scope項。
org.springframework.boot spring-boot-starter-web
web starter中依賴了json starter:
org.springframework.boot spring-boot-starter-json
json starter最終引入了Jackson:
com.fasterxml.jackson.core jackson-databind com.fasterxml.jackson.datatype jackson-datatype-jdk8 com.fasterxml.jackson.datatype jackson-datatype-jsr310 com.fasterxml.jackson.module jackson-module-parameter-names
上面已經(jīng)提到過,jackson-databind依賴于Streaming和Annotations包,因此,引入jackson-databind相當(dāng)于引入了jackson-core和jackson-annotations。
通常情況下,我們單獨使用時,根據(jù)需要通過Maven引入jackson-databind、jackson-core和jackson-annotations即可。
com.fasterxml.jackson.core jackson-core com.fasterxml.jackson.core jackson-annotations com.fasterxml.jackson.core jackson-databind
對于SpringBoot項目,基本上不用再額外添加依賴。
Jackson提供了三種JSON的處理方式,分別是:數(shù)據(jù)綁定、JSON樹模型、流式API。其中前兩項功能都是基于ObjectMapper來實現(xiàn)的,而流式API功能則需要基于更底層的JsonGenerator和JsonParser來實現(xiàn)。
通常情況下我們使用ObjectMapper類就足夠了,它擁有以下功能:
從字符串、流或文件中解析JSON,并創(chuàng)建表示已解析的JSON的Java對象(反序列化)。
將Java對象構(gòu)建成JSON字符串(序列化)。
將JSON解析為自定義類的對象,也可以解析JSON樹模型的對象;
ObjectMapper基于JsonParser和JsonGenerator來實現(xiàn)JSON實際的讀/寫。這一點看一下ObjectMapper的構(gòu)造方法即可明白。
Jackson的常見使用,就不逐一講解了,通過一些列的實例給大家展示一下,每個實例當(dāng)中都會通過注釋進(jìn)行說明。
下面的示例是我們經(jīng)常會用到的用法演示,主要涉及到JavaBean和Json字符串之間的轉(zhuǎn)換。
Jackson在將json轉(zhuǎn)換為JavaBean屬性時,默認(rèn)是通過Json字段的名稱與Java對象中的getter和setter方法進(jìn)行匹配進(jìn)行綁定。
Jackson取getter和setter方法名稱中去除“get”和“set”部分,并將首字母小寫。例如Json中的name,與JavaBean中的getName()和setName()進(jìn)行匹配。
但并不是所有的屬性都可以被序列化和反序列化,基本上遵循一下規(guī)則:
public修飾的屬性可序列化和反序列化。
屬性提供public的getter/setter方法,該屬性可序列化和反序列化。
屬性只有public的setter方法,而無public的getter方法,該屬性只能用于反序列化。
@Slf4j public class JacksonTest { /** * JavaBean轉(zhuǎn)JSON字符串 */ @Test public void testJavaBeanToJson() { WeChat weChat = new WeChat(); weChat.setId("zhuan2quan"); weChat.setName("程序新視界"); weChat.setInterest(new String[]{"Java", "Spring Boot", "JVM"}); ObjectMapper mapper = new ObjectMapper(); try { String result = mapper.writeValueAsString(weChat); System.out.println(result); } catch (JsonProcessingException e) { log.error("轉(zhuǎn)換異常", e); } } /** * JSON字符串轉(zhuǎn)JavaBean */ @Test public void testJsonToJavaBean() { String json = "{\"id\":\"zhuan2quan\",\"name\":\"程序新視界\",\"interest\":[\"Java\",\"Spring Boot\",\"JVM\"]}"; ObjectMapper mapper = new ObjectMapper(); try { WeChat weChat = mapper.readValue(json, WeChat.class); System.out.println(weChat); } catch (JsonProcessingException e) { log.error("解析異常", e); } } /** * JSON字符串轉(zhuǎn)Map集合 */ @Test public void testJsonToMap() { String json = "{\"id\":\"zhuan2quan\",\"name\":\"程序新視界\",\"interest\":[\"Java\",\"Spring Boot\",\"JVM\"]}"; ObjectMapper mapper = new ObjectMapper(); try { // 對泛型的反序列化,使用TypeReference可以明確的指定反序列化的類型。 Mapmap = mapper.readValue(json, new TypeReference
上述代碼用到了lombok注解和單元測試注解,根據(jù)需要可進(jìn)行替換。
如果Json字符串比較大,則可使用JSON樹模型來靈活的獲取所需的字段內(nèi)容。在Jackson中提供了get、path、has等方法來獲取或判斷。
下面直接看兩個示例:
@Slf4j public class JacksonNodeTest { /** * JavaBean轉(zhuǎn)JSON字符串 */ @Test public void testJsonNode() { // 構(gòu)建JSON樹 ObjectMapper mapper = new ObjectMapper(); ObjectNode root = mapper.createObjectNode(); root.put("id", "zhuan2quan"); root.put("name", "程序新視界"); ArrayNode interest = root.putArray("interest"); interest.add("Java"); interest.add("Spring Boot"); interest.add("JVM"); // JSON樹轉(zhuǎn)JSON字符串 String json = null; try { json = mapper.writeValueAsString(root); } catch (JsonProcessingException e) { log.error("Json Node轉(zhuǎn)換異常", e); } System.out.println(json); } /** * 解析JSON字符串為JSON樹模型 */ @Test public void testJsonToJsonNode() { String json = "{\"id\":\"zhuan2quan\",\"name\":\"程序新視界\",\"interest\":[\"Java\",\"Spring Boot\",\"JVM\"]}"; ObjectMapper mapper = new ObjectMapper(); try { // 將JSON字符串轉(zhuǎn)為JSON樹 JsonNode jsonNode = mapper.readTree(json); String name = jsonNode.path("name").asText(); System.out.println(name); JsonNode interestNode = jsonNode.get("interest"); if (interestNode.isArray()){ for (JsonNode node : interestNode){ System.out.println(node.asText()); } } } catch (JsonProcessingException e) { log.error("Json Node轉(zhuǎn)換異常", e); } } }
其中g(shù)et方法和path功能相似,區(qū)別在于如果要讀取的key在Json串中不存在時,get方法會null,而path會返回MissingNode實例對象,在鏈路方法情況下保證不會拋出異常。
除了上述兩種形式,還可以基于底層的流式API來進(jìn)行操作,主要通過JsonGenerator和JsonParser兩個API,但操作起來比較復(fù)雜,就不再這里演示了。
在使用ObjectMapper時,會存在一些字段在某些情況下不需要進(jìn)行序列化或反序列化,同時還可能需要指定格式化的一些信息等。此時,可以通過ObjectMapper進(jìn)行配置。
//反序列化時忽略json中存在但Java對象不存在的屬性 mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); //序列化時日期格式默認(rèn)為yyyy-MM-dd'T'HH:mm:ss.SSSZ mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false); //序列化時自定義時間日期格式 mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")); //序列化時忽略值為null的屬性 mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); //序列化時忽略值為默認(rèn)值的屬性 mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);
針對于配置項,在2.2版本中新增了一個ObjectMapper的實現(xiàn)類JsonMapper,功能與ObjectMapper一致。不過新增了一個builder方法??梢灾苯油ㄟ^JsonMapper.builder().configure()方法來進(jìn)行配置,最后獲得一個JsonMapper對象。JsonMapper的其他方法基本都集成自O(shè)bjectMapper。
上面通過統(tǒng)一配置可對全局格式的序列化和反序列化進(jìn)行配置,但某些個別的場景下,需要針對具體的字段進(jìn)行配置,這就需要用注解。比如當(dāng)Json字符串中的字段與Java對象中的屬性不一致時,就需要通過注解來建立它們直接的關(guān)系。
@JsonProperty,作用JavaBean字段上,指定一個字段用于JSON映射,默認(rèn)情況下映射的JSON字段與注解的字段名稱相同。可通過value屬性指定映射的JSON的字段名稱。
@JsonIgnore可用于字段、getter/setter、構(gòu)造函數(shù)參數(shù)上,指定字段不參與序列化和反序列化。
@JsonIgnoreProperties作用于類上,序列化時@JsonIgnoreProperties({“prop1”, “prop2”})會忽略pro1和pro2兩個屬性。反序列化時@JsonIgnoreProperties(ignoreUnknown=true)會忽略類中不存在的字段。
@JsonFormat作用于字段上,通常用來進(jìn)行格式化操作。
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8") private Date date;
如果JavaBean中的時間字段使用的是JDK8新增的時間日期(LocalDate/LocalTime/LocalDateTime)類型的話,需要添加jackson-datatype-jsr310依賴。在講依賴部分時,SpringBoot默認(rèn)引入的依賴中就有這個。
當(dāng)然,還有一些其他的注解,比如@JsonPropertyOrder、@JsonRootName、@JsonAnySetter、@JsonAnyGetter、@JsonNaming等,當(dāng)使用時參考對應(yīng)的文檔和示例看一下就可以,這里就不再一一列出了。
如果上面的注解和統(tǒng)一配置還無法滿足需求,可自定義解析器,示例如下:
public class MyFastjsonDeserialize extends JsonDeserializer{ @Override public Point deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException { JsonNode node = jsonParser.getCodec().readTree(jsonParser); Iterator iterator = node.get("coordinates").elements(); List list = new ArrayList<>(); while (iterator.hasNext()) { list.add(iterator.next().asDouble()); } return new Point(list.get(0), list.get(1)); } }
定義完成之后,注冊到Mapper中:
ObjectMapper objectMapper = new ObjectMapper(); SimpleModule module = new SimpleModule(); module.addDeserializer(Point.class, new MyFastjsonDeserialize()); objectMapper.registerModule(module);
Jackson也可以通過jackson-dataformat-xml包提供了處理XML的功能。在處理XML時建議使用woodstox-core包,它是一個XML的實現(xiàn),比JDK自帶XML實現(xiàn)更加高效,也更加安全。
com.fasterxml.jackson.dataformat jackson-dataformat-xml
如果使用Java 9及以上版本,可能會出現(xiàn)java.lang.NoClassDefFoundError: javax/xml/bind/JAXBException異常,這是因為Java 9實現(xiàn)了JDK的模塊化,將原本和JDK打包在一起的JAXB實現(xiàn)分隔出來。所以需要手動添加JAXB的實現(xiàn)。
javax.xml.bind jaxb-api
下面是代碼示例,基本上和JSON的API非常相似,XmlMapper實際上就是ObjectMapper的子類。
@Test public void testXml(){ WeChat weChat = new WeChat(); weChat.setId("zhuan2quan"); weChat.setName("程序新視界"); weChat.setInterest(new String[]{"Java", "Spring Boot", "JVM"}); XmlMapper xmlMapper = new XmlMapper(); try { String xml = xmlMapper.writeValueAsString(weChat); System.out.println(xml); } catch (JsonProcessingException e) { e.printStackTrace(); } }
執(zhí)行之后,輸出結(jié)果:
zhuan2quan 程序新視界 Java Spring Boot JVM
在最開始的時候,我們已經(jīng)看到Spring Boot默認(rèn)引入了Jackson的依賴,而且也用我們做什么額外的操作,其實已經(jīng)在使用Jackson進(jìn)行Json格式的數(shù)據(jù)與MVC中參數(shù)進(jìn)行綁定操作了。
如果Spring Boot默認(rèn)的配置并不適合項目需求,也可以通過內(nèi)置的配置進(jìn)行配置,以application.yml配置為例,可通過指定以下屬性進(jìn)行相應(yīng)選項的配置:
#指定日期格式,比如yyyy-MM-dd HH:mm:ss,或者具體的格式化類的全限定名 spring.jackson.date-format #是否開啟Jackson的反序列化 spring.jackson.deserialization #是否開啟json的generators. spring.jackson.generator #指定Joda date/time的格式,比如yyyy-MM-ddHH:mm:ss). 如果沒有配置的話,dateformat會作為backup spring.jackson.joda-date-time-format #指定json使用的Locale. spring.jackson.locale #是否開啟Jackson通用的特性. spring.jackson.mapper #是否開啟jackson的parser特性. spring.jackson.parser #指定PropertyNamingStrategy(CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES)或者指定PropertyNamingStrategy子類的全限定類名. spring.jackson.property-naming-strategy #是否開啟jackson的序列化. spring.jackson.serialization #指定序列化時屬性的inclusion方式,具體查看JsonInclude.Include枚舉. spring.jackson.serialization-inclusion #指定日期格式化時區(qū),比如America/Los_Angeles或者GMT+10. spring.jackson.time-zone
Spring Boot自動配置非常方便,但某些時候需要我們手動配置Bean來替代自動配置的Bean??赏ㄟ^如下形式進(jìn)行配置:
@Configuration public class JacksonConfig { @Bean @Qualifier("json") public ObjectMapper jsonMapper(Jackson2ObjectMapperBuilder builder) { ObjectMapper mapper = builder.createXmlMapper(false) .build(); mapper.enable(SerializationFeature.INDENT_OUTPUT); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); return mapper; } }
配置完成,可在使用的地方直接注入即可:
@Resource private ObjectMapper jsonMapper;
對于上面的注入,可能會有朋友問了,是否有線程安全的問題?這個不用擔(dān)心ObjectMapper是線程安全的。
感謝各位的閱讀,以上就是“Jackson的組成部分有哪些”的內(nèi)容了,經(jīng)過本文的學(xué)習(xí)后,相信大家對Jackson的組成部分有哪些這一問題有了更深刻的體會,具體使用情況還需要大家實踐驗證。這里是創(chuàng)新互聯(lián),小編將為大家推送更多相關(guān)知識點的文章,歡迎關(guān)注!