1 背景
服務端的接口經(jīng)常要進行參數(shù)校驗屎勘，傳統(tǒng)的在方法里面校驗的方式會產(chǎn)生很多冗余代碼，因此可以使用一些工具來幫我們解決這個問題
例如 hibernate-validator
引入jar包
hibernate-validator.6.5.0.Final.jar
validation-api-1.0.0.GA.jar
使用如下
在需要校驗的參數(shù)對象上加上約束注解
在controller 方法里面加上 @Valid 票彪，使校驗生效
@ApiModel
public class UserCreateRequest {
@ApiModelProperty(name = "手機驗證碼")
@NotBlank
private String code;
@ApiModelProperty(name = "手機號")
@NotBlank
private String phone;
private String username;
@ApiModelProperty(name = "密碼")
@NotBlank
private String password;
}
@ApiOperation(value = "檢驗")
@PostMapping(value = "/check")
public String create(@RequestBody @Valid UserCreateRequest request) {
return null;
}
2 去掉 BindingResult
經(jīng)過上面的配置肿仑，如果請求的參數(shù)校驗不通過郑兴，返回的信息是這樣的，這些信息沒有經(jīng)過整理奏篙，對前端來說很難處理 因此我們要重新整理這 些校驗不通過的提示信息
image.png
通用的有一種方式,就是方法里面加上 BindingResult 參數(shù)，校驗結果會存放到這個參數(shù)里面, 然后拿到異常信息返回
@ApiOperation(value = "檢驗")
@PostMapping(value = "/check")
public String create(@RequestBody @Valid UserCreateRequest request, BindingResult bindingResult) {
if (bindingResult.hasErrors()){
return bindingResult.getFieldError().getDefaultMessage();
}
return null;
}
尼瑪這么寫代碼，得在每個校驗的方法里面加上這個秘通，很不爽为严，看我的。
異常處理機制要這么配置
@Component
public class CustomExceptionResolver implements HandlerExceptionResolver, Ordered {
private static final Log log = LogFactory.getLog(CustomExceptionResolver.class);
@Override
public int getOrder() {
return 0;
}
// 這里將捕獲到的異常做統(tǒng)一處理,不直接在接口返回異常的堆棧信息
@ResponseBody
@Nullable
@Override
public ModelAndView resolveException(HttpServletRequest request,
HttpServletResponse response,
@Nullable Object handler,
Exception ex) {
log.error("捕獲到異常 ", ex);
ModelAndView modelAndView = new ModelAndView();
MappingJackson2JsonView mappingJackson2JsonView = new MappingJackson2JsonView();
Map<String, Object> attributes = new HashMap<>(2);
attributes.put("succeed", false);
//把校驗不通過的信息重新整理返回
if (ex instanceof MethodArgumentNotValidException) {
MethodArgumentNotValidException validException = (MethodArgumentNotValidException) ex;
FieldError fieldError = validException.getBindingResult().getFieldErrors().get(0);
attributes.put("message", fieldError.getField() + " " + fieldError.getDefaultMessage());
}
mappingJackson2JsonView.setAttributesMap(attributes);
modelAndView.setView(mappingJackson2JsonView);
return modelAndView;
}
}
全局的異常處理肺稀，如果不實現(xiàn) Ordered 接口并且把順序調(diào)到最先第股，這個異常處理會被spring 的DefaultHandlerExceptionResolver 攔截并直接返回，你自己配置的異常處理是無法捕獲校驗不通過的異常的话原。
按照上面的方式配置好后夕吻，接口就可以返回自定義的信息啦，炒雞方便繁仁，呵呵噠
image.png
3 實現(xiàn)根據(jù)瀏覽器的語言返回對應語言的校驗不通過的信息
- 配置消息轉換器 MessageInterpolator
public class MessageInterpolatorAdapter implements MessageInterpolator {
private MessageInterpolator defaultInterpolator;
public MessageInterpolatorAdapter(MessageInterpolator interpolator) {
this.defaultInterpolator = interpolator;
}
/**
* 將用戶的 locale 信息傳遞給消息解釋器,而不是使用默認的 JVM locale 信息
*/
@Override
public String interpolate(String message, Context context) {
return defaultInterpolator.interpolate(message, context, getRequestLocale());
}
@Override
public String interpolate(String message, Context context, Locale locale) {
return defaultInterpolator.interpolate(message, context, locale);
}
//getRequestLocale()方法拿到了瀏覽器的語言設置,請求一次執(zhí)行一次
private Locale getRequestLocale() {
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
if (null == requestAttributes) {
throw new BizException("getLocale");
}
HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
String acceptLang = request.getHeader("Accept-Language");
if (StringUtils.isBlank(acceptLang)) {
throw new BizException("getLocale");
}
acceptLang = acceptLang.substring(0,2);
if (acceptLang.equals("zh")) {
return new Locale("zh");
}
else {
return new Locale("en");
}
}
}
- 配置自定義的驗證器
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Bean
public Validator validator() {
return Validation.byDefaultProvider()
.configure()
.messageInterpolator(new MessageInterpolatorAdapter(new ResourceBundleMessageInterpolator()))
.buildValidatorFactory()
.getValidator();
}
}
驗證器配置好之后用 postman 測試
-
模擬瀏覽器的不同語言
中文的環(huán)境.png
英文的環(huán)境.png
經(jīng)過測試涉馅，這種方式可以實現(xiàn)根據(jù)瀏覽器的不同語言來返回對應的信息，完美實現(xiàn)web參數(shù)校驗國際化
弄完這個發(fā)現(xiàn)自己很優(yōu)秀黄虱，哈哈
