springMVC-Json交互处理

什么是JSON

JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式，目前使用特别广泛。
采用完全独立于编程语言的文本格式来存储和表示数据。
简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。
易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

在 JavaScript 语言中，一切都是对象。因此，任何JavaScript 支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。看看他的要求和语法格式：

对象表示为键值对，数据由逗号分隔
花括号保存对象
方括号保存数组

JSON 键值对是用来保存 JavaScript 对象的一种方式，和 JavaScript 对象的写法也大同小异，键/值对组合中的键名写在前面并用双引号 "" 包裹，使用冒号 : 分隔，然后紧接着值：

javascript 复制代码

 {"name": "lyc"}
 {"age": "3"}
 {"sex": "男"}

很多人搞不清楚 JSON 和 JavaScript 对象的关系，甚至连谁是谁都不清楚。其实，可以这么理解：

JSON 是 JavaScript 对象的字符串表示法，它使用文本表示一个 JS 对象的信息，本质是一个字符串。

javascript 复制代码

 var obj = {a: 'Hello', b: 'World'}; //这是一个对象，注意键名也是可以使用引号包裹的
 var json = '{"a": "Hello", "b": "World"}'; //这是一个 JSON 字符串，本质是一个字符串

JSON 和 JavaScript 对象互转

要实现从JSON字符串转换为JavaScript 对象，使用 JSON.parse() 方法：

javascript 复制代码

  // 将JSON字符串转换为JavaScript对象
     var person = JSON.parse(myJSON);
     console.log(person)
 /*
 {name: 'John', age: 30, city: 'New York'}
 age: 30
 city: "New York"
 name: "John"
 */

要实现从JavaScript 对象转换为JSON字符串，使用 JSON.stringify() 方法：

复制代码

javascript 复制代码

  var myJSON = JSON.stringify(person);
     console.log(myJSON)
 //结果是{"name":"John","age":30,"city":"New York"}

Controller返回JSON数据

推荐工具：Jackson ，fastjson等等

我们在以下的测试中使用Jackson来作为工具

使用前置条件，导入依赖

XML 复制代码

 <dependencies>
     <dependency>
         <groupId>com.fasterxml.jackson.core</groupId>
         <artifactId>jackson-databind</artifactId>
         <version> 2.18.3</version>
     </dependency>
 </dependencies>

测试前置准备

配置SpringMVC需要的配置

web.xml

复制代码

XML 复制代码

<!--    配置DispatcherServlet-->
     <servlet>
         <servlet-name>springmvc</servlet-name>
         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <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>
     <servlet-mapping>
         <servlet-name>springmvc</servlet-name>
         <url-pattern>/</url-pattern>
     </servlet-mapping>
 <!--    配置springMVC的乱码过滤-->
     <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>

springmvc-servlet.xml

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；

复制代码

java 复制代码

package com.lyc.pojo;
 
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
 
 @AllArgsConstructor
 @NoArgsConstructor
 @Data
 public class User {
     private int id;
     private String username;
     private String password;
 }

这里我们需要两个新东西，一个是@ResponseBody，一个是ObjectMapper对象，我们看下具体的用法

还有**@RestController，直接配置在类上，所有方法都只会返回字符串**

@Controller配置在类上，会去走视图解析器

@ResponseBody配合@Controller 起到@RestController的作用

java 复制代码

@Controller
 public class UserController {
     @RequestMapping(value = "/json1", produces = "application/json;charset=utf-8")//produces:指定响应体返回类型和编码
     @ResponseBody   //他就不会走视图解析器，会直接返回一个字符串
     public String json1() throws JsonProcessingException {
         //jackson可以解析java对象,通过@ResponseBody返回json格式的数据
         //ObjectMapper对象
         ObjectMapper objectMapper = new ObjectMapper();
 
         User user = new User(1,"吴雁卿","123456");
         String s = objectMapper.writeValueAsString(user);
         return s;
     }
 }

【注意：使用json记得处理乱码问题】

代码优化

乱码统一解决

上一种方法比较麻烦，如果项目中有许多请求则每一个都要添加，可以通过Spring配置统一指定，这样就不用每次都去处理了！

我们可以在springmvc的配置文件上添加一段消息StringHttpMessageConverter转换配置！

此段代码不用变化，可以直接使用，放置在springmvc-servlet.xml中

XML 复制代码

<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>

测试集合输出

复制代码

java 复制代码

@RequestMapping("/json2")
 public String json2() throws JsonProcessingException {
     ObjectMapper mapper = new ObjectMapper();
     List<User> users = new ArrayList<>();
     User user1 = new User(1,"吴雁卿","123456");
     User user2 = new User(2,"陈思琪","123434");
     User user3 = new User(3,"吴梦婷","123467");
     users.add(user1);
     users.add(user2);
     users.add(user3);
     String s = mapper.writeValueAsString(users);
     return s;
     //[{"id":1,"username":"吴雁卿","password":"123456"},
     // {"id":2,"username":"陈思琪","password":"123434"},
     // {"id":3,"username":"吴梦婷","password":"123467"}]
 }

输出时间对象

复制代码

java 复制代码

@RequestMapping("/json3")
 public String json3() throws JsonProcessingException {
     ObjectMapper mapper = new ObjectMapper();
     Date date = new Date();
     return mapper.writeValueAsString(date);

默认日期格式会变成一个数字，是1970年1月1日到当前日期的毫秒数！

Jackson 默认是会把时间转成timestamps形式

解决方案1： SimpleDateFormat自定义时间格式

复制代码

java 复制代码

@RequestMapping("/json3")
 public String json3() throws JsonProcessingException {
     ObjectMapper mapper = new ObjectMapper();
     SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
     Date date = new Date();
       return mapper.writeValueAsString(simpleDateFormat.format(date));

运行结果 : 成功的输出了时间！

解决方案2：取消timestamps形式 mapper自定义时间格式

java 复制代码

 @RequestMapping("/json3")
 public String json3() throws JsonProcessingException {
     ObjectMapper mapper = new ObjectMapper();
      //取消时间戳格式，自定义时间格式
      mapper.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS, false);
         mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
         Date date = new Date();
     return mapper.writeValueAsString(date);

抽取为工具类

如果要经常使用的话，这样是比较麻烦的，我们可以将这些代码封装到一个工具类中

java 复制代码

 package com.lyc.utils;
 
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 
 import java.text.SimpleDateFormat;
 
     public static String GetJson(Object object) throws JsonProcessingException {
        return GetJson(object,"yyyy-MM-dd HH:mm:ss");
     }
 
 public class JsonUtils {
     public static String GetJson(Object object, String dateFormat) throws JsonProcessingException {
         ObjectMapper mapper = new ObjectMapper();
         mapper.configure(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS,false);
         SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
         mapper.setDateFormat(sdf);
         return mapper.writeValueAsString(object);
     }
 }

之后的方法，不仅时间对象可以使用，其他的也可以被转化为Json数据格式

java 复制代码

   @RequestMapping("/json3")
 public String json3() throws JsonProcessingException {
         ObjectMapper mapper = new ObjectMapper();
  Date date = new Date();
     JsonUtils.GetJson(date);
   return  mapper.writeValueAsString(date);  
 }

测试结果：

拓展

FastJson的使用

fastjson.jar是阿里开发的一款专门用于Java开发的包，可以方便的实现json对象与JavaBean对象的转换，实现JavaBean对象与json字符串的转换，实现json对象与json字符串的转换。实现json的转换方法很多，最后的实现结果都是一样的。

fastjson 的 pom依赖！

复制代码

   <dependency>
         <groupId>com.alibaba</groupId>
         <artifactId>fastjson</artifactId>
         <version> 2.0.53</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字符串之间的相互转化。

这就是一个工具类，只要会用就行了，这两者就是二选一，喜欢自己动手的可以使用Jackson，喜欢直接用的使用Fastjson，需要查看官方文档

希望对大家有所帮助