JSRはJava Specification Requestsの略で、Java仕様提案を意味します。これは、JCP(Java Community Process)に標準化された技術仕様を追加するための正式なリクエストです。誰でもJSRを送信して、Javaプラットフォームに新しいAPIとサービスを追加できます。JSRはJavaの世界で重要な標準になっています。
JSR-303はBean Validationと呼ばれるJAVA EE 6のサブ仕様であり、Hibernate ValidatorはBean Validationのリファレンス実装です。HibernateValidatorは、JSR 303仕様のすべての組み込み制約に加えて、いくつかの追加の制約の実装を提供します制約。Hibernate Validatorについて詳しく知りたい場合は、http://www.hibernate.org/subprojects/validator.htmlを確認してください
。SpringBootプロジェクトによって開発されたバックエンドインターフェイスは、多くの場合、パラメーターが空であるかどうか、およびパラメーターの長さについて基本的なチェックを行います。ここで、SpringBootはJSR303を簡単に統合し、注釈を介してインターフェースパラメータを簡単に検証し、検証ルールをカスタマイズできます。
この記事のナビゲーション
JSR303アノテーションの紹介
JSR303には制約が付属しています
Hibernate Validatorの追加の制約
SpringBootプロジェクトの統合
プロジェクト導入依存
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
Hibernate Validatorの概要
Hibernate Validatorの検証モードには2つの状況があります
- 迅速な失敗(1つの検証が失敗し、エラーメッセージがすぐに返される)
- 通常モード(デフォルトでは、すべての属性が検証され、すべての検証失敗情報が返されます)
通常、最初のモードを使用します。SpringBootは構成を有効にする必要があります
/**
* 配置Jsr303 hibernate validator快速失败模式
*/
@Configuration
public class Jsr303Config {
@Bean
public Validator validator(){
ValidatorFactory validatorFactory = Validation
.byProvider( HibernateValidator.class )
.configure()
.failFast( true )
.buildValidatorFactory();
return validatorFactory.getValidator();
}
}
基本的な使い方
メソッドで@Validアノテーションを使用して検証を開き、BindingResultを使用して検証結果を受け取ります
@Data
public class LoginDTO {
@Size(min = 8,message = "账号长度大于8")
String account;
@NotBlank(message = "密码不能为空")
String passwd;
}
@PostMapping("/logon")
public R logon(@Valid LoginDTO loginDTO, BindingResult result){
check(result);
return R.ok("");
}
public static void check(BindingResult result){
StringBuffer sb=new StringBuffer();
if(result.hasErrors()){
for (ObjectError error : result.getAllErrors()) {
sb.append(error.getDefaultMessage());
}
ExUtil.throwBusException(sb.toString());
}
}
Jsr303が統合された例外とともに使用されました
プロジェクトでは、通常、ビジネスに属する統一された例外クラスを定義しますが、ここでは検証に失敗した後、カスタム検証情報が組み立てられ、カスタムBusinessExceptionがスローされます。
public class BusinessException extends RuntimeException {
private static final long serialVersionUID = 1L;
private int code = ApiCommonCodeEnum.FAIL.getCode();
public BusinessException(String message) {
super(message);
}
//防止篇幅过长省略其他代码
}
//异常工具类
public class ExUtil {
public static void throwBusException(String msg){
throw new BusinessException(msg);
}
//......
}
次に、統一された例外によってインターセプトされ、以前に定義されたRインターフェースに戻ります。障害情報はmsgフィールドに含まれています。
統一された例外インターセプトコードのPost部分
@Component
@Slf4j
public class ExceptionResolver implements HandlerExceptionResolver {
@Override
public ModelAndView resolveException(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception ex) {
if(ex instanceof BusinessException){
R result= R.fill(((BusinessException) ex).getCode(),null,ex.getMessage());
outputJSON(httpServletResponse, Charsets.UTF_8.toString(), JsonUtil.toJson(result));
return null;
}else {
R result=R.failed(ex.getMessage());
outputJSON(httpServletResponse, Charsets.UTF_8.toString(), JsonUtil.toJson(result));
return null;
}
}
private void outputJSON(HttpServletResponse response, String charset, String jsonStr) {
PrintWriter out = null;
try {
if (response != null) {
response.setCharacterEncoding(charset);
response.setContentType("text/html;charset=" + charset);
response.setHeader("Pragma", "No-cache");
response.setHeader("Cache-Control", "no-cache");
response.setDateHeader("Expires", 0);
out = response.getWriter();
out.print(jsonStr);
}
} catch (Exception e) {
log.error(ExUtil.getSimpleMessage(e));
} finally {
if (out != null) {
out.close();
}
}
}
}
インターフェーステスト効果
千マイルは単一のステップから始まります。SpringBootチュートリアルシリーズの4番目の記事は、すべてのプロジェクトソースコードをGitHubからダウンロードできます。
詳細については、WeChat公式アカウントをフォローしてください。