003.springboot web篇：快速构建较复杂的RESTful API与单元测试

最新推荐文章于 2025-02-21 17:32:13 发布
最新推荐文章于 2025-02-21 17:32:13 发布
阅读量964 收藏 2
点赞数 1
分类专栏： java springboot 文章标签： java springboot web
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/sld880311/article/details/79460904
版权
这篇博客通过订单管理的案例，介绍了如何使用SpringBoot快速构建较复杂的RESTful API，并讲解了常用的注解如@Controller、@RestController、@RequestMapping等的用法。同时，博主提供了实体类Order、Controller OrderController以及单元测试类OrderControllerTest的代码参考，帮助读者理解web应用的开发流程。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

说明

通过实现订单的增删改查，初步了解web相关的构建和使用

REStful API规划

请求类型URL说明
GET/orders查询所有订单
POST/orders/add创建一个订单
GET/orders/id查询一个订单
POST/orders/update/id更新订单
DELETE/orders/delete/id删除订单

常用注解说明

  1. @Controller：修饰class，用来创建处理http请求的对象
  2. @RestController：Spring4之后加入的注解，原来在@Controller中返回json需要@ResponseBody来配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，默认返回json格式。
  3. @RequestMapping：配置url映射
  4. @PathVariable：通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中：URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。
  5. @ModelAttribute：
    ①绑定请求参数到命令对象：放在功能处理方法的入参上时，用于将多个请求参数绑定到一个命令对象，从而简化绑定流程，而且自动暴露为模型数据用于视图页面展示时使用；
    ②暴露表单引用对象为模型数据：放在处理器的一般方法（非功能处理方法）上时，是为表单准备要展示的表单引用对象，如注册时需要选择的所在城市等，而且在执行功能处理方法（@RequestMapping注解的方法）之前，自动添加到模型对象中，用于视图页面展示时使用；
    ③暴露@RequestMapping方法返回值为模型数据：放在功能处理方法的返回值上时，是暴露功能处理方法的返回值为模型数据，用于视图页面展示时使用。
  6. @RequestParam：获取url中的参数，用于将请求参数区数据映射到功能处理方法的参数上。

代码参考

实体类order

package com.sunld.domain;

public class Order {

    /**
     * 订单id
     */
    private Integer id;
    /**
     * 订单名称
     */
    private String orderName;
    /**
     * 订单类型
     */
    private String orderType;

    /**
     * get、set方法
     */
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getOrderName() {
        return orderName;
    }
    public void setOrderName(String orderName) {
        this.orderName = orderName;
    }
    public String getOrderType() {
        return orderType;
    }
    public void setOrderType(String orderType) {
        this.orderType = orderType;
    }
    @Override
    public String toString() {
        return "Order [id=" + id + ", orderName=" + orderName + ", orderType=" + orderType + "]";
    }
}

Controller：OrderController

package com.sunld;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.sunld.domain.Order;

@RestController
//定义统一的入口，通过这里配置使下面的映射都在/orders下
@RequestMapping("/orders")
public class OrderController {

    //定义线程安全的map用来存储订单信息
    private static final Map<Integer , Order> staticOrderMap = 
            Collections.synchronizedMap(new HashMap<Integer, Order>());

    /**
     * 查询所有订单
     * url地址：http://127.0.0.1:8080/orders/
     * 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
     * @return
     */
    @RequestMapping(value = "/" , method = RequestMethod.GET)
    public List<Order> getOrders(){
        List<Order> orderList = new ArrayList<Order>(staticOrderMap.values());
        return orderList;
    }

    /**
     * 添加订单
     * url地址：http://127.0.0.1:8080/orders/add
     * @ModelAttribute：用来接收form中的订单信息
     * 除了@ModelAttribute绑定参数之外，还可以通过@RequestParam从页面中传递参数
     * @param order
     * @return
     */
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    public String addOrder(@ModelAttribute Order order) {
        if(order != null) {
            staticOrderMap.put(order.getId(), order);
            return "success";
        }
        return "failure";
    }

    /**
     * 根据订单id获取订单信息
     * url地址：http://127.0.0.1:8080/orders/1234
     * url中的id可通过@PathVariable绑定到函数的参数中
     * @return
     */
    @RequestMapping(value = "/{id}" , method = RequestMethod.GET)
    public Order getOrderById(@PathVariable Integer id) {
        return staticOrderMap.get(id);
    }
    /**
     * 根据订单id更新订单信息
     * url地址：http://127.0.0.1:8080/orders/update/1234
     * @param id
     * @param order
     * @return
     */
    @RequestMapping(value = "/update/{id}" , method = RequestMethod.POST)
    public String updateOrderById(@PathVariable Integer id, @ModelAttribute Order order) {
        Order o = staticOrderMap.get(id);
        if(o != null && order != null) {
            o.setOrderName(order.getOrderName());
            o.setOrderType(order.getOrderType());
            staticOrderMap.put(id, o);
            return "success";
        }else {
            return "failure";
        }
    }
    /**
     * 根据订单ID删除订单信息
     * url地址：http://127.0.0.1:8080/orders/delete/1234
     * @param id
     * @return
     */
    @RequestMapping(value="/delete/{id}", method=RequestMethod.DELETE) 
    public String deleteOrderById(@PathVariable Integer id) { 
        staticOrderMap.remove(id); 
        return "success"; 
    } 
}

测试类：OrderControllerTest

package com.sunld.controller;

import static org.hamcrest.CoreMatchers.equalTo;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.ResultActions;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultHandlers;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import com.sunld.OrderController;

@RunWith(SpringRunner.class)
@SpringBootTest
public class OrderControllerTest {
    private MockMvc mvc; 

    @Before 
    public void setUp() throws Exception { 
        mvc = MockMvcBuilders.standaloneSetup(new OrderController()).build(); 
    } 

    @Test
    public void testOrderController() throws Exception {
        //1.创建查询所有订单，结果返回为空
        System.out.println("=====================初次查询所有订单信息start=====================");
        getOrders()
           .andExpect(MockMvcResultMatchers.content().string(equalTo("[]")))
           .andReturn();
        System.out.println("=====================初次查询所有订单信息end=======================");
        System.out.println("=====================第一次添加订单start=========================");
        // 2、post提交一个订单
        mvc.perform(MockMvcRequestBuilders.post("/orders/add")
                        .param("id", "1234")
                        .param("orderName", "购买平板电脑")
                        .param("orderType", "在线付款")
                        .accept(MediaType.APPLICATION_JSON))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andDo(MockMvcResultHandlers.print())
            .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
            .andReturn();
        //2.1、查询所有订单
        /**
         * 结果应该为"[{\"id\":1234,\"orderName\":\"购买平板电脑\",\"orderType\":\"在线付款\"}]"
         */
        getOrders()
           .andExpect(MockMvcResultMatchers.content().string(equalTo("[{\"id\":1234,\"orderName\":\"购买平板电脑\",\"orderType\":\"在线付款\"}]")))
           .andReturn();
        System.out.println("=====================第一次添加订单end===========================");
        System.out.println("=====================再次添加订单start===========================");
        //3、再添加一个订单
        mvc.perform(MockMvcRequestBuilders.post("/orders/add")
                .param("id", "3456")
                .param("orderName", "购买奶粉")
                .param("orderType", "货到付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
           .andReturn();
        //3.1、查看所有订单信息
        /**
         * 订单信息：
         * [{"id":3456,"orderName":"购买奶粉","orderType":"货到付款"},{"id":1234,"orderName":"购买平板电脑","orderType":"在线付款"}]
         */
        getOrders();
        System.out.println("=====================再次添加订单end=============================");
        System.out.println("=====================修改存在编号的订单start============================");
        //4、修改编号为1234的订单：该订单存在
        mvc.perform(MockMvcRequestBuilders.post("/orders/update/1234")
                .param("orderName", "订单名称由【购买平板电脑】修改为【再次购买平板电脑】")
                .param("orderType", "在线付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andReturn();
        //4.1查询订单1234
        getOrdersById("1234");
        System.out.println("=====================修改存在编号的订单end==============================");
        System.out.println("=====================修改订单编号不存在的订单start==============================");
        //5、修改编号为1的订单、该订单不存在,直接返回failure
        mvc.perform(MockMvcRequestBuilders.post("/orders/update/1")
                .param("orderName", "订单名称由【购买平板电脑】修改为【再次购买平板电脑】")
                .param("orderType", "在线付款")
                .accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("failure")))
           .andReturn();
        System.out.println("=====================修改订单编号不存在的订单end==============================");
        //6、删除订单1234
        mvc.perform(MockMvcRequestBuilders.delete("/orders/delete/1234").accept(MediaType.APPLICATION_JSON))
           .andExpect(MockMvcResultMatchers.status().isOk())
           .andDo(MockMvcResultHandlers.print())
           .andExpect(MockMvcResultMatchers.content().string(equalTo("success")))
           .andReturn();
        //6、1查看所有订单
        getOrders();
    }

    private ResultActions getOrders() throws Exception {
        return mvc.perform(MockMvcRequestBuilders.get("/orders/").accept(MediaType.APPLICATION_JSON))
                  .andExpect(MockMvcResultMatchers.status().isOk())
                  .andDo(MockMvcResultHandlers.print());
//                .andReturn();
    }

    private ResultActions getOrdersById(String id) throws Exception {
        return mvc.perform(MockMvcRequestBuilders.get("/orders/" + id).accept(MediaType.APPLICATION_JSON))
                  .andExpect(MockMvcResultMatchers.status().isOk())
                  .andDo(MockMvcResultHandlers.print());
//                .andReturn();
    }
}

总结

参考

spring学习之@ModelAttribute运用详解
@RequestParam详解
Spring Boot构建RESTful API与单元测试

代码

https://github.com/sld880311/springboot-learning/tree/master/springboot_simpleweb

无涯教程-Spring Boot - Rest单元测试
无涯教程
04-14 608
首先，需要通过使用MockMvc创建用于创建Web应用程序上下文的Abstract类文件，并定义mapToJson()和mapFromJson()方法，以将Java对象转换为JSON字符串，并将JSON字符串转换为Java对象。接下来，编写一个扩展AbstractTest类的类文件，并为每个方法(例如GET，POST，PUT和DELETE)编写一个单元测试。无涯教程网提供Spring Boot提供了一种简单的方法来编写Rest Controller文件的单元测试。下面给出了删除API测试用例的代码。
SpringBoot 启动加速：优化与定制化干预技术解析
热门推荐
张彦峰的博客
04-20 175万+
给出SpringBoot启动配置原理详解分析，并介绍Spring Boot启动过程中可以实现的干预工作，最后给出如何缩短SpringBoot项目的启动时间
Spring Boot实战：Restful API的构建
ankuiba5737的博客
01-09 238
　　上一篇文章讲解了通过Spring boot与JdbcTemplate、JPA和MyBatis的集成，实现对数据库的访问。今天主要给大家分享一下如何通过Spring boot向前端返回数据。 　　在现在的开发流程中，为了最大程度实现前后端的分离，通常后端接口只提供数据接口，由前端通过Ajax请求从后端获取数据并进行渲染再展示给用户。我们用的最多的方式就是后端会返回给前端一个JSON字...
SpringBoot详解
最新发布
geinvse_seg的博客
02-21 4478
因此，把应用的主类放在根包中，SpringBoot就会自动扫描并加载所有需要的组件和配置，让你可以专注于编写业务代码，而不用担心复杂的配置细节。Spring提供了大量的子模块，如Spring Core、Spring Web、Spring Data等，但它们的配置复杂度较高，且需要开发者手动配置各类文件和依赖。启用了SpringBoot的自动配置功能，SpringBoot会根据项目中的依赖，自动配置很多常用的 Spring组件，这样就不需要手动配置它们。目录下，提供了默认的配置。
使用Spring Boot构建RESTful API
技术研究中心
07-06 2134
大家好，我是免费搭建查券返利机器人省钱赚佣金就用微赚淘客系统3.0的小编，也是冬天不穿秋裤，天冷也要风度的程序猿！通过这篇文章，你将了解RESTful API的基本概念、Spring Boot的相关配置以及实际操作步骤。Spring Boot是一个简化的Spring框架，可以快速创建独立的、生产级的Spring应用。我们将通过Spring Initializr快速创建一个Spring Boot项目，并构建一个简单的用户管理RESTful API。点击“Generate”按钮，下载项目并解压。
Spring Boot构建RESTful API
JavaAlliance
07-09 782
首先，回顾并详细说明一下在快速入门中使用的@Controller、@RestController、@RequestMapping注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例，建议先看一下快速入门的内容。 @Controller：修饰class，用来创建处理http请求的对象 @RestController：Spring4之后加入的注解，原来在@Controller中返回j...
Spring Boot 构建一个较为复杂的RESTful API以及单元测试
琅天溪的博客
11-28 1168
首先，回顾并详细说明一下在快速入门中使用的@Controller、@RestController、@RequestMapping注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例，建议先看一下快速入门的内容。快速入门传送门。@Controller：修饰class，用来创建处理http请求的对象 @RestController：Spring4之后加入的注解，原来在@Controll
详解SpringBoot restful api的单元测试
08-29
详解SpringBoot restful api的单元测试 在本文中，我们将详细介绍如何使用Spring Boot框架对Restful API进行单元测试。单元测试是软件测试中的一种方法，通过对软件的每一个单元进行测试，以确保软件的每一个单元都...
使用 SpringBoot 构建一个RESTful API
互联网从业者/大数据架构师/全栈开发者
12-02 2895
本文介绍了一篇讲述 RESTfull API 的文章，并以此为基础，演示了一个使用 SpringBoot 构建 RESTfull API 应用的完整过程，核心的配置和注解也给出了说明，希望对大家有帮助。
SpringBoot 实现RESTful API操作指南与应用场景详解
02-07
适用人群：对于希望快速掌握如何利用Spring Boot来构建现代化Web应用程序的服务端开发者以及有一定后端开发经验但对RESTful规范不太熟悉的工程师来说都是非常有用的参考资料。 使用场景及目标：适用于构建前后端分离...
Spring Boot 实战：快速搭建 RESTful API 服务
你好，欢迎来到我的个人技术博客！我是一个还有头发的程序猿，一名热衷于探索编程奥秘的程序员。在这个充满无限可能的数字时代，我致力于通过代码编织梦想，解决问题，不断追求技术的极致。 自从踏上编程之旅以来，我涉足了多个领域，包括但不限于Web开发、移动应用开发
07-30 1507
通过上述步骤，您已经成功地创建了一个基于 Spring Boot 的 RESTful API 服务，并将其打包成了 Docker 容器以便于部署。这个示例虽然简单，但它涵盖了构建一个实际应用所需的所有基本概念。
SpringBoot入门（三）（Spring Boot构建RESTful API）
weixin_38946418的博客
06-28 212
学习资料：http://blog.didispace.com/springbootrestfulapi/写今天的博客之前，先将今天会用到的注解简单的解释一下：名称描述@RequestController使用了这个注解的类会被看作一个controller-使用@RequestMapping的方法有一个默认的@ResponseBody注解。@RequestMapping(“/user”)处理请求地址映...
SpringBoot构建RESTful API——基础构建
github_34889651的博客
12-17 4338
1：简单，简单，就是因为简单@RestController @RequestMapping("/user") public class UserController { Map<String,User> userDB = Collections.synchronizedMap(new HashMap<String, User>()); @RequestMapping(value="/sa
SpringBoot restful api的单元测试
weixin_34266504的博客
01-04 371
1.添加Springboot测试注解 @RunWith(SpringRunner.class) @SpringBootTest public class UserControllerTest { } 复制代码2.伪造mvc环境 // 注入Spring 工厂 @Autowired private WebApplicationContext wac; //伪造mvc环境 ...
（五）Spring Boot构建RESTful API与进行单元测试
Within的博客
08-22 439
 创建domain对象User package cn.wsy.domain;/** * Created by Administrator on 2018/8/22. */ /** * @ClassName: User * `*@Description: TODO * `*@AuthorAdministrator * `*@Date 2018/8/22 10:41 * `*@...
Spring Boot学习(三)之构建RESTful API与单元测试
筱进GG
11-10 997
  我们之前使用的@Controller、@RestController、@RequestMapping注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例，建议先看一下springMVC的注解; @Controller：修饰class，用来创建处理http请求的对象 @RestController：Spring4之后加入的注解，原来在@Controller中返回json需要...
Spring Boot 单元测试-测试api
jim18的博客
08-01 377
Spring Boot 单元测试-api测试
java restful接口测试_详解SpringBoot restful api的单元测试
weixin_39997443的博客
02-26 223
现在我们来利用Spring Boot来构建一个RestFul API，具体如下：1.添加Springboot测试注解@RunWith(SpringRunner.class)@SpringBootTestpublic class UserControllerTest {}2.伪造mvc环境// 注入Spring 工厂@Autowiredprivate WebApplicationContext wa...
Spring Boot之构建RESTful API与单元测试
疯一样的女子
05-18 448
首先，回顾并详细说明一下在快速入门中使用的@Controller、@RestController、@RequestMapping注解。如果您对Spring MVC不熟悉并且还没有尝试过快速入门案例，建议先看一下快速入门的内容。 @Controller：修饰class，用来创建处理http请求的对象 @RestController：Spring4之后加入的注解，原来在@Controller中返回json需要@ResponseBody来配合，如果直接用@RestController替代@Controller
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值