Spring学习(八)——Spring MVC之Restful API返回json数据

最新推荐文章于 2024-03-28 15:26:54 发布

原创最新推荐文章于 2024-03-28 15:26:54 发布 · 560 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#spring #restful #json #java #mvc

Spring全家桶专栏收录该内容

28 篇文章

订阅专栏

本文介绍如何在SpringMVC项目中实现前后端分离，通过引入Jackson依赖将Controller返回的对象转换为JSON格式，适用于现代Web应用开发。文章详细解释了使用@RestController和@ResponseBody注解的方法，展示了如何响应前端请求。

在上一篇博客的基础之上，对Spring MVC的使用有了一个基本的了解，而现在基本上都是用的前后端分离，因此需要对上一篇博客的demo进行一些修改，来满足我们的需要。

文章目录

一、引入jackson依赖

jackson方便直接将Controller中的对象转为json对象返回给前端。

    <!--jackson-->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.9.0</version>
    </dependency>

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

二、在Controller类中添加注解

方式一：@RestController

可以在Controller类上直接添加@RestController注解，省去@Controller注解，因为@RestController相当于@ResponseBody和@Controller一起的作用效果。在类上添加该注解后，下面的方法默认都将返回的对象转为json字符串。

package cool.gjh.controller;

import cool.gjh.entity.Student;
import cool.gjh.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Controller层
 * <p>
 *     Restful风格，返回json数据
 * </p>
 * @author ACE_GJH
 */
@RestController
@RequestMapping("/student")
public class StudentRestfulController {

    @Autowired
    private StudentService studentService;

    @RequestMapping(value = "/data", method = RequestMethod.GET)
    public Map<String, Object> showAll(){

        List<Student> students = studentService.getAllStudent();
        HashMap<String, Object> data = new HashMap<>(4*5/4, 0.8f);
        data.put("code", 200);
        data.put("msg", "OK");
        data.put("data", students);
        data.put("date", System.currentTimeMillis());

        return null;

    }

}

测试效果：
运行结果

方式二：@ResponseBody

在Controller类的方法上添加@ResponseBody注解，则该方法返回的对象将会以

package cool.gjh.controller;

import cool.gjh.entity.Student;
import cool.gjh.service.StudentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Controller层
 * <p>
 *     Restful风格，返回json数据
 * </p>
 * @author ACE_GJH
 */
@Controller
@RequestMapping("/student")
public class StudentRestfulController {

    @Autowired
    private StudentService studentService;

    @ResponseBody
    @RequestMapping(value = "/data", method = RequestMethod.GET)
    public Map<String, Object> showAll(){

        List<Student> students = studentService.getAllStudent();
        HashMap<String, Object> data = new HashMap<>(4*5/4, 0.8f);
        data.put("code", 200);
        data.put("msg", "OK");
        data.put("data", students);
        data.put("date", System.currentTimeMillis());
        return data;

    }

}