SpringMVC06：Json交互处理

一、什么是JSON?

二、代码测试

1、新建一个module，SpringMVC-05-json，添加web支持和lib包

2、在index.jsp中编写测试内容

3、配置tomcat，启动项目，在浏览器中打开，查看控制台输出

1、新增一个新的方法：输出json格式的对象集合

3、代码测试，我们新建一个FastJsonDemo类

一、什么是JSON?

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

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

对象表示为键值对，数据由逗号分隔；
花括号保存对象；{}
方括号保存数组。【】

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

{"name":"xingming"}
{"age":"12"}
{"sex":"女"}

很多人搞不清楚JSON和JavaScript对象的关系，甚至连谁是谁都不清楚。其实，可以这么理解：
JSON是JavaScript对象的字符串表示法，它使用文本表示一个JS对象的信息，本质是一个字符串。

var obj = {a:'Hello',b:'world'};//这是一个对象，注意键名也是可以使用引号包裹的

var json = '{"a":"Hello","b":"world"}';//这是一个JSON字符串，本质是一个字符串

JSON和JavaScript对象互转

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

   //编写一个js的对象
    var user = {
      name:"姓名1",
      age:"13",
      sex:"男"
    };
    //将js对象转换成json字符串
    var str = JSON.stringify(user);
    console.log(str);
    //运行结果：'{"name":"姓名1","age":"13","sex":"男"}'
    //将json字符串转换为js对象
    var user2 = JSON.parse(str);
    console.log(user2,user.name,user.age,user.sex);
    //运行结果：{age:"13" name:"姓名1" sex:"男"}

二、代码测试

1、新建一个module，SpringMVC-05-json，添加web支持和lib包

配置web.xml和springmvc-servlet.xml文件

2、在index.jsp中编写测试内容

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
  $END$
  <script type="text/javascript">
    //编写一个js的对象
    var user = {
      name:"姓名1",
      age:"13",
      sex:"男"
    };
    //将js对象转换成json字符串
    var str = JSON.stringify(user);
    console.log(str);
    //运行结果：'{"name":"姓名1","age":"13","sex":"男"}'
    //将json字符串转换为js对象
    var user2 = JSON.parse(str);
    console.log(user2,user.name,user.age,user.sex);
    //运行结果：{age:"13" name:"姓名1" sex:"男"}
  </script>
  </body>
</html>

3、配置tomcat，启动项目，在浏览器中打开，查看控制台输出

访问路径：http://localhost:8080/controller/

4、controller返回JSON数据

Jackson应该是目前比较好的json解析工具了
当然工具不止这一个，比如还有阿里巴巴的fastjson等等；
我们这里使用Jackson，使用它需要导入它的jar包；

        <!--json依赖-->
        <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">
    <!--注册servlet，请求分发器，前端控制器-->
    <servlet>
        <servlet-name>dispatcherServlet</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>dispatcherServlet</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.lucky.controller"/>
    <!--视图解析器-->
    <bean id="internalResourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <!--前缀-->
        <property name="prefix" value="/WEB-INF/jsp"/>
    <!--后缀-->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

我们随便写一个User的实体类，然后我们去编写我们的测试Controller；

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private String name;
    private String sex;
    private int age;
}

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

@Controller
public class JsonController {
    /**@ResponseBody的作用:
     * 将controller的方法返回的对象通过适当的转化器转换为指定格式之后，
     * 写入到response对象的body区，通常用来返回JSON数据或者是xml数据。
     */
    @RequestMapping(value = "/json1")
    @ResponseBody
    public String json1() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user = new User("姓名1", "女", 13);
        //将我们的对象解析成json格式
        String str = mapper.writeValueAsString(user);
        //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
        return str;
    }
}

配置Tomcat，启动测试

访问路径：http://localhost:8080/controller/json1

发现出现了乱码问题，我们需要设置一下他的编码格式为utf-8，以及它返回的类型；
通过@RequestMapping的produces属性来实现，修改一下代码：

    /**@ResponseBody的作用:
     * 将controller的方法返回的对象通过适当的转化器转换为指定格式之后，
     * 写入到response对象的body区，通常用来返回JSON数据或者是xml数据。
     *produces:指定响应体返回类型和编码
     */
    
    @RequestMapping(value = "/json1", produces = "application/json;charset=utf-8")

再次测试，乱码问题解决了！

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

5、代码优化

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>

2、返回json字符串统一解决

在类上直接使用@RestController，这样里面所有的方法都只会返回json字符串了，不用再每一个都添加@ResponseBody！我们在前后端分离开发中，一般都使用@RestController，十分便捷！

@RestController
public class JsonController {
    /**@ResponseBody的作用:
     * 将controller的方法返回的对象通过适当的转化器转换为指定格式之后，
     * 写入到response对象的body区，通常用来返回JSON数据或者是xml数据。
     */
    @RequestMapping(value = "/json1")
    public String json1() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user = new User("姓名1", "女", 13);
        //将我们的对象解析成json格式
        String str = mapper.writeValueAsString(user);
        //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
        return str;
    }
}

启动tomcat测试，结果都正常输出！

六、测试集合输出

1、新增一个新的方法：输出json格式的对象集合

    @RequestMapping("/json2")
    public String json2() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个list对象
        User user1 = new User("张三", "男", 13);
        User user2 = new User("里斯", "女", 1);
        User user3 = new User("汪芜", "男", 11);
        User user4 = new User("赵六", "男", 11);
        ArrayList<User> list = new ArrayList<>();
        list.add(user1);
        list.add(user2);
        list.add(user3);
        list.add(user4);
        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(list);
        return str;
    }

运行结果：

2、新增一个方法：输出时间对象

    @RequestMapping("/json3")
    public String json3() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个时间对象
        Date date = new Date();
        String str = mapper.writeValueAsString(date);
        return str;
    }

运行结果：

默认日期格式会变成一个数字，是1970年1月1日到当前日期的毫秒数；
jackson默认是会把日期转换成timestamps形式。

解决方式：取消timestamps形式，自定义时间格式

    @RequestMapping("/json4")
    public String json4() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        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;
    }

运行结果：

3、抽取为工具类

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

public class JsonUtils {
    public static String getJson(Object obj){
        return getJson(obj,"yyyy-MM-dd HH:mm:ss");
    }

    public static String getJson(Object obj,String dateFormate){
        ObjectMapper mapper = new ObjectMapper();
        //不使用时间差的方式
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
        //自定义日期时间对象
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormate);
        mapper.setDateFormat(sdf);
        String str = null;
        try {
            return mapper.writeValueAsString(obj);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }
}

使用工具类，代码更加简洁！

    @RequestMapping("/json5")
    public String json5() throws JsonProcessingException {
        Date date = new Date();
        String json = JsonUtils.getJson(date);
        return json;
    }

运行结果：

七、fastJson

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

1、fastjson的依赖

<dependency>
   <groupId>com.alibaba</groupId>
   <artifactId>fastjson</artifactId>
   <version>1.2.60</version>
</dependency>

2、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字符串之间的相互转化。

3、代码测试，我们新建一个FastJsonDemo类

public class JSONTest {
    public static void main(String[] args) {
        User user1 = new User("测试1号","女",3);
        User user2 = new User("测试1号","女",3);
        User user3 = new User("测试1号","女",3);
        User user4 = new User("测试1号","女",3);
        ArrayList<User> list = new ArrayList<>();
        list.add(user1);
        list.add(user2);
        list.add(user3);
        list.add(user4);
        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(list)==>" + str2);
        System.out.println("/n+++++JSON字符串转java对象++++");
        User jp_user1 = JSON.parseObject(str2, User.class);
        System.out.println("JSON.parseObject(str,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);
    }
}

这种工具类，我们只需要掌握使用就好了，在使用的时候再根据具体的业务去找对应的实现，和以前的commons-io那种工具包一样，直接用就好。