So implementieren Sie eine elegante Parameterüberprüfung in Java

1. Einführung

Um die Parameter der Methode zu überprüfen, ist die einfachste und gewalttätigste Art, sie zu schreiben:

    public static void utilA(String a,BigDecimal b){
        if (StringUtils.isEmpty(a)){
            System.out.println("a不可为空");
            return;
        }
        if (b == null){
            System.out.println("b不可为空");
            return;
        }
        if (b.compareTo(BigDecimal.ZERO) != 1){
            System.out.println("b的取值范围不正确");
            return;
        }
        System.out.println("do something");
    }

Dies ist funktionaler von eine funktionale Perspektive Auch kein Problem.

Unter dem Gesichtspunkt der langfristigen Wartbarkeit des Codes ist die Wiederverwendungsrate des Codes jedoch gering. Sobald es zu viele Verifizierungsregeln gibt, ist die Wartung schwierig und es sieht für Ingenieure umständlich aus Wer ein kleines Streben hat, dem fällt es schwer, einen so großen Klumpen zu akzeptieren.

Obwohl es einige Lösungen wie Preconditions (com.google) gibt, ist es schwierig, sie an alle Szenarien anzupassen, und die Verwendung ist nicht so komfortabel, wie sie sein sollte.

2. So überprüfen Sie Parameter elegant

Spring empfiehlt offiziell eine elegante Überprüfung auf Methodenebene mit klarer Semantik (Eingabeparameterüberprüfung, Rückgabewertüberprüfung)# 🎜🎜##🎜🎜 #2.1 Offizielle Anleitung

Spring-Beamter In der SpringBoot-Dokumentation lautet die Lösung für die Parameterüberprüfung (Validierung) wie folgt:

@Service
@Validated
public class MyBean {
 
    public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code,
            Author author) {
        ...
    }
 
}

#🎜🎜 #Spring Boot-offizielles Website-Dokument „37. Validierung "

Mit anderen Worten, verwenden Sie die JSR-303-Spezifikation und verwenden Sie Anmerkungen direkt zur Parameterüberprüfung.

(JSR-303 ist ein Unterstandard in JAVA EE 6, genannt Bean Validation, und die offizielle Referenzimplementierung ist Hibernate Validator)

2.2 Anweisungen zur Verwendung von Anmerkungen#🎜🎜 #

2.2.1. Einführung in Annotationen

Verwenden Sie Annotationen, um Einschränkungsregeln direkt vor den Parametern hinzuzufügen. Die Anmerkung lautet wie folgt:

@AssertTrue / @AssertFalse

Validierung anwendbare Felder: booleanAnmerkungsbeschreibung : Überprüfen Sie, ob der Wert wahr / falsch ist. short, int, long

Hinweis: Überprüfen Sie, ob der Wert kleiner oder gleich dem angegebenen Dezimalwert ist. Bitte beachten Sie, dass es bei Dezimalzahlen Probleme mit der Genauigkeit gibt.

#🎜🎜 #@Digits

# 🎜🎜#

Überprüfung anwendbare Felder: BigDecimal,BigInteger,String,byte,short,int,longAnmerkung: Überprüfen Sie, ob die digitale Zusammensetzung des Werts vorliegt ist zulässig

Eigenschaftsbeschreibung: Ganzzahl: Gibt die Anzahl der Ziffern im ganzzahligen Teil an. Bruch: Gibt die Anzahl der Ziffern im Bruchteil an.

@Future / @Past

Validierung anwendbare Felder: Datum, Kalender

Anmerkung: Validieren Sie, ob der Wert liegt nach/vor der aktuellen Zeit

Eigenschaftsbeschreibung: Öffentlich

@Max / @Min

Anwendbar validieren Felder: BigDecimal, BigInteger, String, Byte, Short, Int, Long

Anmerkung: Überprüfen Sie, ob der Wert kleiner oder gleich dem angegebenen Ganzzahlwert ist

Attributbeschreibung: Öffentlich #🎜🎜 #

Hinweis: Es wird empfohlen, die Typen Stirng und Integer zu verwenden. Die Verwendung des Typs int wird nicht empfohlen, da der vom Formular übermittelte Wert nicht in int

# konvertiert werden kann. 🎜🎜#@ NotNull / @Null

Validierung anwendbare Felder: Referenzdatentyp

Anmerkung: Überprüfen Sie, ob der Wert ungleich Null/null ist#🎜🎜 #

Eigenschaftsbeschreibung: Öffentlich

@NotBlank

Überprüft, ob die Einschränkungszeichenfolge Null ist und ob die Länge der gekürzten Zeichenfolge größer als 0 ist, nur für Zeichenfolgen , und die führenden und nachfolgenden Leerzeichen werden entfernt @NotBlank und @NotEmpty: Leerzeichen („“) für NotEmpty ist zulässig, aber NotBlank löst eine Validierungsausnahme aus anwendbare Felder: String

#🎜 🎜#Anmerkung: Überprüfen Sie, ob der Wert mit einem regulären Ausdruck ausgestattet ist

Attributbeschreibung: regexp: Flags für reguläre Ausdrücke: Ein Array, das Pattern.Flag angibt und das darstellt verwandte Optionen des regulären Ausdrucks.

@Size

Validierung anwendbare Felder: String, Sammlung, Karte, Array

Anmerkung: Validierungswert Ob die Längenanforderung ist erfüllt

Attributbeschreibung: max: gibt die maximale Länge an, min: gibt die minimale Länge an.

@Length(min=, max=)

: Speziell für String-Typ verwendet

@Valid

# 🎜🎜#

Überprüfung anwendbarer Felder: Überprüfen Sie das zugehörige Objekt rekursiv.

Hinweis: Wenn das zugehörige Objekt eine Menge oder ein Array ist, überprüfen Sie die darin enthaltenen Elemente rekursiv. Wenn ja, eine Karte, Überprüfen Sie dann den Wertteil (ob eine rekursive Überprüfung durchgeführt werden soll). Das angegebene Element muss im entsprechenden Bereich liegen ist eine E-Mail-Adresse. Wenn sie null ist, wird keine Überprüfung durchgeführt und die Überprüfung ist bestanden.

@URL(protocol=,host=, port=,regexp=, flags=)

2.2.2 Verwendung

1. Abhängigkeiten einführen

 <!-- https://mvnrepository.com/artifact/org.hibernate.validator/hibernate-validator -->
        <dependency>
            <groupId>org.hibernate.validator</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.1.5.Final</version>
        </dependency>

2. Fügen Sie beim Aufruf der Methode Anmerkungen hinzu, wenn die tatsächlich übergebenen Parameter nicht mit denen übereinstimmen Einschränkungsregeln, ConstraintViolationException wird direkt ausgelöst, was darauf hinweist, dass die Parameterüberprüfung fehlgeschlagen ist.

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
 
/**
 * @Author: wangxia
 * @Date: 2021/10/20 16:30
 */
public class TestPerson {
 
    @NotEmpty(message = "用户名不能为空")
    private String username;
 
    @Min(value = 0,message = "年龄不能小于0岁")
    @Max(value =150,message = "年龄不能大于150岁")
    private int age;
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public int getAge() {
        return age;
    }
 
    public void setAge(int age) {
        this.age = age;
    }
}

3.. Fügen Sie für Bean-Typparameter Einschränkungsanmerkungen zu jedem Feld innerhalb der Bean hinzu und fügen Sie dann @Validated- oder @Valid-Anmerkungen vor den Methodenparametern hinzu. Beispiel:

@RequestMapping("/")
@RestController
public class TestValidatController {
 
    @PostMapping("/testValid")
    public String testValid(@Validated @RequestBody TestPerson testPerson){
        return "测试成功";
    }
 
}

4. Dieser Schritt kann weggelassen werden, aber er wird bei der Anforderung direkt zurückgegeben, was nicht sehr elegant ist.

@ControllerAdvice
@ResponseBody 
public class MethodArgumentNotValidHandel {
 
 
    @ExceptionHandler(value=MethodArgumentNotValidException.class)
    public JSONObject MethodArgumentNotValidHandler(HttpServletRequest request,
                                                    MethodArgumentNotValidException exception) throws Exception
    {
        JSONObject result=new JSONObject();
        result.put("code","fail");
        JSONObject errorMsg=new JSONObject();
        for (FieldError error : exception.getBindingResult().getFieldErrors()) {
            errorMsg.put(error.getField(),error.getDefaultMessage());
        }
        result.put("msg",errorMsg);
        return result;
    }
 
}

Elegant erfasste Ausnahmeaufforderung hinzufügen:

Es wird keine elegant erfasste Ausnahmeaufforderung hinzugefügt:

Das obige ist der detaillierte Inhalt vonSo implementieren Sie eine elegante Parameterüberprüfung in Java. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!