Validering av flere spørringsparametere i Spring Boot: En guide

Validering av spørringsbanevariabler i Spring Boot ved hjelp av tilpassede merknader

Denne løsningen fokuserer på å lage en tilpasset merknad og validator i Java for å validere to spørringsparametere (startdato og enddate) i et 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 av validatoren for dato -sammenligning

Dette skriptet demonstrerer implementeringen av den tilpassede begrensningsvalidatoren for å validere to spørringsparametere 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: Bruke en validering på servicenivå

Denne løsningen viser validering av datalogikken i servicelaget, som unngår behovet for tilpassede merknader 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);
    }
}

Testing av tilpasset validering med enhetstester

Dette skriptet illustrerer skriveenhetstester ved å bruke Junit for å validere at begge løsningene fungerer som forventet i forskjellige 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 stilte spørsmål om validering av spørringsparameter i Spring Boot

1. Hva er en tilpasset merknad i Spring Boot?
2. En tilpasset merknad er en brukerdefinert merknad, for eksempel @StartDateBeforeEndDate, som omsetter spesifikk logikk eller metadata, ofte sammenkoblet med en tilpasset validator.
3. Hvordan kan jeg håndtere valideringsfeil i et Spring Boot API?
4. Du kan bruke @ExceptionHandler I kontrolleren din for å fange og behandle validerings unntak, returnerer meningsfulle feilmeldinger til klienten.
5. Hva er aspektorientert programmering om våren?
6. AOP lar deg modulisere tverrgående bekymringer, som logging eller validering, ved å bruke merknader som @Before eller @Around For å utføre kode før eller etter metodesamtaler.
7. Hvordan kan jeg validere komplekse parametere uten å lage en DTO?
8. Du kan bruke en kombinasjon av tilpassede validatorer, @Validated, og validering på metodnivå for å direkte validere spørringsparametere uten flere objekter.
9. Hvilken rolle gjør HandlerMethodArgumentResolver Spill om våren?
10. Den tilpasser hvordan metodeargumenter løses før du fører dem til en kontrollermetode, noe som gir foransert validering eller berikelse av spørringsparametere.

Sikre pålitelig spørringsvalidering i Spring Boot

Validering av spørringsparametere i Spring Boot krever oppmerksomhet til både effektivitet og enkelhet. Ved å bruke tilpassede merknader lar deg sentralisere logikk, noe som gjør det gjenbrukbart og lettere å vedlikeholde. Å kombinere disse teknikkene med enhetstester sikrer at API -en din er robust og pålitelig for ethvert inngangsscenario.

Enten du velger tilpassede validatorer eller validering av servicelag, er nøkkelen å balansere ytelse og lesbarhet. Denne guiden gir praktiske eksempler for å hjelpe utviklere med å oppnå nøyaktig validering av spørringen mens de forbedrer API -brukeropplevelsen. Ikke glem å teste løsningene dine grundig for å fange kantsaker. 🌟