Spring Boot'da birden çok sorgu parametresini doğrulama: Bir kılavuz

Özel ek açıklamalar kullanarak yay önyüklemesindeki sorgu yolu değişkenlerini doğrulama

Bu çözüm, bir Spring Boot Rest API'sinde iki sorgu parametresini (StartDate ve EndDate) doğrulamak için Java'da özel bir ek açıklama ve doğrulayıcı oluşturmaya odaklanır.

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

Doğruatörün tarih karşılaştırması için uygulanması

Bu komut dosyası, iki sorgu parametresini birlikte doğrulamak için özel kısıtlama validatörünün uygulanmasını gösterir.

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

Alternatif Çözüm: Hizmet düzeyinde bir doğrulama kullanma

Bu çözüm, hizmet katmanı içindeki tarih mantığının doğrulanmasını gösterir, bu da özel ek açıklamalara ihtiyaç duyulmasını önler.

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

Birim testlerle özel doğrulamayı test etmek

Bu komut dosyası, her iki çözümün farklı senaryolarda beklendiği gibi çalıştığını doğrulamak için JUnit kullanan birim testlerini gösterir.

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'ta Sorgu Parametre Doğrulaması hakkında sık sorulan sorular

1. Spring Boot'ta özel ek açıklama nedir?
2. Özel ek açıklama, kullanıcı tanımlı bir ek açıklamadır, örneğin @StartDateBeforeEndDate, genellikle özel bir doğrulayıcı ile eşleştirilmiş belirli mantık veya meta verileri kapsar.
3. Bir Spring Boot API'sındaki doğrulama hatalarını nasıl işleyebilirim?
4. Kullanabilirsiniz @ExceptionHandler Denetleyicinizde doğrulama istisnalarını yakalamak ve işlemek için, istemciye anlamlı hata mesajları döndürür.
5. İlkbaharda özellik odaklı programlama nedir?
6. AOP, günlüğe kaydetme veya doğrulama gibi çapraz kesme endişelerini modülerleştirmenizi sağlar. @Before veya @Around Yöntem çağrılarından önce veya sonra kod yürütmek için.
7. DTO oluşturmadan karmaşık parametreleri nasıl doğrulayabilirim?
8. Özel doğrulayıcıların bir kombinasyonunu kullanabilirsiniz, @Validatedve ek nesneler olmadan sorgu parametrelerini doğrudan doğrulamak için yöntem düzeyinde doğrulama.
9. Ne rol HandlerMethodArgumentResolver İlkbaharda mı oynayın?
10. Bir denetleyici yöntemine geçmeden önce yöntem argümanlarının nasıl çözüldüğünü, sorgu parametrelerinin gelişmiş doğrulanmasına veya zenginleştirilmesine izin verir.

Spring Boot'ta güvenilir sorgu doğrulamasının sağlanması

Yay önyüklemesindeki sorgu parametrelerinin doğrulanması hem verimliliğe hem de basitliğe dikkat gerektirir. Özel ek açıklamalar kullanmak, mantığı merkezileştirmenizi sağlar, bu da yeniden kullanılabilir ve bakımını kolaylaştırır. Bu teknikleri birim testlerle birleştirmek, API'nizin herhangi bir giriş senaryosu için sağlam ve güvenilir olmasını sağlar.

İster özel doğrulayıcılar ister hizmet katmanı doğrulamasını seçin, anahtar performansı ve okunabilirliği dengelemektir. Bu kılavuz, geliştiricilerin API kullanıcı deneyimini geliştirirken doğru sorgu doğrulaması elde etmelerine yardımcı olacak pratik örnekler sunar. Kenar vakalarını yakalamak için çözümlerinizi iyice test etmeyi unutmayın. 🌟