Проверка нескольких параметров запроса в Spring Boot: Руководство

Проверка переменных пути запроса в Spring Boot с использованием пользовательских аннотаций

Это решение фокусируется на создании пользовательской аннотации и валидатора в Java для проверки двух параметров запроса (StartDate и EndDate) в API Spring Boot Rest.

package sk.softec.akademia.demo.validation;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ ElementType.PARAMETER })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = StartDateBeforeEndDateValidator.class)
public @interface StartDateBeforeEndDate {
    String message() default "Start date cannot be later than end date";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

Реализация валидатора для сравнения дат

Этот скрипт демонстрирует реализацию пользовательского валидатора ограничения для проверки двух параметров запроса вместе.

package sk.softec.akademia.demo.validation;
import jakarta.validation.ConstraintValidator;
import jakarta.validation.ConstraintValidatorContext;
import java.time.LocalDate;
public class StartDateBeforeEndDateValidator implements ConstraintValidator<StartDateBeforeEndDate, Object[]> {
    @Override
    public boolean isValid(Object[] values, ConstraintValidatorContext context) {
        if (values == null || values.length < 2 || !(values[0] instanceof LocalDate) || !(values[1] instanceof LocalDate)) {
            return true; // Default behavior when values are not properly passed
        }
        LocalDate startDate = (LocalDate) values[0];
        LocalDate endDate = (LocalDate) values[1];
        return startDate == null || endDate == null || !startDate.isAfter(endDate);
    }
}

Альтернативное решение: использование проверки на уровне обслуживания

Это решение демонстрирует проверку логики даты на уровне сервиса, которая полностью избегает необходимости пользовательских аннотаций.

@Service
public class StandingOrderService {
    public List<StandingOrderResponseDTO> findByValidFromBetween(LocalDate startDate, LocalDate endDate) {
        if (startDate.isAfter(endDate)) {
            throw new IllegalArgumentException("Start date cannot be after end date.");
        }
        // Logic to fetch and return the data from the database
        return standingOrderRepository.findByDateRange(startDate, endDate);
    }
}

Тестирование пользовательской проверки с помощью модульных тестов

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

package sk.softec.akademia.demo.validation;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;
public class StartDateBeforeEndDateValidatorTest {
    private final StartDateBeforeEndDateValidator validator = new StartDateBeforeEndDateValidator();
    @Test
    void testValidDates() {
        Object[] validDates = {LocalDate.of(2023, 1, 1), LocalDate.of(2023, 12, 31)};
        assertTrue(validator.isValid(validDates, null));
    }
    @Test
    void testInvalidDates() {
        Object[] invalidDates = {LocalDate.of(2023, 12, 31), LocalDate.of(2023, 1, 1)};
        assertFalse(validator.isValid(invalidDates, null));
    }
}

Часто задаваемые вопросы об проверке параметров запроса в Spring Boot

1. Что такое пользовательская аннотация в Spring Boot?
2. Пользовательская аннотация-это определенная пользовательская аннотация, например, как @StartDateBeforeEndDate, это инкапсулирует конкретную логику или метаданные, часто в сочетании с пользовательским валидатором.
3. Как я могу обработать ошибки проверки в API Spring Boot?
4. Вы можете использовать @ExceptionHandler В вашем контроллере, чтобы поймать и обработать исключения проверки, возвращает значимые сообщения об ошибках клиенту.
5. Что представляет собой программирование, ориентированное на аспект весной?
6. AOP позволяет модулизировать перекрестные проблемы, такие как ведение журнала или проверка, используя такие аннотации, как @Before или @Around выполнить код до или после вызовов метода.
7. Как я могу проверить сложные параметры без создания DTO?
8. Вы можете использовать комбинацию пользовательских валидаторов, @Validatedи проверка на уровне метода для непосредственной проверки параметров запроса без дополнительных объектов.
9. Какую роль играет HandlerMethodArgumentResolver Играть весной?
10. Он настраивает, как решаются аргументы метода, прежде чем передавать их в метод контроллера, что позволяет обеспечить расширенную проверку или обогащение параметров запроса.

Обеспечение надежной проверки запроса в Spring Boot

Подтверждение параметров запроса в Spring Boot требует внимания как к эффективности, так и к простоте. Использование пользовательских аннотаций позволяет централизовать логику, делая ее многократному использованию и проще в обслуживании. Объединение этих методов с модульными тестами гарантирует, что ваш API является надежным и надежным для любого сценария ввода.

Независимо от того, выбираете ли вы пользовательские валидаторы или проверку услуг, ключом является сбалансировать производительность и читаемость. В этом руководстве приведены практические примеры, чтобы помочь разработчикам достичь точной проверки запросов, улучшая пользовательский опыт API. Не забудьте тщательно проверить свои решения, чтобы поймать края. 🌟