SpirngMVC--Controller返回JSON数据(Jackson)&解决返回字符串出现乱码&@ResponseBody&@RestController

已于 2022-08-21 22:48:46 修改
阅读量1.1k 收藏 1
点赞数 2
分类专栏： # SSM 文章标签： 乱码 java spring json Jackson
于 2021-05-07 20:11:21 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/I_r_o_n_M_a_n/article/details/116499881
版权
本文介绍了如何在SpringMVC中使用Jackson进行JSON解析，包括导入依赖、配置web.xml、创建实体类、编写控制器以及解决乱码问题。通过示例展示了将对象转换为JSON字符串的方法，并探讨了@RestController和@ResponseBody的使用。最后，提出了封装工具类以提高代码复用性的建议。
摘要由CSDN通过智能技术生成

1. Jackson

Jackson是目前比较好的json解析工具了

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

1.1 导入它的jar包

我们这里使用Jackson，使用它需要导入它的jar包；

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

1.2 配置web.xml配置

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

1.3 springmvc-servlet.xml

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

    <!-- 自动扫描指定的包，下面所有注解类交给IOC容器管理 -->
    <context:component-scan base-package="com.tian.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>

1.4 User的实体类

在这里插入图片描述
User.java

package com.tian.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;

}

1.5 编写控制器Controller

在这里插入图片描述
UserController.java

package com.tian.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.tian.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("/json1")
    @ResponseBody
    public String json1() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        //创建一个对象
        User user = new User("天天天", 3, "男");
        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(user);
        //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
        return str;
    }
}

1.6 配置Tomcat,启动服务器测试

在这里插入图片描述

出现乱码问题

1.7 解决乱码问题

1.7.1 解决方法1

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

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

运行结果:

在这里插入图片描述

1.7.2 解决方法2(乱码统一解决)

上一种方法比较麻烦，如果项目中有许多请求则每一个都要添加，可以通过Spring配置统一指定，这样就不用每次都去处理了！
我们可以在springmvc的配置文件上添加一段消息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>

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

1.8 @ResponseBody&@RestController

1.8.1 @RestController

这个注解放在类的最上面，表明这个类的所有方法都不会走视图解析器，直接返回字符串。会把list自动解析为Json字符串返回。

1.8.2 @ResponseBody

这个注解放在方法的最上面，表明这个方法不会走视图解析器，直接返回字符串。会把list自动解析为Json字符串返回。

1.9 测试返回多个对象

    @RequestMapping(value = "/json2")
    @ResponseBody
    public String json2() throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();

        User user01 = new User("旭旭", 3, "男");
        User user02 = new User("天天", 4, "男");
        User user03 = new User("余余", 5, "男");
        User user04 = new User("磊磊", 6, "男");

        List<User> list = new ArrayList<>();

        list.add(user01);
        list.add(user02);
        list.add(user03);
        list.add(user04);

        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(list);
        //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
        return str;
    }

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

2.0 测试返回时间对象&处理时间

    @RequestMapping("/json3")
    @ResponseBody
    public String json3() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        //创建时间一个对象，java.util.Date
        Date date = new Date();
        //将我们的对象解析成为json格式
        String str = mapper.writeValueAsString(date);
        return str;
    }

在这里插入图片描述

注意:

  • 默认日期格式会变成一个数字，是1970年1月1日到当前日期的毫秒数！(时间戳)
  • Jackson 默认是会把时间转成timestamps形式

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

老办法（老手艺不能丢）

    @RequestMapping("/json5")
    @ResponseBody
    public String json5() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        Date date = new Date();
        //自定义日期格式对象
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        return mapper.writeValueAsString(sdf.format(date));
    }

在这里插入图片描述

新办法

    @RequestMapping("/json4")
    @ResponseBody
    public String json4() 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;
    }

在这里插入图片描述

2.1 学会封装工具类，实现代码的复用

在这里插入图片描述

JsonUtils.java

public  class JsonUtils {
    public static String printJsonStr(Object object) throws JsonProcessingException {
        //创建一个jackson的对象映射器，用来解析数据
        ObjectMapper mapper = new ObjectMapper();
        String str = mapper.writeValueAsString(object);
        //由于@ResponseBody注解，这里会将str转成json格式返回；十分方便
        return str;
    }

    public static String dateFormat(Date date, String format) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        //不使用时间戳的方式
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
        //自定义日期格式对象
        SimpleDateFormat sdf = new SimpleDateFormat(format);
        //指定日期格式
        mapper.setDateFormat(sdf);
        return mapper.writeValueAsString(date);
    }
}

使用工具类

    @RequestMapping("/json4")
    @ResponseBody
    public String json4() throws JsonProcessingException {
        Date date = new Date();
        return JsonUtils.dateFormat(date, "YYYY-MM-DD hh:mm:ss");
    }

在这里插入图片描述

    @RequestMapping(value = "/json2")
    @ResponseBody
    public String json2() throws JsonProcessingException {
        User user01 = new User("旭旭", 3, "男");
        User user02 = new User("天天", 4, "男");
        User user03 = new User("余余", 5, "男");
        User user04 = new User("磊磊", 6, "男");
        List<User> list = new ArrayList<>();
        list.add(user01);
        list.add(user02);
        list.add(user03);
        list.add(user04);
        
        return JsonUtils.printJsonStr(list);
    }

在这里插入图片描述

请记住：程序注重的是高内聚，低耦合。多写工具类封装重复代码，可以降低程序的耦合性。

CodeJiao
关注
专栏目录
评论 6
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

CodeJiao

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值