Validering af flere forespørgselsparametre i Spring Boot: En guide

Validering af forespørgselssti -variabler i Spring Boot ved hjælp af brugerdefinerede kommentarer

Denne løsning fokuserer på at oprette en brugerdefineret annotation og validator i Java for at validere to forespørgselsparametre (StartDate og Enddate) i en Spring Boot REST API.

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

Implementering af validator til dato -sammenligning

Dette script demonstrerer implementeringen af ​​den brugerdefinerede begrænsningsvalidator til validering af to forespørgselsparametre sammen.

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

Alternativ løsning: Brug af en validering på serviceniveau

Denne løsning viser validering af dato -logikken inden for servicelaget, som undgår behovet for brugerdefinerede kommentarer helt.

@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);
    }
}

Testning af den brugerdefinerede validering med enhedstest

Dette script illustrerer skrivningsenhedstest ved hjælp af JUNIT til at validere, at begge løsninger fungerer som forventet i forskellige scenarier.

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

Ofte stillede spørgsmål om forespørgselsparametervalidering i Spring Boot

1. Hvad er en brugerdefineret annotation i Spring Boot?
2. En brugerdefineret annotation er en brugerdefineret annotation, såsom @StartDateBeforeEndDate, der indkapsler specifik logik eller metadata, ofte parret med en brugerdefineret validator.
3. Hvordan kan jeg håndtere valideringsfejl i en Spring Boot API?
4. Du kan bruge @ExceptionHandler I din controller til at fange og behandle validering undtagelser, der returnerer meningsfulde fejlmeddelelser til klienten.
5. Hvad er aspektorienteret programmering i foråret?
6. AOP giver dig mulighed for at modulere tværgående bekymringer, som logning eller validering, ved hjælp af kommentarer som @Before eller @Around at udføre kode før eller efter metodekald.
7. Hvordan kan jeg validere komplekse parametre uden at oprette en DTO?
8. Du kan bruge en kombination af brugerdefinerede validatorer, @Validated, og validering på metodniveau til direkte validering af forespørgselsparametre uden yderligere objekter.
9. Hvilken rolle gør HandlerMethodArgumentResolver Spil om foråret?
10. Det tilpasser, hvordan metodargumenter løses, før de overføres til en controller -metode, hvilket muliggør avanceret validering eller berigelse af forespørgselsparametre.

At sikre pålidelig forespørgselsvalidering i Spring Boot

Validering af forespørgselsparametre i Spring Boot kræver opmærksomhed på både effektivitet og enkelhed. Brug af brugerdefinerede kommentarer giver dig mulighed for at centralisere logik, hvilket gør det genanvendeligt og lettere at vedligeholde. Ved at kombinere disse teknikker med enhedstest sikrer, at din API er robust og pålidelig til ethvert input -scenarie.

Uanset om du vælger brugerdefinerede validatorer eller servicelagsvalidering, er nøglen at afbalancere ydeevne og læsbarhed. Denne vejledning giver praktiske eksempler til at hjælpe udviklere med at opnå nøjagtig forespørgselsvalidering, mens de forbedrer API -brugeroplevelsen. Glem ikke at teste dine løsninger grundigt for at fange kantssager. 🌟