JavaRush /Курсы /Модуль 5. Spring /Лекция 177: Практика: реализация простого REST API для ми...

Лекция 177: Практика: реализация простого REST API для микросервиса

Модуль 5. Spring

18 уровень , 6 лекция

Открыта

Сегодня мы разберём практическую разработку микросервиса для управления сущностью Customer. Мы реализуем CRUD-операции, подключим базу данных через Spring Data JPA и протестируем всё это с помощью инструментов вроде Postman.

Шаг 1: подготовка окружения и создание нового проекта

Для начала создадим новый проект. Сделать это можно через Spring Initializr:

Укажите следующие параметры:
- Project: Maven
- Language: Java
- Spring Boot Version: 3.0.x+
- Dependencies:
  - Spring Web
  - Spring Data JPA
  - H2 Database (встроенная база данных для тестирования)
  - Spring Boot DevTools (для удобной разработки)
Скачайте проект и откройте его в вашей IDE (например, IntelliJ IDEA).

Шаг 2: Настройка базы данных

Создайте файл application.yml в папке src/main/resources (если его нет). Настройте подключение к базе данных H2 следующим образом:


spring:
  datasource:
    url: jdbc:h2:mem:customerdb
    driver-class-name: org.h2.Driver
    username: sa
    password: password
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true
    properties:
      hibernate:
        format_sql: true

Этот файл конфигурирует базу данных в памяти (H2) и говорит Hibernate автоматически обновлять схему таблиц. Опция show-sql позволяет видеть SQL-запросы в консоли, что очень полезно для отладки.

Шаг 3: Создание сущности `Customer`

Добавьте класс Customer в package com.example.customer:


package com.example.customer;

import jakarta.persistence.*;

@Entity
public class Customer {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY) // Автоматическая генерация ID
    private Long id;

    @Column(nullable = false) // Поле не может быть null
    private String name;

    @Column(nullable = false, unique = true)
    private String email;

    public Customer() {
        // Конструктор по умолчанию для JPA
    }

    public Customer(String name, String email) {
        this.name = name;
        this.email = email;
    }

    // Геттеры и сеттеры
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }
}

Мы описали сущность Customer с полями id, name и email. Аннотация @Entity говорит JPA, что этот класс маппится на таблицу в базе данных.

Шаг 4: Создание репозитория

Создайте интерфейс CustomerRepository:


package com.example.customer;

import org.springframework.data.jpa.repository.JpaRepository;

public interface CustomerRepository extends JpaRepository<Customer, Long> {
    // JpaRepository предоставляет базовые CRUD-операции
}

Этот интерфейс позволяет легко работать с базой, избегая написания SQL-запросов. Например, методы save(), findById(), findAll() и deleteById() доступны сразу после добавления репозитория.

Шаг 5: Создание сервиса

Добавьте класс CustomerService:


package com.example.customer;

import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
public class CustomerService {

    private final CustomerRepository customerRepository;

    public CustomerService(CustomerRepository customerRepository) {
        this.customerRepository = customerRepository;
    }

    public List<Customer> getAllCustomers() {
        return customerRepository.findAll();
    }

    public Customer getCustomerById(Long id) {
        return customerRepository.findById(id)
                .orElseThrow(() -> new IllegalArgumentException("Customer not found with id: " + id));
    }

    public Customer createCustomer(Customer customer) {
        return customerRepository.save(customer);
    }

    public Customer updateCustomer(Long id, Customer updatedCustomer) {
        Customer existingCustomer = getCustomerById(id);
        existingCustomer.setName(updatedCustomer.getName());
        existingCustomer.setEmail(updatedCustomer.getEmail());
        return customerRepository.save(existingCustomer);
    }

    public void deleteCustomer(Long id) {
        customerRepository.deleteById(id);
    }
}

Этот класс инкапсулирует бизнес-логику для работы с клиентами.

Шаг 6: Создание REST-контроллера

Добавьте класс CustomerController:


package com.example.customer;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/customers")
public class CustomerController {

    private final CustomerService customerService;

    public CustomerController(CustomerService customerService) {
        this.customerService = customerService;
    }

    @GetMapping
    public List<Customer> getAllCustomers() {
        return customerService.getAllCustomers();
    }

    @GetMapping("/{id}")
    public ResponseEntity<Customer> getCustomerById(@PathVariable Long id) {
        try {
            Customer customer = customerService.getCustomerById(id);
            return ResponseEntity.ok(customer);
        } catch (IllegalArgumentException e) {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
        }
    }

    @PostMapping
    @ResponseStatus(HttpStatus.CREATED)
    public Customer createCustomer(@RequestBody Customer customer) {
        return customerService.createCustomer(customer);
    }

    @PutMapping("/{id}")
    public ResponseEntity<Customer> updateCustomer(@PathVariable Long id, @RequestBody Customer updatedCustomer) {
        try {
            Customer customer = customerService.updateCustomer(id, updatedCustomer);
            return ResponseEntity.ok(customer);
        } catch (IllegalArgumentException e) {
            return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
        }
    }

    @DeleteMapping("/{id}")
    @ResponseStatus(HttpStatus.NO_CONTENT)
    public void deleteCustomer(@PathVariable Long id) {
        customerService.deleteCustomer(id);
    }
}

Контроллер обрабатывает HTTP-запросы и вызывает методы сервиса. Здесь мы используем аннотации @RestController, @GetMapping, @PostMapping, @PutMapping и @DeleteMapping для маршрутизации запросов.

Шаг 7: Тестирование REST API

Запустите приложение: нажмите Run в вашей IDE или запустив команду mvn spring-boot:run в терминале.

Тестирование эндпоинтов через Postman

Получить всех клиентов (GET):
- URL: http://localhost:8080/customers
- Response: [ ] (по умолчанию пустой список).
Создать нового клиента (POST):
- URL: http://localhost:8080/customers
- Body (JSON):
```
{
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```
- Response: Созданный объект.
Получить клиента по ID (GET):
- URL: http://localhost:8080/customers/1.
Обновить клиента (PUT):
- URL: http://localhost:8080/customers/1
- Body (JSON):
```
{
  "name": "Jane Doe",
  "email": "jane.doe@example.com"
}
```
Удалить клиента (DELETE):
- URL: http://localhost:8080/customers/1.

Шаг 8: Обработка ошибок и улучшения

Если вы пытаетесь удалять или обновлять несуществующего клиента, приложение должно возвращать 404. Это уже реализовано в нашем контроллере через ResponseEntity и кастомные исключения.

Поздравляю! Вы только что создали свой первый микросервис с REST API. Теперь вы готовы строить больше и масштабировать!

Предыдущая Предыдущая лекция

Следующая Следующая лекция

Комментарии

ЧТОБЫ ПОСМОТРЕТЬ ВСЕ КОММЕНТАРИИ ИЛИ ОСТАВИТЬ КОММЕНТАРИЙ,
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ