Validera flera frågeparametrar i Spring Boot: En guide

Validera frågeställningsvariabler i våren med anpassade kommentarer

Denna lösning fokuserar på att skapa en anpassad kommentar och validator i Java för att validera två frågeparametrar (startdatum och slutdatum) i ett vårstöds -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 {};
}

Implementera validatorn för datumjämförelse

Detta skript visar implementeringen av den anpassade begränsningsvalidatorn för att validera två frågeparametrar tillsammans.

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: Använd en validering på servicenivå

Denna lösning visar validering av datalogiken i serviceskiktet, vilket undviker behovet av anpassade 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);
    }
}

Testa den anpassade valideringen med enhetstester

Detta skript illustrerar skrivenhetstester med JUnit för att validera att båda lösningarna fungerar som förväntat i olika 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));
    }
}

Vanliga frågor om validering av frågeparameter i vårstart

1. Vad är en anpassad kommentar i Spring Boot?
2. En anpassad kommentar är en användardefinierad kommentar, till exempel @StartDateBeforeEndDate, som kapslar in specifika logik eller metadata, ofta i par med en anpassad validator.
3. Hur kan jag hantera valideringsfel i ett vårstart -API?
4. Du kan använda @ExceptionHandler I din controller för att fånga och bearbeta valideringsundantag och returnera meningsfulla felmeddelanden till klienten.
5. Vad är aspektorienterad programmering under våren?
6. AOP tillåter dig att modulera tvärbeslutande problem, som loggning eller validering, med kommentarer som @Before eller @Around för att köra kod före eller efter metodsamtal.
7. Hur kan jag validera komplexa parametrar utan att skapa en DTO?
8. Du kan använda en kombination av anpassade validerare, @Validatedoch validering av metodnivå för att direkt validera frågeparametrar utan ytterligare objekt.
9. Vilken roll gör HandlerMethodArgumentResolver Spela på våren?
10. Den anpassar hur metodargument löses innan de skickar dem till en kontrollmetod, vilket möjliggör avancerad validering eller anrikning av frågeparametrar.

Säkerställa tillförlitlig fråga validering i vårstart

Validering av frågeparametrar i vårstart kräver uppmärksamhet på både effektivitet och enkelhet. Genom att använda anpassade kommentarer kan du centralisera logik, vilket gör det återanvändbart och lättare att underhålla. Att kombinera dessa tekniker med enhetstester säkerställer att ditt API är robust och tillförlitligt för alla ingångsscenarier.

Oavsett om du väljer anpassade validatorer eller validering av serviceskikt, är nyckeln att balansera prestanda och läsbarhet. Den här guiden ger praktiska exempel för att hjälpa utvecklare att uppnå korrekt fråga validering samtidigt som API -användarupplevelsen förbättras. Glöm inte att testa dina lösningar noggrant för att fånga kantfall. 🌟