Java Academy · leksjon

Egendefinerte constraint-annotasjoner

Opprett en egendefinert @UniqueEmail-annotasjon med en ConstraintValidator-implementasjon.

Leksjon 2 av 413 trinn

Egendefinerte constraint-annotasjoner er en gratis leksjon i Java Academy på CoddyKit. Dette er leksjon 2 av 4. Du kan lese hele leksjonen gratis nedenfor – og deretter øve praktisk i nettleseren med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i Java Academy, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i Java Academy inneholder totalt 4 leksjoner.

Når standardbegrensningene ikke er nok

Standardannotasjonene i Bean Validation dekker vanlige tilfeller. For domenespesifikke regler (for eksempel unik e-post, gyldig IBAN eller passordstyrke) kan De opprette egendefinerte constraint-annotasjoner.

Definere constraint-annotasjonen

Opprett en annotasjon med @Constraint(validatedBy = ...), de obligatoriske elementene message, groups og payload, samt riktig retention og target.

import jakarta.validation.Constraint;
import jakarta.validation.Payload;
@Documented
@Constraint(validatedBy = UniqueEmailValidator.class)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
public @interface UniqueEmail {
    String message() default "Email already registered";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

Implementere ConstraintValidator

Implementer ConstraintValidator<UniqueEmail, String>. Metoden initialize leser annotasjonselementene, mens isValid utfører selve kontrollen.

@Component
public class UniqueEmailValidator implements ConstraintValidator<UniqueEmail, String> {
    @Autowired private UserRepository repo;
    @Override
    public boolean isValid(String email, ConstraintValidatorContext ctx) {
        if (email == null) return true; // let @NotBlank handle null
        return !repo.existsByEmail(email);
    }
}

Bruke den egendefinerte constraint-en

Bruk annotasjonen som enhver standard constraint på et felt, en parameter eller en returverdi.

public record CreateUserRequest(
    @NotBlank
    String name,
    @NotBlank @Email @UniqueEmail
    String email
) {}

Egendefinert melding med interpolering

Referer til annotasjonselementer i meldingen ved hjelp av {elementName}. Bruk ctx.buildConstraintViolationWithTemplate() for å legge til egendefinerte meldinger med dynamiske data.

@Constraint(validatedBy = RangeValidator.class)
public @interface InRange {
    int min() default 0;
    int max() default 100;
    String message() default "Must be between {min} and {max}";
    // ...
}

Constraint på klassenivå

Bruk en constraint på klassenivå for å validere flere felt samlet — nyttig for regler på tvers av felt, for eksempel bekreftelse av passord.

@Documented
@Constraint(validatedBy = PasswordMatchValidator.class)
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface PasswordMatch {
    String message() default "Passwords do not match";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

Implementere validator på klassenivå

Validatoren mottar hele objektet. Få tilgang til flere felt for å utføre validering på tvers av felt.

public class PasswordMatchValidator implements ConstraintValidator<PasswordMatch, ChangePasswordRequest> {
    public boolean isValid(ChangePasswordRequest req, ConstraintValidatorContext ctx) {
        if (req.getNewPassword() == null) return true;
        boolean match = req.getNewPassword().equals(req.getConfirmPassword());
        if (!match) {
            ctx.disableDefaultConstraintViolation();
            ctx.buildConstraintViolationWithTemplate("Passwords do not match")
               .addPropertyNode("confirmPassword").addConstraintViolation();
        }
        return match;
    }
}

Kombinere constraints

Opprett en meta-constraint ved å annotere den egendefinerte annotasjonen med eksisterende constraints. Begge brukes automatisk.

@NotBlank
@Email
@Size(max = 255)
@Constraint(validatedBy = {})
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ValidEmail {
    String message() default "Invalid email";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

Returnere flere brudd

Bruk ctx.disableDefaultConstraintViolation() og legg til individuelle bruddmeldinger for hvert problem som oppdages i én kjøring av validatoren.

public boolean isValid(String password, ConstraintValidatorContext ctx) {
    List<String> issues = new ArrayList<>();
    if (password.length() < 8) issues.add("Too short");
    if (!password.matches(".*\\d.*")) issues.add("Must contain a digit");
    if (issues.isEmpty()) return true;
    ctx.disableDefaultConstraintViolation();
    issues.forEach(msg -> ctx.buildConstraintViolationWithTemplate(msg).addConstraintViolation());
    return false;
}

Spring-administrerte validatorer

Siden UniqueEmailValidator er annotert med @Component, injiserer Spring repository-er i den. Dette fungerer bare hvis validatoren startes via Spring sin validator, som Spring Boot kobler inn automatisk.

Teste egendefinerte validatorer

Enhetstest validatorer direkte — det kreves ingen Spring-kontekst for ren valideringslogikk. Bruk Validation.buildDefaultValidatorFactory() for integrasjonstester.

Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
CreateUserRequest req = new CreateUserRequest("", "bad-email", null);
Set<ConstraintViolation<CreateUserRequest>> violations = validator.validate(req);
System.out.println(violations.size()); // 3

Hurtigsjekk

Hvilket grensesnitt implementerer en egendefinert constraint-validator?

Oppsummering

Opprett @interface med @Constraint(validatedBy=...). Implementer ConstraintValidator. Bruk @Component for Spring-injeksjon. Constraints på klassenivå validerer flere felt samlet. Kombiner eksisterende constraints for å unngå duplisering.

Gratis å komme i gang

Lær deg Java med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs
104
Leksjoner
374

Ofte stilte spørsmål

Er leksjonen «Egendefinerte constraint-annotasjoner» gratis?

Ja – hele teksten i «Egendefinerte constraint-annotasjoner» er gratis å lese her på nettet. For å øve interaktivt med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt, og for å låse opp resten av Java Academy-kurset, kan du oppgradere til CoddyKit PRO. Kurset i Java Academy inneholder totalt 4 leksjoner.

Hva lærer jeg i «Egendefinerte constraint-annotasjoner»?

Opprett en egendefinert @UniqueEmail-annotasjon med en ConstraintValidator-implementasjon. Du øver på Java Academy med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med Java Academy?

Ingen tidligere erfaring er nødvendig. Java Academy på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 2 av 4.

Hvor lang tid tar leksjonen «Egendefinerte constraint-annotasjoner»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne Java Academy-leksjonen?

Ja. Alle Java Academy-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

  1. Bean-validering: @NotNull, @Size, @Pattern
  2. Egendefinerte constraint-annotasjoner
  3. Global unntakshåndtering med @ControllerAdvice
  4. RFC 7807 Problem Details og konsistente feilsvar
← Tilbake til Java Academy