Kelių užklausų parametrų patvirtinimas „Spring Boot“: vadovas

Užklausos kelio kintamųjų patvirtinimas „Spring Boot“ naudojant pasirinktines anotacijas

Šis sprendimas sutelktas į pasirinktinio anotacijos ir tikrintuvo „Java“ sukūrimą, kad būtų galima patvirtinti du užklausų parametrus („StartDate“ ir „Enddate“) pavasario įkrovos 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 {};
}

Datos palyginimo įgyvendinimo data

Šis scenarijus parodo pasirinktinio apribojimo tikrintojo įgyvendinimą, kad būtų galima patvirtinti du užklausos parametrus kartu.

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

Alternatyvus sprendimas: naudojantis paslaugų lygio patvirtinimu

Šis sprendimas parodo datos logiką paslaugų sluoksnyje, o tai išvengia tinkamų anotacijų poreikio.

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

Pasirinktinio patvirtinimo tikrinimas naudojant vienetų testus

Šis scenarijus iliustruoja vienetų testus, naudojant „JUNIT“, kad patvirtintų, jog abu sprendimai veikia taip, kaip tikėtasi skirtinguose scenarijuose.

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

Dažnai užduodami klausimai apie užklausos parametrų patvirtinimą pavasario įkrovoje

1. Kas yra pasirinktinė anotacija „Spring Boot“?
2. Pasirinktinė anotacija yra vartotojo apibrėžta anotacija, pavyzdžiui, @StartDateBeforeEndDate, jame aprašoma konkreti logika arba metaduomenys, dažnai suporuoti su pasirinktiniu validru.
3. Kaip galiu tvarkyti patvirtinimo klaidas pavasario įkrovos API?
4. Galite naudoti @ExceptionHandler Savo valdiklyje sugauti ir apdoroti patvirtinimo išimtis, grąžindami reikšmingus klaidų pranešimus klientui.
5. Kas yra į aspektą orientuotas programavimas pavasarį?
6. AOP leidžia jums moduliuoti kryžminimo problemas, tokias kaip registravimas ar patvirtinimas, naudojant tokius anotacijas @Before arba @Around atlikti kodą prieš arba po metodo skambučio.
7. Kaip aš galiu patvirtinti sudėtingus parametrus nesukuriant DTO?
8. Galite naudoti pasirinktinių patvirtintojų derinį, @Validatedir metodo lygio patvirtinimas, kad būtų galima tiesiogiai patvirtinti užklausos parametrus be papildomų objektų.
9. Kokį vaidmenį atlieka HandlerMethodArgumentResolver Žaisk pavasarį?
10. Tai pritaiko, kaip metodo argumentai išsprendžiami prieš perduodant juos į valdiklio metodą, leidžiantį išplėsti užklausų parametrų patvirtinimą ar praturtėjimą.

Užtikrinant patikimą užklausos patvirtinimą pavasario įkrovoje

Patvirtinti užklausų parametrus pavasario įkrovoje reikalaujama atkreipti dėmesį ir į efektyvumą, ir į paprastumą. Naudodami pasirinktines anotacijas galite centralizuoti logiką, todėl ją reikia daugkartinio naudojimo ir lengviau prižiūrėti. Derinant šiuos metodus su vienetų testais, užtikrinsite, kad jūsų API yra tvirta ir patikima bet kokiam įvesties scenarijui.

Nesvarbu, ar pasirenkate pasirinktinius tikrintuvus, ar paslaugų sluoksnio patvirtinimą, svarbiausia yra subalansuoti našumą ir skaitomumą. Šis vadovas pateikia praktinius pavyzdžius, padedančius kūrėjams pasiekti tikslų užklausos patvirtinimą, tuo pačiu pagerinant API vartotojo patirtį. Nepamirškite kruopščiai išbandyti savo sprendimus, kad užfiksuotumėte kraštus. 🌟