Cara Terbaik untuk Mengurus Alamat E-mel sebagai Spring Boot DELETE Parameter Endpoint

Menggunakan Parameter Pertanyaan untuk DELETE Endpoint dalam Spring Boot

Pendekatan ini menunjukkan cara menggunakan parameter pertanyaan untuk menghantar alamat e-mel ke titik akhir Spring Boot DELETE. Kaedah ini mematuhi prinsip REST tetapi memerlukan berhati-hati untuk memastikan data sensitif dikendalikan dengan selamat.

// 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 dalam But Spring

Pendekatan ini menggunakan badan permintaan untuk menghantar alamat e-mel. Walaupun tidak konvensional untuk kaedah DELETE, ia memastikan e-mel tidak didedahkan dalam URL. Pengesahan yang betul adalah kritikal 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 ujian unit untuk titik akhir DELETE menggunakan JUnit dan MockMvc untuk mengesahkan kedua-dua pelaksanaan.

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

Soalan Lazim Mengenai DELETE Endpoints

1. Apakah cara terbaik untuk mendapatkan titik akhir DELETE?
2. Gunakan HTTPS untuk komunikasi selamat dan penapis redaksi log untuk mengelakkan pendedahan data sensitif. Pertimbangkan kebenaran berasaskan token seperti JWT atau OAuth.
3. Bolehkah saya menggunakan @RequestBody untuk permintaan DELETE?
4. Ya, walaupun tidak konvensional, Spring Boot menyokong @RequestBody untuk permintaan DELETE, membolehkan anda memasukkan data dalam muatan permintaan.
5. Bagaimanakah cara saya mengesahkan alamat e-mel dalam Spring Boot?
6. Gunakan regex atau perpustakaan seperti Apache Commons Validator untuk memastikan format e-mel adalah betul sebelum diproses.
7. Patutkah data sensitif dihantar dalam parameter pertanyaan?
8. Ia tidak disyorkan melainkan anda melindungi data menggunakan HTTPS dan melaksanakan amalan pembalakan yang teguh untuk menutup maklumat sensitif.
9. Bagaimanakah saya boleh menguji titik akhir DELETE saya?
10. guna MockMvc untuk ujian unit atau alatan seperti Postman untuk ujian manual. Sahkan respons untuk pelbagai senario, seperti kes kejayaan dan kegagalan.

Pengambilan Utama untuk Pengendalian Parameter Berkesan

Dalam memutuskan sama ada untuk menggunakan parameter pertanyaan atau badan permintaan untuk DELETE titik akhir, pilihan sebahagian besarnya bergantung pada keutamaan anda—pematuhan REST berbanding perlindungan data. Kedua-dua pendekatan mempunyai pertukaran, tetapi dengan HTTPS dan amalan pengelogan, parameter pertanyaan selalunya boleh diterima. 🛡️

Memastikan pengesahan input, penghantaran selamat dan kebenaran yang betul menguatkan pelaksanaan anda. Dengan reka bentuk yang bernas, aplikasi Spring Boot anda boleh mengekalkan kedua-dua fungsi dan kepercayaan pengguna, membuka jalan untuk API yang lebih bersih dan selamat. 🔧