SpringMVC三:SON

最新推荐文章于 2022-03-10 22:16:10 发布

原创最新推荐文章于 2022-03-10 22:16:10 发布 · 527 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springmvc

SpringMVC 专栏收录该内容

6 篇文章

订阅专栏

本文深入讲解JSON(JavaScript Object Notation)作为数据交换格式的应用，包括其语法特点、JS对象与JSON字符串的转换方法，以及使用Jackson库在Java环境中处理JSON数据的实践。探讨了JSON在Web开发中的重要性，特别是在解决数据编码、日期格式化和对象集合转换等方面的问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

JSON简介

JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式，目前使用特别广泛。

采用完全独立于编程语言的文本格式来存储和表示数据。简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。

JSON语法

JSON语法规则

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

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

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

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

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

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

JSON 和 JS 对象互转

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

var obj = JSON.parse('{"a": "Hello", "b": "World"}'); 
//结果是 {a: 'Hello', b: 'World'}

编写一个Html页面，测试下JSON的使用

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

我们测试运行下：
在这里插入图片描述

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

我们编写一个User的实体类，然后我们去编写我们的测试Controller；这里我们需要两个新东西，一个是@ResponseBody，一个是ObjectMapper对象，我们看下具体的用法

User实体类：

package com.westos.pojo;

public class User {
    private String name;
    private int age;
    private String sex;

    public User() {
    }

    public User(String name, int age, String sex) {
        this.name = name;
        this.age = age;
        this.sex = sex;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", sex='" + sex + '\'' +
                '}';
    }
}

测试Controller：

package com.westos.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.westos.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {

   @RequestMapping("/json")
    //思考问题，我们正常返回他会走视图解析器，而json需要返回的是一个字符串；
    //市面上有很多的第三方jar包可以实现这个功能，jackson.只需要一个简单的注解就可以实现了；
    //@ResponseBody , 将服务器端返回的对象转换为json对象响应回去；
    @ResponseBody
    public String json() throws JsonProcessingException {
        //需要一个jackson的对象映射器，就是一个类，使用它可以直接将对象转换为json字符串；
        ObjectMapper mapper = new ObjectMapper();

        //创建一个对象
        User user = new User("秦疆1号",3,"男");
        System.out.println(user);

        //将Java对象转换为json字符串；
        String str = mapper.writeValueAsString(user);
        System.out.println(str);

        return str; //由于使用了@ResponseBody注解，这里会将str以json格式的字符串返回，十分方便；
    }
}

测试运行下，结果是：

在这里插入图片描述
3. 发现出现了乱码问题，我们需要设置一下他的编码格式为utf-8，以及它返回的类型；通过@RequestMaping的produces属性来实现，修改下代码

//produces:指定响应体返回类型和编码
    @RequestMapping(value = "/json",produces = "application/json;charset=utf-8")

再次测试下：
在这里插入图片描述

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

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

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

在resources目录下新建spring-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
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">


    <context:component-scan base-package="com.westos.controller"/>
    <mvc:default-servlet-handler/>
    <mvc:annotation-driven>
        <!--JSON格式乱码处理方式-->
        <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>

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

修改测试Controller, 打印一个集合：

 @RequestMapping("/json3")
   @ResponseBody
   public String json3() throws JsonProcessingException {

       //创建一个jackson的对象映射器，用来解析数据
       ObjectMapper mapper = new ObjectMapper();
       //创建一个对象
       User user1 = new User("秦疆1号", 3, "男");
       User user2 = new User("秦疆2号", 3, "男");
       User user3 = new User("秦疆3号", 3, "男");
       User user4 = new User("秦疆4号", 3, "男");
       List<User> list = new ArrayList<>();
       list.add(user1);
       list.add(user2);
       list.add(user3);
       list.add(user4);
       //将我们的对象解析成为json格式
       String str = mapper.writeValueAsString(list);

       return str; //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
   }

测试运行下：
在这里插入图片描述

修改Controller，创建一个时间日期的对象试试，看看能不能转换成功！

 @RequestMapping("/time")
    @ResponseBody
    public String json4() throws JsonProcessingException {

        ObjectMapper mapper = new ObjectMapper();
        //创建时间一个对象
        Date date = new Date();
        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(date);

        return str; //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
    }

运行的结果：
在这里插入图片描述

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

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

@RequestMapping("/time")
    @ResponseBody
    public String json2() 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; //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
    }

运行的结果：
在这里插入图片描述
我们也可以将这些代码封装成一个工具类：

package com.westos.utils;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

import java.text.SimpleDateFormat;

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();
        //1.如何让他不返回时间戳！所以我们要关闭它的时间戳功能
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
        //2.时间格式化问题！自定日期格式对象；
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        //3.让mapper指定时间日期格式为simpleDateFormat；
        mapper.setDateFormat(sdf);

        try {
            return mapper.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }
}

我们使用工具类的代码

//发现问题，重复代码太多，给它编写一个工具类；
    @RequestMapping(value = "/time3")
    @ResponseBody
    public String json6() throws JsonProcessingException {
        return JsonUtils.getJson(new Date());
    }