แอปพลิเคชัน Spring Boot ใช้ @valid เพื่อตรวจสอบคำขอ API

การใช้ @valid จะทำให้การตรวจสอบคำขอของคุณง่ายขึ้น

เมื่อเราพัฒนา API ส่วนที่เหลือ เราเชื่อว่าทุกคนจำเป็นต้องตรวจสอบความถูกต้องของพารามิเตอร์อินพุตของอินเทอร์เฟซ ผู้เริ่มต้นบางคนอาจใช้นิพจน์เงื่อนไข if-else จำนวนมากสำหรับการตรวจสอบ ใช้การลงทะเบียนผู้ใช้ใหม่เป็นตัวอย่าง:

รหัสดังกล่าวสามารถบรรลุวัตถุประสงค์ของการตรวจสอบพารามิเตอร์ได้ แต่ผู้อ่านที่ระมัดระวังอาจพบว่าหากเราต้องการเขียนอินเทอร์เฟซจำนวนมากเช่นนี้ เราจำเป็นต้องเขียนรหัสตรวจสอบซ้ำหลายครั้ง ซึ่งเห็นได้ชัดว่าไม่สวยงาม เราสามารถใช้คำอธิบายประกอบ @valid เพื่อช่วยให้ตรรกะการตรวจสอบง่ายขึ้น

ใช้ @Valid

การhibernate-validatorใช้งาน @Valid spring-boot-start-webมีไลบรารีนี้อยู่แล้ว ดังนั้นจึงไม่จำเป็นต้องแนะนำการพึ่งพา หากเป็นโปรเจ็กต์ที่ไม่ใช่สปริง ต้องใช้การพึ่งพา Maven สองรายการ

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>
 
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.14.Final</version>
</dependency>

• คุณสมบัติการจำกัด @Null ต้องเป็นค่าว่างเท่านั้น
• @NotNull จำกัด คุณสมบัติไม่เป็นโมฆะ
• @Max(value) จำกัด คุณสมบัติต้องเป็นตัวเลขไม่เกินค่าที่ระบุ
• @Min(value) จำกัด คุณสมบัติต้องเป็นตัวเลขไม่น้อยกว่าค่าที่ระบุ
• @Digits (จำนวนเต็ม, เศษส่วน) คุณสมบัติการจำกัดต้องเป็นทศนิยม และจำนวนหลักในส่วนจำนวนเต็มต้องไม่เกินintegerและจำนวนหลักในส่วนทศนิยมต้องไม่เกินเศษส่วน
• คุณสมบัติการจำกัด @Past ต้องเป็นวันที่ที่ผ่านมา
• @Future จำกัด คุณสมบัติต้องเป็นวันที่ในอนาคต
• @Pattern(value) จำกัด คุณสมบัติต้องสอดคล้องกับนิพจน์ทั่วไปที่ระบุ
• @Size(max, min) จำกัดความยาวของอักขระต้องอยู่ระหว่าง min และ Max
• @NotEmpty ค่าคุณสมบัติที่ถูกต้องไม่สามารถเป็นค่าว่างได้ ความยาวของสตริงไม่ใช่ 0 และขนาดคอลเล็กชันไม่ใช่ 0
• @NotBlank ค่าคุณสมบัติที่ถูกต้องไม่เป็นค่าว่าง และหลังจาก trim() ความยาวไม่ใช่ 0
• @อีเมล ตรวจสอบว่าค่าแอตทริบิวต์เป็นสตริงในรูปแบบอีเมล

เห็นไหมมันง่ายขนาดนั้น คำอธิบายประกอบบางส่วนทำให้ตรรกะการตรวจสอบที่ซับซ้อนสมบูรณ์ เมื่อการตรวจสอบพารามิเตอร์เป้าหมายล้มเหลว ระบบจะส่งMethodArgumentNotValidExceptionข้อยกเว้น จากนั้นเราสามารถใช้@ExceptionHandlerจัดการผลการตรวจสอบได้

ใช้ @Exceptionhandler เพื่อจัดการผลการตรวจสอบอย่างสม่ำเสมอ

คลาสตัวจัดการข้อยกเว้นส่วนกลางถูกสร้างขึ้นที่นี่ เราใช้ เมธอด parameterExceptionHandlerเพื่อตรวจจับMethodArgumentNotValidExceptionข้อยกเว้น และสุดท้าย จัดการผลลัพธ์ของความล้มเหลวในการตรวจสอบอย่างสม่ำเสมอ เมธอดนี้จะได้รับข้อความแสดงข้อผิดพลาดหลังจากการตรวจสอบความถูกต้องของแต่ละฟิลด์ล้มเหลว ที่นี่ ฉันใช้ErrorResultคลาสเพื่อส่งคืนข้อความแสดงข้อผิดพลาด เมื่อเราเริ่มบริการ เราใช้บุรุษไปรษณีย์เพื่อเริ่มต้นคำขอโพสต์（http://localhost:8080/user/register) เราไม่ป้อนพารามิเตอร์ใด ๆ และส่งคืนผลลัพธ์:

{  
    "code": -1,  
    "msg": "the user phone is illegal."  
}

เคล็ดลับสี่ประการในการขจัดนิพจน์เงื่อนไขที่ซับซ้อน เคล็ดลับการเพิ่มประสิทธิภาพสิบวิธีเพื่อให้แอปพลิเคชัน Java ของคุณทำงานเร็วขึ้น