[JAVA] Erstellen Sie Ihren eigenen Validator mit Bean Validation

Überblick

Ein Memo der Prozedur vom Schreiben eines selbst erstellten Validators mit Bean Validation bis zum Schreiben eines Komponententests.

Versuchen

Ich werde versuchen, einen Validator zu erstellen, um zu beurteilen, ob es sich um einen Songnamen von Michael Jackson handelt.

Implementierung einer variablen Datenklasse

package com.example.customvalidate;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.ArrayList;
import java.util.List;

public class MJValidator implements ConstraintValidator<MJ, String> {

    private final static List<String> songs = new ArrayList<String>() {
        {
            add("Remember The Time"); add("Stranger In Moscow"); add("You Are Not Alone");
        }
    };

    public void initialize(MJ constraintAnnotation) {
    }

    public boolean isValid(String value, ConstraintValidatorContext context) {
        return songs.stream().anyMatch(song -> song.equals(value));
    }
}

Kommentar

• Erben Sie die ConstraintValidator-Schnittstelle. Geben Sie für die Generika die später zu erstellende Anmerkung und den zu validierenden Typ an.
• Die tatsächliche Validierung wird nach der Methode "isValid" beurteilt. Macht ein willkürliches Urteil und gibt einen Booleschen Wert zurück.
• In diesem Beispiel bestehen "Remember The Time", "Stranger In Moscow" oder "You Are Not Alone" die Validierung.

Implementierung von Anmerkungen

Machen Sie eine Anmerkung. Jetzt können Sie es wie "@ MJ" verwenden

package com.example.customvalidate;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

@Documented
@Constraint(validatedBy = {MJValidator.class})
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MJ {

    String message() default "you must specify one of Michael Jackson's songs.";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    @Target({ElementType.FIELD})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @interface List {
        MJ[] value();
    }
}

Kommentar

• Geben Sie die Klasse an, die anstelle von "@Constraint (validatedBy =)" tatsächlich validiert werden soll. Geben Sie den oben erstellten "MJ Validator" an.
• Geben Sie für "@ Target" das Ziel an, zu dem diese Anmerkung hinzugefügt werden kann. Diesmal war es ein Argument und ein Feld.
• Geben Sie für "Nachricht" die Nachricht an, die im Ausnahmeobjekt festgelegt wird, wenn die Validierung abgefangen wird.

Schreiben Sie einen Test

package com.example.customvalidate;

import org.junit.Before;
import org.junit.Test;
import javax.validation.*;
import java.util.Set;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;

public class MJValidatorTest {

    private Validator validator;

    @Before
    public void setUp() {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }

    @Test
public void Ein Fehler tritt auf, wenn Sie einen falschen Songtitel übergeben.() {
        TestBean bean = new TestBean("Remember a Time");
        Set<ConstraintViolation<Object>> violations = validator.validate(bean);
        assertThat(violations.isEmpty(), is(false));
        String expectedMessage = "you must specify one of Michael Jackson's songs.";
        violations.forEach(v -> assertThat(v.getMessage().equals(expectedMessage), is(true)));
    }

    @Test
public void Verursacht keinen Fehler beim Übergeben des richtigen Songtitels() {
        TestBean bean = new TestBean("Remember The Time");
        Set<ConstraintViolation<Object>> violations = validator.validate(bean);
        assertThat(violations.isEmpty(), is(true));
    }

    private static class TestBean {
        @MJ
        private String song;

        TestBean(String song) {
            this.song = song;
        }
    }
}

Ausführen und in Ordnung, wenn der Test erfolgreich ist.

Kommentar

• Eine geeignete Klasse wird als innere Klasse der Testklasse erstellt, und die diesmal erstellte Anmerkung wird im Feld festgelegt.
• Ausführen der Validierung für eine Instanz dieser Klasse