SpingMVC 使用 JSON 进行数据传输（乱码问题）

最新推荐文章于 2024-09-15 19:46:31 发布

Dear.er

最新推荐文章于 2024-09-15 19:46:31 发布

阅读量134

点赞数

分类专栏： SpringMVC 文章标签：字符串乱码 java springmvc

本文链接：https://blog.csdn.net/weixin_44462664/article/details/109687392

版权

SpringMVC 专栏收录该内容

2 篇文章 0 订阅

订阅专栏

本文介绍了JSON的基本概念，如何在SpringMVC中返回和处理JSON数据，包括Jackson工具的使用、乱码问题解决方案、代码优化和FastJson的对比。适合初学者和开发者快速掌握JSON在Spring应用中的实践。

摘要由CSDN通过智能技术生成

1、什么是 JSON？

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

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

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

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

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

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

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

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

JSON 和 JavaScript 对象互转

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

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

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

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

代码测试

新建一个项目，springmvc-json，添加 Web 的支持
在 Web 目录下新建一个 jsontest.html，编写测试内容

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Json</title>
    <script type="text/javascript">
        //编写一个js的对象
        var user = {
            name: "SpringMVC",
            age: 3,
            sex: "男"
        };
        //将js对象转换成json字符串
        var str = JSON.stringify(user);
        console.log(str);
        //将json字符串转换为js对象
        var user2 = JSON.parse(str);
        console.log(user2);
        console.log(user2.age, user2.name, user2.sex);
    </script>
</head>
<body>
</body>
</html>

在 IDEA中使用浏览器打开，在浏览器的控制台查看输出！

2、Controller 返回 JSON 数据

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

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jacksoncore -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.11.0</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>
            <!-- 关联一个 springmvc 的配置文件: 【servlet-name】-servlet.xml -->
            <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"
       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
        ">

    <!-- 自动扫描包, 让指定包下的注解生效,由 IOC 容器统一管理 -->
    <context:component-scan base-package="com.springmvc.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.java 实体类，然后编写测试Controller

package com.springmvc.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

// 需要导入 lombok
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private String name;
    private int age;
    private String sex;

}

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

Controller

@Controller
public class UserController {
    @RequestMapping("/json1")
    @ResponseBody //不会走视图解析器, 直接返回一个字符串
    public String json1() throws JsonProcessingException {
        // 创建一个 jackson 的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user = new User("春天MVC", 3, "男");
        //将对象解析成为 json 格式
        String str = mapper.writeValueAsString(user);
        //由于 @ResponseBody 注解，这里会将 str 转成 json 格式返回
        return str;
    }
}

配置Tomcat，启动测试 http://localhost:8080/json1
发现出现了乱码问题，需要设置一下它的编码格式为utf-8，以及它返回类型
通过 @RequestMaping 的 produces 属性来实现，修改下代码

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

再次测试， http://localhost:8080/json1 ，乱码问题OK！

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

3、代码优化

乱码统一解决

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

可以在 springmvc 的配置文件（springmvc-servlet.xml）内添加一段消息 StringHttpMessageConverter 转换配置！

<!-- JSON 乱码问题配置 -->
<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>

返回 json 字符串统一解决

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

@RestController //不会走视图解析器, 直接返回一个字符串
public class UserController {
    @RequestMapping(value = "/json1")
    public String json1() throws JsonProcessingException {
        // 创建一个 jackson 的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user = new User("春天MVC", 3, "男");
        //将对象解析成为 json 格式
        String str = mapper.writeValueAsString(user);
        //由于 @ResponseBody 注解，这里会将 str 转成 json 格式返回
        return str;
    }
}

4、测试集合输出

在 UserController.java 中增加一个新的方法

@RequestMapping("/json2")
public String json2() throws JsonProcessingException {
    //创建一个 jackson 的对象映射器，用来解析数据
    ObjectMapper mapper = new ObjectMapper();
    //创建一个对象
    User user1 = new User("春天MVC1号", 3, "男");
    User user2 = new User("春天MVC2号", 3, "男");
    User user3 = new User("春天MVC3号", 3, "男");
    User user4 = new User("春天MVC4号", 3, "男");
    List<User> list = new ArrayList<User>();
    list.add(user1);
    list.add(user2);
    list.add(user3);
    list.add(user4);
    //将对象解析成为 json 格式
    String str = mapper.writeValueAsString(list);
    return str;
}

运行结果

5、输出时间对象

在 UserController.java 中增加一个新的方法

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

运行结果

抽取为工具类

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

public class JsonUtils {

    public static String getDateJson(Object object) {
        return getDateJson(object, "yyyy-MM-dd HH:mm:ss");
    }

    public static String getDateJson(Object object, String dateFormat) {
        //创建一个 jackson 的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //不使用时间差的方式
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        //自定义日期格式对象
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        //指定日期格式
        mapper.setDateFormat(sdf);
        try {
            return mapper.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }
}

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

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

6、FastJson

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

fastjson 的 pom 依赖

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

fastjson 三个主要的类

【JSONObject 代表 json 对象】
- JSONObject 实现了 Ma p接口，猜想 JSONObject 底层操作是由 Map 实现的。
- JSONObject 对应 json对象，通过各种形式的 get() 方法可以获取 json 对象中的数据，也可利用诸如size()，isEmpty()等方法获取 “键：值” 对的个数和判断是否为空。其本质是通过实现Map接口并调用接口中的方法完成的。
【JSONArray 代表 json 对象数组】
- 内部是有List接口中的方法来完成操作的
【JSON 代表 JSONObject 和 JSONArray 的转化】
- JSON类源码分析与使用
- 主要是实现json对象，json对象数组，javabean对象，json字符串之间的相互转化。

代码测试

新建一个FastJsonDemo.java 类

public class FastJsonDemo {
    public static void main(String[] args) {
        //创建一个对象
        User user1 = new User("春天MVC1号", 3, "男");
        User user2 = new User("春天MVC2号", 3, "男");
        User user3 = new User("春天MVC3号", 3, "男");
        User user4 = new User("春天MVC4号", 3, "男");

        List<User> list = new ArrayList<User>();
        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(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);
    }
}