【肥朝】用最低的成本，提升你的代碼穩壯性

配置參數啓動時校驗

若是配置文件沒有相關的配置，那麼**啓動時**就會出現如下異常:

Description:

Binding to target com.toby.provide.ApplicationProperties@31da6b2e failed:

    Property: feichao.info.name
    Value: null
    Reason: 名字不能爲空，請注意檢查，參考值爲：肥朝。
複製代碼

肥朝小聲逼逼：提升代碼穩壯性，肥朝認爲最好的辦法就是提早預防。實際項目中，咱們在配置文件配置了各類參數。可是你們也知道，不一樣環境的配置參數，是會不同的，不免會由於人爲疏忽，致使某個環境的配置文件，少了一些關鍵參數，光靠肉眼來檢查，必然是一個低效而又不可靠的方式。若是你不用該方式校驗，很容易在某個特殊的場景下，才觸發出坑。可是你採用這種方式，作了大量的啓動時校驗，一旦參數不合法，項目啓動都啓動不了，作到了防範於未然！

Controller

HelloDTO

@Data
public class HelloDTO {

    @NotBlank
    private String name;

    @Min(0)
    @Max(150)
    private int age;

}
複製代碼

HelloController

@RestController
public class HelloController {

    @RequestMapping("/controllerValid")
    public String controllerValid(@RequestBody @Valid HelloDTO helloDTO) {
        return "ok";
    }
}
複製代碼

請求參數爲

{
	"name":"肥朝",
	"age" : 151
}
複製代碼

時，出現校驗異常

org.springframework.web.bind.MethodArgumentNotValidException
複製代碼

Service

HelloDTO

@Data
public class HelloDTO {

    @NotBlank
    private String name;

    @Min(0)
    @Max(150)
    private int age;

}
複製代碼

AService

public interface AService {

    int insertUser(HelloDTO helloDTO);

}
複製代碼

AServiceImpl

@Service
public class AServiceImpl implements AService {

    @Autowired
    private BService bService;

    @Override
    public int insertUser(HelloDTO helloDTO) {
        return bService.insertUser(helloDTO);
    }
}
複製代碼

BService

public interface BService {

    int insertUser(@Valid HelloDTO helloDTO);

}
複製代碼

BServiceImpl

@Service
@Slf4j
@Validated
public class BServiceImpl implements BService {

    @Override
    public int insertUser(HelloDTO helloDTO) {
        log.info("BService insertUser...");
        return 0;
    }
}
複製代碼

單元測試

@RunWith(SpringRunner.class)
@SpringBootTest
public class AserviceTest {

    @Autowired
    private BService bService;

    @Test
    public void testInsertUser() throws Exception {
        HelloDTO helloDTO = new HelloDTO();
        bService.insertUser(helloDTO);
    }

}
複製代碼

輸出校驗異常信息：

javax.validation.ConstraintViolationException
複製代碼

Dubbo

Dubbo官方文檔中已經寫得很是詳細，地址爲：dubbo.apache.org/zh-cn/docs/…

參數驗證功能是基於 JSR303 實現的，用戶只需標識 JSR303 標準的驗證 annotation，並經過聲明 filter 來實現驗證。

maven依賴

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.0.0.GA</version>
</dependency>
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>4.2.0.Final</version>
</dependency>
複製代碼

示例

參數標註示例

import java.io.Serializable;
import java.util.Date;
 
import javax.validation.constraints.Future;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Past;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
 
public class ValidationParameter implements Serializable {
    private static final long serialVersionUID = 7158911668568000392L;
 
    @NotNull // 不容許爲空
    @Size(min = 1, max = 20) // 長度或大小範圍
    private String name;
 
    @NotNull(groups = ValidationService.Save.class) // 保存時不容許爲空，更新時容許爲空 ，表示不更新該字段
    @Pattern(regexp = "^\\s*\\w+(?:\\.{0,1}[\\w-]+)*@[a-zA-Z0-9]+(?:[-.][a-zA-Z0-9]+)*\\.[a-zA-Z]+\\s*$")
    private String email;
 
    @Min(18) // 最小值
    @Max(100) // 最大值
    private int age;
 
    @Past // 必須爲一個過去的時間
    private Date loginDate;
 
    @Future // 必須爲一個將來的時間
    private Date expiryDate;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public String getEmail() {
        return email;
    }
 
    public void setEmail(String email) {
        this.email = email;
    }
 
    public int getAge() {
        return age;
    }
 
    public void setAge(int age) {
        this.age = age;
    }
 
    public Date getLoginDate() {
        return loginDate;
    }
 
    public void setLoginDate(Date loginDate) {
        this.loginDate = loginDate;
    }
 
    public Date getExpiryDate() {
        return expiryDate;
    }
 
    public void setExpiryDate(Date expiryDate) {
        this.expiryDate = expiryDate;
    }
}
複製代碼

分組驗證示例

public interface ValidationService { // 缺省可按服務接口區分驗證場景，如：@NotNull(groups = ValidationService.class) 
    @interface Save{} // 與方法同名接口，首字母大寫，用於區分驗證場景，如：@NotNull(groups = ValidationService.Save.class)，可選
    void save(ValidationParameter parameter);
    void update(ValidationParameter parameter);
}
複製代碼

關聯驗證示例

import javax.validation.GroupSequence;
 
public interface ValidationService {   
    @GroupSequence(Update.class) // 同時驗證Update組規則
    @interface Save{}
    void save(ValidationParameter parameter);
 
    @interface Update{} 
    void update(ValidationParameter parameter);
}
複製代碼

參數驗證示例

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
 
public interface ValidationService {
    void save(@NotNull ValidationParameter parameter); // 驗證參數不爲空
    void delete(@Min(1) int id); // 直接對基本類型參數驗證
}
複製代碼

配置

在客戶端驗證參數

<dubbo:reference id="validationService" interface="org.apache.dubbo.examples.validation.api.ValidationService" validation="true" />
複製代碼

在服務器端驗證參數

<dubbo:service interface="org.apache.dubbo.examples.validation.api.ValidationService" ref="validationService" validation="true" />
複製代碼

驗證異常信息

import javax.validation.ConstraintViolationException;
import javax.validation.ConstraintViolationException;
 
import org.springframework.context.support.ClassPathXmlApplicationContext;
 
import org.apache.dubbo.examples.validation.api.ValidationParameter;
import org.apache.dubbo.examples.validation.api.ValidationService;
import org.apache.dubbo.rpc.RpcException;
 
public class ValidationConsumer {   
    public static void main(String[] args) throws Exception {
        String config = ValidationConsumer.class.getPackage().getName().replace('.', '/') + "/validation-consumer.xml";
        ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(config);
        context.start();
        ValidationService validationService = (ValidationService)context.getBean("validationService");
        // Error
        try {
            parameter = new ValidationParameter();
            validationService.save(parameter);
            System.out.println("Validation ERROR");
        } catch (RpcException e) { // 拋出的是RpcException
            ConstraintViolationException ve = (ConstraintViolationException) e.getCause(); // 裏面嵌了一個ConstraintViolationException
            Set<ConstraintViolation<?>> violations = ve.getConstraintViolations(); // 能夠拿到一個驗證錯誤詳細信息的集合
            System.out.println(violations);
        }
    } 
}
複製代碼

1.自 2.1.0 版本開始支持, 如何使用能夠參考dubbo 項目中的示例代碼(github.com/apache/incu…)

2.驗證方式可擴展，擴展方式參見開發者手冊中的驗證擴展(dubbo.apache.org/zh-cn/docs/…)

工具類方式校驗

ValidationUtils

public class ValidationUtils {

    private static Validator validator = Validation
            .byProvider(HibernateValidator.class)
            .configure()
            .failFast(true)
            .buildValidatorFactory()
            .getValidator();


    public static <T> void validate(T obj) {
        Set<ConstraintViolation<T>> validate = validator.validate(obj);
        for (ConstraintViolation<T> violation : validate) {
            // 注意，在實際業務中
            // 這裏會根據violation進行參數拼接
            // 而後進行自定義異常的拋出
        }
    }

}
複製代碼

單元測試

@Test
public void testValidationUtils() throws Exception {
    HelloDTO helloDTO = new HelloDTO();
    ValidationUtils.validate(helloDTO);
}
複製代碼

敲黑板劃重點

上述從五個方面，作了校驗方式的示例，全都是基於hibernate-validate。可是細心的你就會發現，你搜索hibernate-validate,網上的基本只有**controller**這種方案，所以肥朝從多個層來代碼示例，基本覆蓋你的所有場景。

另外須要注意的是，controller層拋出的校驗異常類型是

org.springframework.web.bind.MethodArgumentNotValidException
複製代碼

service層拋出的校驗異常類型是

javax.validation.ConstraintViolationException
複製代碼

工具類的方式校驗時，須要拿到參數處理，再自定義異常拋出。所以在作全局異常的時候，須要注意。

固然，該校驗方式不只使得參數校驗比

if (helloDTO.getAge() <= 0) {
    //...
}
複製代碼

優雅不少，還支持自定義註解實現校驗規則、國際化、分組校驗等，這些大家項目具體用到的時候，再去看看便可。

固然提升代碼穩壯性的方式還有不少，可是肥朝認爲參數校驗的方式，成本和效果的性價比是最高之一，你有什麼提升代碼穩壯性的方式？留言告訴肥朝。

寫在最後

---