SpringMVC (二) --- JSON-CSDN博客

本文链接：https://blog.csdn.net/weixin_44823057/article/details/98198329

一，JSON 介绍

JSON (JavaScript Object Notation, JS 对象简谱) 是一种轻量级的数据交换格式。易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率

二，JSON 语法

1，JSON 语法规则

在 JS 语言中，一切都是对象。因此，任何支持的类型都可以通过 JSON 来表示，例如字符串、数字、对象、数组等。但是对象和数组是比较特殊且常用的两种类型

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

2，JSON 键/值对

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

{ "firstName" : "Json" }   等价于这条 JavaScript 语句：{ firstName : "Json" }

3，JSON 与 JS 对象的关系

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

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

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

4，JSON 和 JS 对象互转

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

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

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

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

三，使用Controller实现返回JSON数据

1，搭建实验环境

配置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
        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.shandx.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/jsp/"/>
        <property name="suffix" value=".jsp"/>
    </bean>
    
</beans>

配置web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
         http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
         id="WebApp_ID" version="3.0">

  <!--1.注册DispatcherServlet-->
  <servlet>
    <servlet-name>SpringMVC</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!--2.关联SpringMVC配置文件-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc-servlet.xml</param-value>
    </init-param>

    <!--3.这个东西要和服务器一起启动-->
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>SpringMVC</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>

Jackson是目前比较好的json解析工具了，我们这里使用Jackson，使用它需要导入它的jar包

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

2，编写User实体类

User实体类

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 + '\'' +
                '}';
    }

}

3，测试Controller

1，编写Controller时我们需要两个新东西，一个是@ResponseBody，一个是ObjectMapper对象

@Controller
public class UserController {

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

        ObjectMapper mapper=new ObjectMapper();
        User user = new User("钢铁侠",52,"男");
        String s = mapper.writeValueAsString(user);

        return s;
    }
}

运行结果
在这里插入图片描述
2，JSON还可以打印集合

@Controller
public class UserController {

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

        ObjectMapper mapper=new ObjectMapper();
        List<User> list=new ArrayList<>();
        User user1 = new User("钢铁侠",1,"男");
        User user2 = new User("蜘蛛侠",2,"男");
        User user3 = new User("闪电侠",3,"男");
        list.add(user1);
        list.add(user2);
        list.add(user3);
        String s = mapper.writeValueAsString(list);

        return s;
    }
}

运行结果
在这里插入图片描述
3，创建一个时间日期的对象

@Controller
public class UserController {

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

        ObjectMapper mapper = new ObjectMapper();
        //1.如何让他不返回时间戳！所以我们要关闭它的时间戳功能
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
        //2.时间格式化问题！自定日期格式对象；
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        //3.让mapper指定时间日期格式为simpleDateFormat；
        mapper.setDateFormat(sdf);

        Date date = new Date();
        String s = mapper.writeValueAsString(date);

        return s;
    }
 }

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

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();
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        mapper.setDateFormat(sdf);

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

再次创建时间日期的对象时，我们只需要调方法即可

@Controller
public class UserController {

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

        return JsonUtils.getJson(new Date());

    }
 }