Json互動處理
阿新 • • 發佈：2021-02-07
技術標籤：# SpringMVC
1. 什麼是JSON？
- JSON(JavaScript Object Notation, JS 物件標記) 是一種輕量級的資料交換格式，目前使用特別廣泛。
- 採用完全獨立於程式語言的文字格式來儲存和表示資料。
- 簡潔和清晰的層次結構使得 JSON 成為理想的資料交換語言。
- 易於人閱讀和編寫，同時也易於機器解析和生成，並有效地提升網路傳輸效率。
在 JavaScript 語言中，一切都是物件。因此，任何JavaScript 支援的型別都可以通過 JSON 來表示，例如字串、數字、物件、陣列等。看看他的要求和語法格式：
- 物件表示為鍵值對，資料由逗號分隔
- 花括號儲存物件
- 方括號儲存陣列
JSON 鍵值對是用來儲存 JavaScript 物件的一種方式，和 JavaScript 物件的寫法也大同小異，鍵/值對組合中的鍵名寫在前面並用雙引號 “” 包裹，使用冒號 : 分隔，然後緊接著值：
{"name": "QinJiang"}
{"age": "3"}
{"sex": "男"}
很多人搞不清楚 JSON 和 JavaScript 物件的關係，甚至連誰是誰都不清楚。其實，可以這麼理解：
JSON 是 JavaScript 物件的字串表示法，它使用文字表示一個 JS 物件的資訊，本質是一個字串。
var obj = {a: 'Hello', b: 'World'}; //這是一個物件，注意鍵名也是可以使用引號包裹的
var json = '{"a": "Hello", "b": "World"}'; //這是一個 JSON 字串，本質是一個字串
2. JSON 和 JavaScript 物件互轉
要實現從JSON字串轉換為JavaScript 物件，使用 JSON.parse() 方法：
var obj = JSON.parse('{"a": "Hello", "b": "World"}' 要實現從JavaScript 物件轉換為JSON字串，使用 JSON.stringify() 方法：
var json = JSON.stringify({a: 'Hello', b: 'World'});
//結果是 '{"a": "Hello", "b": "World"}'
程式碼測試
-
新建一個module ，springmvc-05-json ， 新增web的支援
-
在web目錄下新建一個 json-1.html ， 編寫測試內容
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>JSON_秦疆</title> </head> <body> <script type="text/javascript"> //編寫一個js的物件 var user = { name:"秦疆", age:3, sex:"男" }; //將js物件轉換成json字串 var str = JSON.stringify(user); console.log(str); //將json字串轉換為js物件 var user2 = JSON.parse(str); console.log(user2.age,user2.name,user2.sex); </script> </body> </html> -
在IDEA中使用瀏覽器開啟，檢視控制檯輸出！
3. Controller返回JSON資料
-
Jackson應該是目前比較好的json解析工具了
-
當然工具不止這一個，比如還有阿里巴巴的 fastjson 等等。
-
我們這裡使用Jackson，使用它需要匯入它的jar包；
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-core --> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.8</version> </dependency> -
配置SpringMVC需要的配置
-
（web.xml）
<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0"> <!--1.註冊servlet--> <servlet> <servlet-name>SpringMVC</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!--通過初始化引數指定SpringMVC配置檔案的位置，進行關聯--> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:springmvc-servlet.xml</param-value> </init-param> <!-- 啟動順序，數字越小，啟動越早 --> <load-on-startup>1</load-on-startup> </servlet> <!--所有請求都會被springmvc攔截 --> <servlet-mapping> <servlet-name>SpringMVC</servlet-name> <url-pattern>/</url-pattern> </servlet-mapping> <filter> <filter-name>encoding</filter-name> <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>utf-8</param-value> </init-param> </filter> <filter-mapping> <filter-name>encoding</filter-name> <url-pattern>/</url-pattern> </filter-mapping> </web-app>
-
-
springmvc-servlet.xml
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd"> <!-- 自動掃描指定的包，下面所有註解類交給IOC容器管理 --> <context:component-scan base-package="com.kuang.controller"/> <!-- 檢視解析器 --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver"> <!-- 字首 --> <property name="prefix" value="/WEB-INF/jsp/" /> <!-- 字尾 --> <property name="suffix" value=".jsp" /> </bean> </beans>-
我們隨便編寫一個User的實體類，然後我們去編寫我們的測試Controller；
@Data @AllArgsConstructor @NoArgsConstructor public class User { private int id; private String name; private int age; } -
這裡我們需要兩個新東西，一個是@ResponseBody，一個是ObjectMapper物件，我們看下具體的用法
編寫一個Controller；
@Controller public class UserController { @RequestMapping("/j1") @ResponseBody//他就不會走檢視解析器，會直接返回一個 字串 public String json1() throws JsonProcessingException { //jackson,ObjectMapper ObjectMapper mapper = new ObjectMapper(); //建立一個物件 User user = new User(1, "秦疆一號", 12); //System.out.println(user); String str = mapper.writeValueAsString(user); return str; }-
此時輸入中文會產生亂碼
//produces:指定響應體返回型別和編碼 @RequestMapping(value = "/j1",produces = "application/json;charset=utf-8") -
配置Tomcat ， 啟動測試一下！http://localhost:8080/j1
-
【注意：使用json記得處理亂碼問題】
4. 程式碼優化
4.1 亂碼統一解決
上一種方法比較麻煩，如果專案中有許多請求則每一個都要新增，可以通過Spring配置統一指定，這樣就不用每次都去處理了！
我們可以在springmvc的配置檔案上新增一段訊息StringHttpMessageConverter轉換配置！
<mvc:annotation-driven>
<mvc:message-converters register-defaults="true">
<bean class="org.springframework.http.converter.StringHttpMessageConverter">
<constructor-arg value="UTF-8"/>
</bean>
<bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
<property name="objectMapper">
<bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
<property name="failOnEmptyBeans" value="false"/>
</bean>
</property>
</bean>
</mvc:message-converters>
</mvc:annotation-driven>
4.2 返回json字串統一解決
-
@ResponseBody解決（每個方法都得加，不建議使用）
@Controller public class UserController { //produces:指定響應體返回型別和編碼 @RequestMapping(value = "/json1") @ResponseBody public String json1() throws JsonProcessingException { //建立一個jackson的物件對映器，用來解析資料 ObjectMapper mapper = new ObjectMapper(); //建立一個物件 User user = new User(1, "秦疆一號", 12); //將我們的物件解析成為json格式 String str = mapper.writeValueAsString(user); //由於@ResponseBody註解，這裡會將str轉成json格式返回；十分方便 return str; } } -
@RestController（直接加到類上即可）
@RestController public class UserController { @RequestMapping(value = "/j1") public String json1() throws JsonProcessingException { //建立一個jackson的物件對映器，用來解析資料 ObjectMapper mapper = new ObjectMapper(); //建立一個物件 User user = new User(1, "秦疆一號", 12); //將我們的物件解析成為json格式 String str = mapper.writeValueAsString(user); return str; } }
5. 測試集合輸出
增加一個新的方法
@RequestMapping("/j2")
public String json2() throws JsonProcessingException {
//建立一個jackson的物件對映器，用來解析資料
ObjectMapper mapper = new ObjectMapper();
//建立一個物件
User user1 = new User(1, "秦疆1號", 12);
User user2 = new User(2, "秦疆2號", 12);
User user3 = new User(3, "秦疆3號", 12);
User user4 = new User(4, "秦疆4號", 12);
User user5 = new User(5, "秦疆5號", 12);
List<User> list = new ArrayList<User>();
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
list.add(user5);
//將我們的物件解析成為json格式
String str = mapper.writeValueAsString(list);
return str;
}
執行結果 : 十分完美，沒有任何問題！
6. 輸出時間物件
-
增加一個新的方法
@RequestMapping("/j3") public String json3() throws JsonProcessingException { ObjectMapper mapper = new ObjectMapper(); //建立時間一個物件，java.util.Date Date date = new Date(); //將我們的物件解析成為json格式 String str = mapper.writeValueAsString(date); return str; } -
執行結果 :
-
預設日期格式會變成一個數字，是1970年1月1日到當前日期的毫秒數！
-
Jackson 預設是會把時間轉成timestamps形式
解決方案：取消timestamps形式 ， 自定義時間格式
@RequestMapping("/j3")
public String json4() throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
//不使用時間戳的方式
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
//自定義日期格式物件
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//指定日期格式
mapper.setDateFormat(sdf);
Date date = new Date();
String str = mapper.writeValueAsString(date);
return str;
}
執行結果 : 成功的輸出了時間！
抽取為工具類
如果要經常使用的話，這樣是比較麻煩的，我們可以將這些程式碼封裝到一個工具類中；我們去編寫下
public class JsonUtils {
public static String getJson(Object object) {
return getJson(object,"yyyy-MM-dd HH:mm:ss");
}
public static String getJson(Object object, String dateFormat) {
ObjectMapper mapper = new ObjectMapper();
//java自定義日期格式
SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
//sdf.format(date)
// 使用ObjectMapper 來格式化輸出
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
mapper.setDateFormat(sdf);
try {
//ObjectMapper,時間解析後的預設格式為：TImestamp.時間戳
return mapper.writeValueAsString(object);
} catch (JsonProcessingException e) {
e.printStackTrace();
}
return null;
}
}
我們使用工具類，程式碼就更加簡潔了！
@RequestMapping("/j3")
public String json3(){
Date date = new Date();
return JsonUtils.getJson(date,"yyyy-MM-dd HH:mm:ss");
}
}
大功告成！完美！
7. FastJson
- fastjson.jar是阿里開發的一款專門用於Java開發的包，
- 實現json物件與JavaBean物件的轉換，
- 實現JavaBean物件與json字串的轉換，
- 實現json物件與json字串的轉換。
- 實現json的轉換方法很多，最後的實現結果都是一樣的。
fastjson 的 pom依賴！
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.60</version>
</dependency>
fastjson 三個主要的類：
- JSONObject 代表 json 物件
- JSONObject實現了Map介面, 猜想 JSONObject底層操作是由Map實現的。
- JSONObject對應json物件，通過各種形式的get()方法可以獲取json物件中的資料，也可利用諸如size()，isEmpty()等方法獲取"鍵：值"對的個數和判斷是否為空。其本質是通過實現Map介面並呼叫介面中的方法完成的。
- JSONArray 代表 json 物件陣列
- 內部是有List介面中的方法來完成操作的。
- JSON代表 JSONObject和JSONArray的轉化
- JSON類原始碼分析與使用
- 仔細觀察這些方法，主要是實現json物件，json物件陣列，javabean物件，json字串之間的相互轉化。
程式碼測試，我們新建一個FastJsonDemo 類
@RequestMapping("/j4")
//@ResponseBody//他就不會走檢視解析器，會直接返回一個 字串
public String json4(){
User user1 = new User(1, "秦疆1號", 12);
User user2 = new User(2, "秦疆2號", 12);
User user3 = new User(3, "秦疆3號", 12);
User user4 = new User(4, "秦疆4號", 12);
User user5 = new User(5, "秦疆5號", 12);
List<User> list = new ArrayList<User>();
list.add(user1);
list.add(user2);
list.add(user3);
list.add(user4);
list.add(user5);
System.out.println("*******Java物件 轉 JSON字串*******");
String str1 = JSON.toJSONString(list);
System.out.println("JSON.toJSONString(list)==>"+str1);
String str2 = JSON.toJSONString(user1);
System.out.println("JSON.toJSONString(user1)==>"+str2);
System.out.println("\n****** JSON字串 轉 Java物件*******");
User jp_user1=JSON.parseObject(str2,User.class);
System.out.println("JSON.parseObject(str2,User.class)==>"+jp_user1);
System.out.println("\n****** Java物件 轉 JSON物件 ******");
JSONObject jsonObject1 = (JSONObject) JSON.toJSON(user2);
System.out.println("(JSONObject) JSON.toJSON(user2)==>"+jsonObject1.getString("name"));
System.out.println("\n****** JSON物件 轉 Java物件 ******");
User to_java_user = JSON.toJavaObject(jsonObject1, User.class);
System.out.println("JSON.toJavaObject(jsonObject1, User.class)==>"+to_java_user);
return JSON.toJSONString(list);
}
這種工具類，我們只需要掌握使用就好了，在使用的時候在根據具體的業務去找對應的實現。和以前的commons-io那種工具包一樣，拿來用就好了！