Controller返回JSON数据

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

  • 当然工具不止这一个,比如还有阿里巴巴的 fastjson 等等。

1、测试

1、 我们这里使用Jackson,使用它需要导入它的jar包;

maven仓库地址下载https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.2.2</version>
</dependency>


2、配置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>
           <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"
      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.kuang.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>

3、我们随便编写一个User的实体类,然后我们去编写我们的测试Controller;

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

4、这里我们需要两个新东西,一个是@ResponseBody,一个是ObjectMapper对象,我们看下具体的用法

编写一个Controller;

package com.linfeng.controller;

import com.linfeng.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 {
    @ResponseBody//他不会走视图解析器,会直接返回一个字符串
    @RequestMapping("/j1")
    public String json1(){
        User user = new User("林峰", 3, "男");
        return user.toString();
    }
}

现在先运行一下,注意lib是否存在的404问题
在这里插入图片描述

下面使用json

package com.linfeng.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.linfeng.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 {
    @ResponseBody//他不会走视图解析器,会直接返回一个字符串
    @RequestMapping("/j1")
    public String json1() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User("林峰", 3, "男");
        String s = mapper.writeValueAsString(user);//writeValueAsString变为字符串
        return s;
    }
}

在这里插入图片描述

2、现在处理乱码问题

解决办法1

如果出现了乱码问题,我们需要设置一下他的编码格式为utf-8,以及他返回的类型

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

在这里插入图片描述
运行一下:
在这里插入图片描述

解决办法2

上一种方法比较麻烦,如果项目中有许多请求则每一个都要添加,可以通过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>

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

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

1、@ResponseBody解决(每个方法都得加,不建议使用)

package com.linfeng.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.linfeng.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 {
    @ResponseBody//他不会走视图解析器,会直接返回一个字符串
    @RequestMapping("j1")
    public String json1() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User("林峰", 3, "男");
        String s = mapper.writeValueAsString(user);//writeValueAsString变为字符串
        return s;
    }
}

2、@RestController(直接加到类上即可)

package com.linfeng.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.linfeng.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
//@Controller
@RestController//直接返回一个字符串
public class UserController {
    //@ResponseBody//他不会走视图解析器,会直接返回一个字符串
    @RequestMapping("j1")
    public String json1() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        User user = new User("林峰", 3, "男");
        String s = mapper.writeValueAsString(user);//writeValueAsString变为字符串
        return s;
    }
}



4、测试集合输出

增加一个新的方法

 @RequestMapping("/j2")
    public String json2() throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        List<User> userList = new ArrayList<User>();
        User user1 = new User("林峰", 3, "男");
        User user2 = new User("林峰", 3, "男");
        User user3 = new User("林峰", 3, "男");
        User user4 = new User("林峰", 3, "男");
        userList.add(user1);
        userList.add(user2);
        userList.add(user3);
        userList.add(user4);
        String s = mapper.writeValueAsString(userList);//writeValueAsString变为字符串
        return s;
    }

在这里插入图片描述

5、输出时间对象

增加一个新的方法

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

在这里插入图片描述
默认日期格式会变成一个数字,是1970年1月1日到当前日期的毫秒数!

Jackson 默认是会把时间转成timestamps形式
解决方案:取消timestamps形式 , 自定义时间格式 SimpleDateFormat

  @RequestMapping("/j3")
    public String json3() 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);
        //创建时间一个对象,java.util.Date
        Date date = new Date();
        //将我们的对象解析成为json格式
        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();

        //java自定义日期格式
        SimpleDateFormat sdf = new SimpleDateFormat(dateFormat);
        //sdf.format(date)

        // 使用ObjectMapper 来格式化输出
        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
        mapper.setDateFormat(sdf);

        try {
            //ObjectMapper,时间解析后的默认格式为:TImestamp.时间戳
            return mapper.writeValueAsString(object);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

}


我们使用工具类,代码就更加简洁了!

@RequestMapping("/j3")
    public String json3(){

        Date date = new Date();

        return JsonUtils.getJson(date,"yyyy-MM-dd HH:mm:ss");
    }
}

FastJson

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

fastjson 的 pom依赖!

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

fastjson 三个主要的类:

1、JSONObject 代表 json 对象

  • JSONObject实现了Map接口, 猜想 JSONObject底层操作是由Map实现的。
  • JSONObject对应json对象,通过各种形式的get()方法可以获取json对象中的数据,也可利用诸如size(),isEmpty()等方法获取"键:值"对的个数和判断是否为空。其本质是通过实现Map接口并调用接口中的方法完成的。

2、JSONArray 代表 json 对象数组

  • 内部是有List接口中的方法来完成操作的。

3、JSON代表 JSONObject和JSONArray的转化

  • JSON类源码分析与使用
  • 仔细观察这些方法,主要是实现json对象,json对象数组,javabean对象,json字符串之间的相互转化。

代码测试,我们新建一个FastJsonDemo 类

@RequestMapping("/j4")
    //@ResponseBody//他就不会走视图解析器,会直接返回一个 字符串
    public String json4(){

        User user1 = new User(1, "秦疆1号", 12);
        User user2 = new User(2, "秦疆2号", 12);
        User user3 = new User(3, "秦疆3号", 12);
        User user4 = new User(4, "秦疆4号", 12);
        User user5 = new User(5, "秦疆5号", 12);

        List<User> list = new ArrayList<User>();
        list.add(user1);
        list.add(user2);
        list.add(user3);
        list.add(user4);
        list.add(user5);

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

        return JSON.toJSONString(list);
    }

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

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 在控制器中返回 JSON 数据可以使用一些框架自带的方法,例如在 ASP.NET Core 中可以使用 `Json()` 或 `JsonResult()` 方法来返回 JSON 数据。在其他框架中也有类似的方法,例如在 Ruby on Rails 中可以使用 `render json: data` 来返回 JSON 数据。 ### 回答2: 在现代Web开发中,Controller是一个非常重要的组件,它被用于处理客户端请求并返回相关数据。在许多情况下,Controller简单地返回一个JSON格式的数据JSON是一种轻量级的数据交换格式,它的灵活性和易读性使得它成为了当前Web开发中最常用的数据格式之一。 Controller返回JSON数据这种方式非常常见,特别是在单页应用(SPA)中,因为在SPA中,数据的传输被更高效地处理,并且前端框架可以直接以JSON格式解析数据。但是,对于传统的多页应用程序,Controller也可以返回JSON数据,并与AJAX或XHR等JavaScript库配合使用。 Controller返回JSON数据通常包括支持操作的动作和相关数据。例如,在一个包含用户信息的web应用中,Controller可能返回一个包含登录用户的详细信息的JSON对象,这将允许客户端以JSON对象的形式将此数据呈现给用户,并使用它来控制其他应用程序组件的行为。此外,Controller还可以返回其他一些数据类型,如纯文本字符串或HTML。 总的来说,Controller返回JSON数据,使得客户端可以通过JavaScript与后端数据交互,获取需要的数据并进行操作。这带来了许多优势,其中包括更高效的数据传输,更低的带宽使用和更快的页面数据渲染时间。此外,JSON数据格式非常易于处理,因此可以轻松地将数据与前端框架进行集成。综上所述,Controller返回JSON数据已成为现代Web应用程序中最普遍的数据交换方式之一,它大大提高了应用程序的交互效率和数据安全性。 ### 回答3: Controller返回JSON数据时,通常用于前后端分离式架构中。前端发起请求后,Controller接受请求,从数据库、缓存或其他第三方服务中获取数据,并将所需要的数据封装成JSON格式的数据返回给前端。 使用JSON格式的数据可以实现小数据包传递,传输速度快,而且便于解析。同时JSON还可以实现跨语言传输,方便前后端不同编程语言之间的数据交换。Controller返回JSON数据时,需要保证返回的格式正确,能够被前端的数据解析器正确解析。 在Controller内部,可以通过使用SpringMVC的ResponseBody注解,来告诉SpringMVC框架返回JSON格式数据。同时也可以通过使用Jackson等JSON解析器来进行数据的转换和序列化。 在前端接收到JSON数据之后,可以使用JavaScript的JSON.parse()方法将JSON格式数据转化成JavaScript对象。这样就可以在前端使用JavaScript来进行数据的渲染和操作。 总之,Controller返回JSON数据是一种实现前后端分离式架构的重要手段,提高了应用的性能、可维护性和可扩展性。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值