将电子邮件地址作为 Spring Boot DELETE 端点参数进行管理的最佳方法

在 Spring Boot 中使用 DELETE 端点的查询参数

此方法演示了如何使用查询参数将电子邮件地址传递到 Spring Boot DELETE 端点。此方法遵循 REST 原则，但需要谨慎以确保安全处理敏感数据。

// Import necessary packages
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    // Inject UserService for business logic
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    // Endpoint to soft-delete email address
    @DeleteMapping("/user/email")
    public ResponseEntity<String> softDeleteEmail(@RequestParam("email") String email) {
        boolean isDeleted = userService.softDeleteByEmail(email);

        if (isDeleted) {
            return ResponseEntity.ok("Email address soft-deleted successfully.");
        } else {
            return ResponseEntity.status(404).body("Email address not found.");
        }
    }
}

// Service logic
public class UserService {
    public boolean softDeleteByEmail(String email) {
        // Simulate database operation
        // Update 'status' column to 0 where email matches
        // Return true if operation succeeds
        return true;
    }
}

在 Spring Boot 中使用 DELETE 端点的请求正文

此方法使用请求正文来传递电子邮件地址。虽然 DELETE 方法非常规，但它可以确保电子邮件不会在 URL 中暴露。正确的验证在这里至关重要。

// Import necessary packages
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class UserController {

    // Inject UserService for business logic
    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    // Endpoint to soft-delete email address
    @DeleteMapping("/user/email")
    public ResponseEntity<String> softDeleteEmail(@RequestBody EmailRequest emailRequest) {
        boolean isDeleted = userService.softDeleteByEmail(emailRequest.getEmail());

        if (isDeleted) {
            return ResponseEntity.ok("Email address soft-deleted successfully.");
        } else {
            return ResponseEntity.status(404).body("Email address not found.");
        }
    }
}

// Request Body Model
public class EmailRequest {
    private String email;

    // Getters and setters
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

// Service logic
public class UserService {
    public boolean softDeleteByEmail(String email) {
        // Simulate database operation
        // Update 'status' column to 0 where email matches
        // Return true if operation succeeds
        return true;
    }
}

端点单元测试

此脚本使用 JUnit 和 MockMvc 为 DELETE 端点提供单元测试来验证这两种实现。

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

@WebMvcTest(UserController.class)
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testSoftDeleteByQueryParam() throws Exception {
        mockMvc.perform(delete("/user/email?email=test@example.com"))
               .andExpect(status().isOk());
    }

    @Test
    public void testSoftDeleteByRequestBody() throws Exception {
        String jsonBody = "{\"email\":\"test@example.com\"}";
        mockMvc.perform(delete("/user/email")
               .contentType("application/json")
               .content(jsonBody))
               .andExpect(status().isOk());
    }
}

关于删除端点的常见问题

1. 保护 DELETE 端点的最佳方法是什么？
2. 使用 HTTPS 进行安全通信和日志编辑过滤器，以避免敏感数据泄露。考虑基于令牌的授权，例如 JWT 或者 OAuth。
3. 我可以使用 @RequestBody 来执行 DELETE 请求吗？
4. 是的，尽管非常规，Spring Boot 支持 @RequestBody 对于 DELETE 请求，允许您在请求负载中包含数据。
5. 如何在 Spring Boot 中验证电子邮件地址？
6. 使用正则表达式或类似的库 Apache Commons Validator 在处理之前确保电子邮件格式正确。
7. 是否应该在查询参数中传递敏感数据？
8. 除非您使用以下方式保护数据，否则不建议这样做 HTTPS 并实施强大的日志记录实践来掩盖敏感信息。
9. 如何测试我的 DELETE 端点？
10. 使用 MockMvc 用于单元测试或类似工具 Postman 用于手动测试。验证各种场景的响应，例如成功和失败案例。

有效参数处理的关键要点

在决定是否对 DELETE 端点使用查询参数或请求正文时，选择很大程度上取决于您的优先级 - REST 遵守与数据保护。两种方法都有权衡，但通过 HTTPS 和日志记录实践，查询参数通常是可以接受的。 🛡️

确保输入验证、安全传输和适当授权可以增强您的实施。通过深思熟虑的设计，您的 Spring Boot 应用程序可以保持功能和用户信任，为更清洁、安全的 API 铺平道路。 🔧