Cara Terbaik Mengelola Alamat Email sebagai Parameter Titik Akhir Spring Boot DELETE

Menggunakan Parameter Kueri untuk DELETE Endpoint di Spring Boot

Pendekatan ini menunjukkan cara menggunakan parameter kueri untuk meneruskan alamat email ke titik akhir Spring Boot DELETE. Metode ini mematuhi prinsip REST namun memerlukan kehati-hatian untuk memastikan data sensitif ditangani dengan aman.

// 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;
    }
}

Menggunakan Badan Permintaan untuk DELETE Endpoint di Spring Boot

Pendekatan ini menggunakan badan permintaan untuk meneruskan alamat email. Meskipun tidak lazim untuk metode DELETE, metode ini memastikan email tidak terekspos di URL. Validasi yang tepat sangat penting di sini.

// 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;
    }
}

Unit Menguji Titik Akhir

Skrip ini menyediakan pengujian unit untuk titik akhir DELETE menggunakan JUnit dan MockMvc untuk memvalidasi kedua implementasi.

// 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());
    }
}

Pertanyaan Umum Tentang DELETE Endpoint

1. Apa cara terbaik untuk mengamankan titik akhir DELETE?
2. Gunakan HTTPS untuk komunikasi yang aman dan filter redaksi log untuk menghindari paparan data sensitif. Pertimbangkan otorisasi berbasis token seperti JWT atau OAuth.
3. Bisakah saya menggunakan @RequestBody untuk permintaan DELETE?
4. Ya, meskipun tidak konvensional, Spring Boot mendukung @RequestBody untuk permintaan DELETE, memungkinkan Anda memasukkan data dalam payload permintaan.
5. Bagaimana cara memvalidasi alamat email di Spring Boot?
6. Gunakan regex atau perpustakaan sejenisnya Apache Commons Validator untuk memastikan format email sudah benar sebelum diproses.
7. Haruskah data sensitif diteruskan dalam parameter kueri?
8. Ini tidak disarankan kecuali Anda mengamankan data menggunakan HTTPS dan menerapkan praktik pencatatan yang kuat untuk menutupi informasi sensitif.
9. Bagaimana cara menguji titik akhir DELETE saya?
10. Menggunakan MockMvc untuk pengujian unit atau alat sejenisnya Postman untuk pengujian manual. Validasi tanggapan untuk berbagai skenario, seperti kasus keberhasilan dan kegagalan.

Poin Penting untuk Penanganan Parameter yang Efektif

Dalam memutuskan apakah akan menggunakan parameter kueri atau isi permintaan untuk titik akhir DELETE, pilihannya sangat bergantung pada prioritas Anda—kepatuhan REST versus perlindungan data. Kedua pendekatan tersebut memiliki trade-off, namun dengan HTTPS dan praktik logging, parameter kueri sering kali dapat diterima. 🛡️

Memastikan validasi masukan, transmisi aman, dan otorisasi yang tepat akan memperkuat penerapan Anda. Dengan desain yang cermat, aplikasi Spring Boot Anda dapat mempertahankan fungsionalitas dan kepercayaan pengguna, membuka jalan bagi API yang lebih bersih dan aman. 🔧