如何有效進行Java參數校驗？

在Java實現業務功能時，參數校驗是必不可少的一步。通過參數校驗，可以保證代碼的可靠性和安全性，避免出現各種不可預期的錯誤。本文將從多個方面為您詳細闡述如何有效進行Java參數校驗。

一、正確使用註解驗證

註解驗證是Java中常用的參數校驗方法，核心是javax.validation框架提供的一組標準驗證註解。在使用註解驗證時，需要在請求參數中添加相應的註解，例如@NotNull、@Size等，然後在Controller中添加@Valid註解即可。註解驗證的特點是代碼簡潔，易於維護。

以下是使用註解驗證的示例代碼：

public class User {
    
    @NotNull(message="用戶名不能為空")
    private String username;
    
    @Size(min=6,max=16,message="密碼長度必須在6-16位之間")
    private String password;
    
    //getters and setters
    
}

public class UserController {
    
    @PostMapping("/user")
    public ResponseEntity addUser(@Valid @RequestBody User user){
        //處理添加用戶的邏輯
        return new ResponseEntity(HttpStatus.OK);
    }
}

二、參數校驗工具類

除了使用註解驗證外，也可以通過封裝參數校驗工具類的方式實現參數校驗。參數校驗工具類是一個全局的工具類，可以在多個地方使用。在工具類中，將所有需要驗證的參數分別進行校驗並將異常信息收集處理，最後返回校驗結果。這種方法的優點是將驗證邏輯獨立出來，易於擴展。

以下是使用參數校驗工具類的示例代碼：

public class ValidationUtil {
    
    public static  void validate(T obj) throws BadRequestException {
        Set<ConstraintViolation> constraintViolations = validator.validate(obj);

        if (!constraintViolations.isEmpty()) {
            List errorMsg = constraintViolations.stream()
                    .map(ConstraintViolation::getMessage)
                    .collect(Collectors.toList());
            throw new BadRequestException(errorMsg.toString());
        }
    }
}

public class UserController {
    
    @PostMapping("/user")
    public ResponseEntity addUser(@RequestBody User user){
        ValidationUtil.validate(user);
        //處理添加用戶的邏輯
        return new ResponseEntity(HttpStatus.OK);
    }
}

三、統一異常處理

在進行參數校驗時，可能會出現各種異常，如空指針異常、參數不合法等。針對這些異常，可以通過統一異常處理的方式進行處理，避免代碼重複。在Spring Boot中，可以通過@ControllerAdvice註解實現統一異常處理。

以下是使用統一異常處理的示例代碼：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(BadRequestException.class)
    @ResponseBody
    public ResponseEntity handleBadRequestException(BadRequestException e) {
        return new ResponseEntity(e.getMessage(), HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseEntity handleException(Exception e) {
        return new ResponseEntity("系統異常，請稍後重試", HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

public class UserController {
    
    @PostMapping("/user")
    public ResponseEntity addUser(@Valid @RequestBody User user){
        //處理添加用戶的邏輯
        return new ResponseEntity(HttpStatus.OK);
    }
}

四、自定義校驗規則

在實現參數校驗時，有些校驗規則可能是系統中獨有的，無法通過註解驗證或者參數校驗工具類來實現。此時，可以通過編寫自定義校驗規則的方式實現參數校驗。實現自定義校驗規則需要繼承ConstraintValidator類，並在定義的註解中引入自定義的校驗規則。

以下是使用自定義校驗規則的示例代碼：

@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = UsernameValidator.class)
public @interface Username {
    String message() default "用戶名不符合規範";
    Class[] groups() default {};
    Class[] payload() default {};
}

public class UsernameValidator implements ConstraintValidator {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        //校驗規則
        return true;
    }
}

public class User {
    
    @NotNull(message="用戶名不能為空")
    @Username
    private String username;
    
    @Size(min=6,max=16,message="密碼長度必須在6-16位之間")
    private String password;
    
    //getters and setters
}

public class UserController {
    
    @PostMapping("/user")
    public ResponseEntity addUser(@Valid @RequestBody User user){
        //處理添加用戶的邏輯
        return new ResponseEntity(HttpStatus.OK);
    }
}

總結

在Java實現業務功能時，參數校驗是必不可少的一步。通過註解驗證、參數校驗工具類、統一異常處理和自定義校驗規則等方式，可以有效進行Java參數校驗。在實際應用中，可以根據具體情況選擇最合適的校驗方式，保證代碼的可靠性和安全性。