Java for Beginner

Работа с HTTP-методами в Spring: GET, POST, PUT, DELETE

HTTP-методы (или «глаголы») — это действия, которые клиент может выполнять на ресурсе в веб-приложении. В контексте RESTful архитектуры, они представляют собой стандартные операции для взаимодействия с ресурсами.

Spring предоставляет удобный механизм работы с HTTP-методами через аннотации контроллеров, такие как @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, которые упрощают реализацию RESTful API.

Настройка HTTP-методов в Spring

Общий пример контроллера

@RestController
@RequestMapping("/api/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return new User(id, "John Doe", "john@example.com");
    }

    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        user.setId(1L); // Пример генерации ID
        return ResponseEntity.status(HttpStatus.CREATED).body(user);
    }

    @PutMapping("/{id}")
    public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User user) {
        user.setId(id);
        return ResponseEntity.ok(user);
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
        return ResponseEntity.noContent().build();
    }
}

HTTP-методы

1. GET — Чтение данных

Назначение: Возвращает данные с сервера (например, список пользователей, детали одного пользователя).
Идемпотентный метод: Повторный вызов GET не изменяет состояние ресурса.

Пример запроса:

GET /api/users/1 HTTP/1.1
Host: example.com

Реализация в Spring:

@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
    return new User(id, "John Doe", "john@example.com");
}

Особенности:
Используется аннотация @GetMapping.
Данные возвращаются в формате JSON или XML в зависимости от заголовка Accept.

2. POST — Создание нового ресурса
Назначение: Создает новый ресурс на сервере.
Не идемпотентный метод: Повторный вызов создаёт новые записи.

Пример запроса:

POST /api/users HTTP/1.1
Content-Type: application/json
Host: example.com

{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Реализация в Spring:

@PostMapping
public ResponseEntity<User> createUser(@RequestBody User user) {
    user.setId(1L); // Симуляция сохранения с генерацией ID
    return ResponseEntity.status(HttpStatus.CREATED).body(user);
}

Особенности:
Используется аннотация @PostMapping.
Данные передаются через тело запроса (@RequestBody).
В ответе часто возвращается код 201 Created и URL нового ресурса.

3. PUT — Обновление ресурса
Назначение: Обновляет существующий ресурс или создаёт его, если он не существует.
Идемпотентный метод: Повторный вызов приводит к тому же результату.

Пример запроса:

PUT /api/users/1 HTTP/1.1
Content-Type: application/json
Host: example.com

{
  "name": "John Smith",
  "email": "john.smith@example.com"
}

Реализация в Spring:

@PutMapping("/{id}")
public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User user) {
    user.setId(id); // Симуляция обновления ресурса
    return ResponseEntity.ok(user);
}

Особенности:
Используется аннотация @PutMapping.
Данные для обновления передаются через тело запроса.
В ответе обычно возвращается 200 OK с обновлённым ресурсом.

4. DELETE — Удаление ресурса
Назначение: Удаляет ресурс на сервере.
Идемпотентный метод: Повторный вызов приводит к тому же результату (ресурс уже удалён).

Пример запроса:

DELETE /api/users/1 HTTP/1.1
Host: example.com

Реализация в Spring:

@DeleteMapping("/{id}")
public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
    return ResponseEntity.noContent().build();
}

Особенности:
Используется аннотация @DeleteMapping.
В ответе часто возвращается 204 No Content.

#Java #Training #Spring #GET #PUT #POST #DELETE

118 views05:29