📣前言

  在RESTful API设计中，HTTP DELETE请求扮演着重要的角色，用于实现资源的删除功能。Spring框架通过@DeleteMapping注解提供了一种简洁的方式来处理这类请求。本文将深入探讨@DeleteMapping的使用方法，帮助开发者在Spring应用中高效地实现DELETE请求的处理。

  那么，具体如何实现呢？这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！
<div align=center> <img src=https://img-blog.csdnimg.cn/331866bf91ba42a1834c7db92b5794a2.jpeg width=200 /> </div>

🌊环境说明

开发工具：IDEA 2021.3 JDK版本： JDK 1.8 Spring Boot版本：2.3.1 RELEASE Maven版本：3.8.2

🏆本文收录于《Spring Boot从入门到精通》，专门攻坚指数提升，2023 年国内最系统+最强（更新中）。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习，可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内，快速投入学习！！两不误。

🌊摘要

🌊正文

摘要

  @DeleteMapping是Spring MVC中用于处理HTTP DELETE请求的注解。它允许开发者将特定的URL路径与控制器中的方法绑定，以便在接收到DELETE请求时执行相应的业务逻辑。本文将从基本概念出发，通过实际代码示例和测试用例，全面解析@DeleteMapping的应用，并探讨其优缺点。

简介

  @DeleteMapping是@RequestMapping注解的特化，专门用于处理HTTP DELETE请求。使用此注解可以清晰地表明方法的用途，同时简化配置。

源代码解析

  以下是使用@DeleteMapping注解的一个基本示例：

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ItemController {

    // 使用@DeleteMapping注解映射"/items/{id}"路径到这个方法
    @DeleteMapping("/items/{id}")
    public String deleteItem(@PathVariable int id) {
        // 业务逻辑处理，比如根据id删除资源
        // 这里省略了实际的数据库操作代码
        return "Item with id " + id + " deleted successfully";
    }
}

  在这个示例中，@DeleteMapping注解将URL路径/items/{id}映射到deleteItem方法，该方法接收资源的ID作为参数。

  接着我将对上述代码进行详细的一个逐句解读，希望能够帮助到同学们，能以更快的速度对其知识点掌握学习，这也是我写此文的初衷，授人以鱼不如授人以渔，只有将其原理摸透，日后应对场景使用，才能得心应手，所以如果有基础的同学，可以略过如下代码分析步骤，然而没基础的同学，还是需要加强对代码的理解，方便你深入理解并掌握其常规使用。

代码解析

  这段代码演示了如何在Spring MVC框架中使用@RestController和@DeleteMapping注解来创建一个处理HTTP DELETE请求的RESTful API端点。以下是对代码的详细解析：

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController // 1. 声明这是一个控制器，所有的方法返回值都将作为HTTP响应的正文
public class ItemController {

    // 2. 使用@DeleteMapping注解映射"/items/{id}"路径到deleteItem方法
    @DeleteMapping("/items/{id}")
    public String deleteItem(@PathVariable int id) { // 3. 使用@PathVariable注解来接收URL中的参数
        // 4. 业务逻辑处理，比如根据id删除资源
        // 这里省略了实际的数据库操作代码
        // ...

        // 5. 返回删除成功的消息
        return "Item with id " + id + " deleted successfully";
    }
}
1. 控制器声明
  • @RestController：这个注解表明ItemController类是一个控制器，它的所有方法的返回值将直接作为HTTP响应的正文返回。
2. 请求映射
  • @DeleteMapping("/items/{id}")：这个注解将HTTP DELETE请求映射到/items/{id}路径。这里的{id}是一个路径变量，用于获取URL中的具体ID值。
3. 请求参数接收
  • @PathVariable int id：@PathVariable注解用于从URL路径中提取{id}的值，并将其作为参数传递给deleteItem方法。
4. 业务逻辑处理
  • 注释// 业务逻辑处理，比如根据id删除资源：这里应该包含实际的业务逻辑，例如根据提供的id在数据库中删除相应的资源。
5. 返回结果
  • return "Item with id " + id + " deleted successfully";：这行代码返回一个字符串消息，表示资源删除成功。在实际应用中，这里可能会返回更详细的响应信息或状态码。

应用场景

  ItemController类中的deleteItem方法可以用于处理用户通过HTTP DELETE请求删除特定资源的场景。例如，在一个电子商务应用中，用户可能需要删除其购物车中的商品。

优缺点

  • 优点：

    • 明确性：专门用于DELETE请求，提高了代码的可读性。
    • 易于使用：通过@PathVariable注解简化了URL参数的接收。

  • 缺点：

    • 限制性：只能用于DELETE请求，对于需要处理其他类型请求的方法不适用。
    • 安全性：需要适当的安全措施来防止恶意的资源删除操作。

测试用例

可以使用Spring的MockMvc工具来编写测试用例，验证ItemController的行为：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import org.junit.jupiter.api.Test;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(ItemController.class)
public class ItemControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testDeleteItem() throws Exception {
        mockMvc.perform(delete("/items/1"))
                .andExpect(status().isOk())
                .andExpect(content().string("Item with id 1 deleted successfully"));
    }
}

  这个测试用例模拟了对/items/1路径的DELETE请求，并验证了响应的状态码和正文内容是否符合预期。这确保了deleteItem方法按预期工作，能够接收请求并返回成功的响应消息。

  并附上部分相关注解源码截图，这里我就简单给附上，感兴趣的同学可以扒扒源码，深入去学习下开源框架的设计构思及理念，这也是掌握一个架构的核心目标，但是基础一般或者零基础的同学，建议先从使用上深入，而不是一口吃掉一个胖子，得不偿失。

image.png

  实际运用场景展示如下，这也是我日常项目开发中的实操之一，分享给大家看看，仅供参考：

image.png

应用场景案例

  这里我来演示个场景，比如考虑一个电子商务平台中的商品删除功能，可以通过DELETE请求实现：

@DeleteMapping("/products/{productId}")
public String deleteProduct(@PathVariable int productId) {
    // 删除产品的业务逻辑
    return "Product with id " + productId + " deleted successfully";
}

  这段代码是Spring MVC控制器中用于处理删除特定产品的HTTP DELETE请求的方法。下面是对这段代码的详细解析：

import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ProductController {

    // 使用@DeleteMapping注解来映射"/products/{productId}"路径到这个方法
    @DeleteMapping("/products/{productId}")
    public String deleteProduct(@PathVariable int productId) { // 使用@PathVariable注解来获取URL中的productId参数
        // 这里是删除产品的业务逻辑，例如：
        // 1. 根据productId查询产品是否存在
        // 2. 如果存在，执行删除操作并保存更改
        // 3. 处理任何可能的异常或错误情况

        // 省略了实际的数据库操作代码

        // 4. 返回一个确认信息，告知客户端产品已被成功删除
        return "Product with id " + productId + " deleted successfully";
    }
}

关键点解析

  • @RestController：声明ProductController类为Spring MVC的控制器，并且其方法的返回值将直接作为HTTP响应的正文返回。

  • @DeleteMapping("/products/{productId}")：将HTTP DELETE请求映射到/products/{productId}路径。这里的{productId}是一个路径变量，用于接收URL中指定的产品ID。

  • @PathVariable int productId：从请求URL中提取productId参数，并将其作为整数类型传递给deleteProduct方法。

  • 删除逻辑：deleteProduct方法中应包含删除产品的业务逻辑。在实际应用中，可能涉及检查产品是否存在、执行数据库删除操作、处理异常等。

  • 返回值：方法返回一个字符串，确认产品已被删除。在RESTful API设计中，通常建议返回更具描述性的状态信息或状态码，例如使用ResponseEntity对象来提供更丰富的响应。

应用场景

这个方法适用于电子商务网站或其他需要产品管理功能的应用程序，允许用户或系统管理员通过指定产品ID来删除产品信息。

优缺点

  • 优点：

    • 明确表示该方法处理DELETE请求，增强了代码的可读性。
    • 通过路径变量直接获取资源标识，简化了参数传递。

  • 缺点：

    • 如果没有适当的安全控制，可能会被滥用来删除敏感资源。
    • 仅限于处理DELETE请求，不够灵活处理其他类型的HTTP请求。

优缺点分析

优点

  • 明确性：专门用于DELETE请求，提高了代码的可读性和维护性。
  • 简化配置：减少了使用@RequestMapping时需要指定HTTP方法的配置。

缺点

  • 限制性：仅适用于DELETE请求，对于需要处理其他类型请求的方法不适用。
  • 安全性：DELETE请求可能会被滥用来删除重要资源，需要适当的安全措施。

类代码方法介绍

  @DeleteMapping通常与@PathVariable注解结合使用，以获取URL中的参数。

测试用例

  以下是使用JUnit和Spring Boot测试模块编写的测试用例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.junit.jupiter.api.Test;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(ItemController.class)
public class ItemControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testDeleteItem() throws Exception {
        mockMvc.perform(delete("/items/1"))
                .andExpect(status().isOk())
                .andExpect(content().string("Item with id 1 deleted successfully"));
    }
}

  实际运用场景展示如下，这也是我日常项目开发中的实操之一，分享给大家看看，仅供参考：

image.png

  接着我将对上述代码进行详细的一个逐句解读，希望能够帮助到同学们，能以更快的速度对其知识点掌握学习，这也是我写此文的初衷，授人以鱼不如授人以渔，只有将其原理摸透，日后应对场景使用，才能得心应手，所以如果有基础的同学，可以略过如下代码分析步骤，然而没基础的同学，还是需要加强对代码的理解，方便你深入理解并掌握其常规使用。

代码解析

  这段代码是一个使用Spring Boot测试框架编写的测试类，用于验证ItemController控制器中删除操作的行为。以下是对代码的详细解析：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import org.junit.jupiter.api.Test;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

// 指定只加载Web层的Spring上下文，用于测试控制器
@WebMvcTest(ItemController.class)
public class ItemControllerTest {

    // Spring容器自动注入MockMvc，用于模拟HTTP请求和响应
    @Autowired
    private MockMvc mockMvc;

    // 测试方法，用于验证/items/1路径的DELETE请求是否返回正确的状态码和内容
    @Test
    public void testDeleteItem() throws Exception {
        // 构建DELETE请求到/items/1路径
        mockMvc.perform(delete("/items/1"))
                // 断言服务器响应的状态码为200（HTTP OK）
                .andExpect(status().isOk())
                // 断言响应体内容为预期的删除成功消息
                .andExpect(content().string("Item with id 1 deleted successfully"));
    }
}

关键点解析

  • @WebMvcTest：此注解告诉Spring Boot测试框架，该测试类只关注Web层，即只加载Spring MVC相关的配置和组件。它指定了ItemController.class作为测试目标。

  • @Autowired MockMvc mockMvc：MockMvc是Spring MVC测试框架的一部分，用于模拟HTTP请求和验证响应。Spring容器会自动注入此对象。

  • @Test：此注解标记实际执行的测试方法。

  • MockMvcRequestBuilders.delete：构建一个HTTP DELETE请求。

  • status().isOk()：断言服务器响应的状态码为200，表示请求成功。

  • content().string()：断言响应体内容为预期的字符串。

测试用例完善建议

  在实际的测试中，可能需要添加更多的断言来验证响应体、响应头或其他业务逻辑相关的方面。例如，可以使用MockMvcResultMatchers.jsonPath()来断言JSON响应体中的特定字段。

  此外，如果测试需要特定的测试数据或配置，可以在测试类中添加相应的@BeforeEach方法或使用@WebMvcTest的locations属性指定额外的Spring组件扫描路径。

测试执行

  当使用JUnit 5执行此测试方法时，它将模拟一个DELETE请求到/items/1，并验证响应是否符合预期。如果响应状态码为200，并且响应体包含特定的删除成功消息，则测试将通过；否则，将标记为失败。这种测试方法有助于确保应用程序的行为符合预期，并且在开发过程中能够捕获回归错误。

全文小结

  通过本文的学习，我们深入了解了@DeleteMapping注解的使用方法和应用场景。从基础的映射到结合其他注解的高级用法，@DeleteMapping都显示出其在RESTful Web服务开发中的重要性。

总结

  @DeleteMapping是Spring MVC中处理HTTP DELETE请求的强大工具。它的使用简化了请求映射的配置，提高了代码的可读性和维护性。虽然它有一些限制，但在适合的场景下，@DeleteMapping是一个高效且易于使用的工具。

... ...

  ok，以上就是我这期的全部内容啦，若想学习更多，你可以持续关注我，我会把这个多线程篇系统性的更新，保证每篇都是实打实的项目实战经验所撰。只要你每天学习一个奇淫小知识，日积月累下去，你一定能成为别人眼中的大佬的！功不唐捐，久久为功！

「赠人玫瑰，手留余香」，咱们下期拜拜~~

🌊热文推荐

滴~如下推荐【Spring Boot 进阶篇】的学习大纲，请小伙伴们注意查收。

[Spring Boot进阶(01)：使用Spring Boot和Redis轻松实现高性能、高可用的缓存服务。]

[Spring Boot进阶(02)：防止程序员疯狂 Debug：快速掌握 Validation 参数校验技巧，让你的代码健康起来！]

[Spring Boot进阶(03)：【实战教程】MyBatis-Plus秒级实现字段自动填充，让你的代码更优雅！]

[Spring Boot进阶(04)：震惊！使用MyBatis-Plus，快速实现自定义SQL分页功能！]

[Spring Boot进阶(05)：Spring Boot与RabbitMQ完美融合，打造高效消息队列服务！]

[Spring Boot进阶(06)：【超详细】Windows10搭建RabbitMQ Server服务端，让你轻松实现消息队列管理！]

[Spring Boot进阶(07)：如何使用EasyPoi实现Java中Excel的导入导出？完整教程请收藏，让你的Excel操作更高效！]

[Spring Boot进阶(08)：使用EasyPoi实现Excel/Word携带图片导出，打造精美的报表]

[Spring Boot进阶(09)：用EasyPoi实现Excel多sheet导入导出，轻松管理海量数据！]

[Spring Boot进阶(10)：「从Excel到PDF，EasyPoi助你一键完美转换！」]

[Spring Boot进阶(11)：实现纯文本转成.csv格式文件，Spring Boot轻松搞定！附完整代码]

[Spring Boot进阶(12)：如何快速获取Excel文件中的Sheet页数量？Spring Boot教程带你一步步实现]

[Spring Boot进阶(13)：如何优雅获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值，附源码]

[Spring Boot进阶(14)：Spring Boot高级应用：手把手教你连接数据库并获取指定表结构！一文教会你]

[Spring Boot进阶(15)：用Spring Boot实现动态数据库分页查询表结构信息！]

[Spring Boot进阶(16)：使用Redis实现手机验证码功能，让你的用户注册更加便捷！]

[Spring Boot进阶(17)：Swagger2高级配置：定制header请求头等参数]

[Spring Boot进阶(18)：轻松管理定时任务！Spring Boot@Scheduled让你事半功倍]

[Spring Boot进阶(19)：探索ElasticSearch：如何利用Spring Boot轻松实现高效数据搜索与分析]

[Spring Boot进阶(20)：「打造高性能Web应用」——使用Jetty容器配置Spring Boot]

[Spring Boot进阶(21)：优化Spring Boot应用性能，使用Undertow容器提升响应速度]

[Spring Boot进阶(22)：决战容器之巅：Tomcat vs Undertow！性能对比分析揭秘最佳选择！]

[Spring Boot进阶(23)：终极解决方案！教你实现高效文件上传！]

[Spring Boot进阶(24)：秒传！快速实现高效多文件上传的最佳解决方案]

[Spring Boot进阶(25)：如何写出高效的文件上传单元测试？让你的测试更智能更高效！]

[Spring Boot进阶(26)：从小白到高手，掌握Mybatis中resultType和resultMap的秘密！]

[Spring Boot进阶(27)：Spring Boot进阶(27)：Kafka大显身手，快速构建消息驱动应用！(环境搭建+演示)]

[Spring Boot进阶(28)：如何让Spring Boot应用在Linux中以后台服务方式启动，并实现滚动日志查看及保存至实体文件？]

[Spring Boot进阶(29)：如何正确使用Spring Boot注解@PathVariable、@RequestParam和@RequestBody: Postman演示教程]

[Spring Boot进阶(30)：@RestController与@Controller的区别及使用场景详解，附带精彩实战演示]

... ...

  若想系统性的从0到1的入门进阶学习，可以参考这篇专栏总结《2024最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏致力打造全网最硬核 Spring Boot 学习及进阶SpringBoot 系列教学内容，🚀均为全网独家首发，致力打造精品硬核干货，专栏永持续更新。欢迎大家订阅学习。一分耕耘一份收获！

  如果想快速定位学习，可以看这篇【一站式教程导航】,你想学习的都被收录系统整理在内，以最快的速度投入并学习掌握！！你值得拥有。

  在入门及进阶之途，我必助你一臂之力，系统性学习，从入门到精通，带你不走弯路，直奔终点！投资自己，性价比永远最高，都这么说了，你还不赶紧来白嫖？？

  本文涉及所有源代码，均已上传至GitHub开源，供同学们一对一参考 GitHub传送门，同时，原创开源不易，欢迎给个star🌟，想体验下被🌟的感jio，非常感谢❗

📣文末

我是bug菌，CSDN | 掘金 | InfoQ | 51CTO | 华为云 | 阿里云 | 腾讯云 等社区博客专家，C站博客之星Top30，华为云2023年度十佳博主，掘金多年度人气作者Top40，掘金等各大社区签约作者，51CTO年度博主Top12，掘金/InfoQ/51CTO等社区优质创作者；全网粉丝合计 30w+；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试真题、4000G PDF电子书籍、简历模板等海量资料，你想要的我都有，关键是你不来拿哇。