1、常用注解：

@NotEmpty、@NotBlank 以及 @NotNull 注解的使用：

@NotEmpty 用在集合或數(shù)組上面，一般用來校驗List類型(不能注釋枚舉)，而且長度必須大于0
@NotBlank 用在String上面，一般用來校驗String類型不能為空，而且調(diào)用trim()后，長度必須大于0。
@NotNull 用在所有類型上面，一般用來校驗Integer類型不能為空，但可以為empty。
需要搭配@Valid使用，在檢驗Controller的入?yún)⑹欠穹弦?guī)范時

@JsonFormat注解：

可以約束時間的接收格式和響應(yīng)格式 (接收和響應(yīng)的都是JSON字符串)，將日期類型數(shù)據(jù)在JSON格式和java.util.Date對象之間轉(zhuǎn)換 （前端傳參是json字符串格式，后端返參也是json字符串格式，JsonFormat注解會自動轉(zhuǎn)化成data格式進行處理）。與傳輸方向沒有關(guān)系（前端到后端or后端到前端都可以使用）

使用 @JsonFormat 注解時，查到的時間可能會比數(shù)據(jù)庫中的時間少八個小時，這是由于時區(qū)差引起的，JsonFormat 默認(rèn)的時區(qū)是 Greenwich Time， 默認(rèn)的是格林威治時間，而我們是在東八區(qū)上，所以時間會比實際我們想得到的時間少八個小時。需要在后面加上一個時區(qū),如下示例：

@JsonFormat(pattern="yyyy-MM-dd",timezone="GMT+8")
private Date date;

常用注解屬性：

@DateTimeFormat注解：

可對java.util.Date、java.uitl.calendar、java.long.Long及Joda時間類型的屬性進行標(biāo)注，主要處理前端時間類型與后端pojo對象中的成員變量進行數(shù)據(jù)綁定，所約束的時間格式并不會影響后端返回前端的時間類型數(shù)據(jù)格式；（前端傳參是json字符串格式，后端返參也是json字符串格式，DateTimeFormat注解會自動轉(zhuǎn)化成data格式進行處理）

注意：前端入?yún)?shù)據(jù)的時間格式必須與注解中定義的時間格式相同，不然會報錯，如：@DateTimeFormat(pattern = “yyyy-MM-dd HH:mm”) 則入?yún)⒌母袷奖仨殲?2020-6-4 10:43"；

常用注解屬性：

@JsonFormat 和 @DateTimeFormat 區(qū)別

@JsonFormat既可以約束前端傳入的時間類型參數(shù)格式，也可以約束后端響應(yīng)前端的時間類型格式；

@DateTimeFormat ：

• 只能約束前端入?yún)r間類型的格式，并不會修改原有的日期對象的格式，如果想要獲得期望的日期格式，是需要自己手動轉(zhuǎn)換的；
• 如果單獨使用@DateTimeFormat 時，響應(yīng)給前端的時間會比實際時間晚8個小時（時區(qū)原因）

參考鏈接：https://blog.csdn.net/zhuzicc/article/details/106529485

@ApiModelProperty()注解：用于方法，字段； 表示對屬性的說明或者數(shù)據(jù)操作更改

value–字段說明
name–重寫屬性名字 ，
dataType–重寫屬性類型
required–是否必填
example–舉例說明
hidden–隱藏

@ApiModel(value="user對象",description="用戶對象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用戶名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="狀態(tài)",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;

      @ApiModelProperty(value="id數(shù)組",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

一些校驗注解的使用：

2、使用案例（@Valid注解的使用）：

@valid注解主要用于數(shù)據(jù)校驗，可定義在兩種地方。

1. 定義實體類中的屬性上，添加不同的注解來完成不同的校驗規(guī)則。

2. 定義在接口類中，在接收參數(shù)前添加@Valid注解，開啟實體類的校驗功能。

1、在實體類中添加注解校驗：

public class OrderSync {
        private static final long serialVersionUID = 1L;
        /**
         * 用戶Id
         */
        @ApiModelProperty(value = "用戶id") //@ApiModelProperty是swagger的注解，它的作用是添加和操作屬性模塊的數(shù)據(jù)
        @NotEmpty(message = "用戶id不能為空")
        private String userId;
        /**
         * 購買數(shù)量
         */
        @NotNull(message = "購買數(shù)量不能為空")
        private Integer quantity;
        /**
         * 支付時間
         */
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @NotEmpty(message = "支付時間不能為空")
        private LocalDateTime paymentTime;
    
        /**
         * 訂單狀態(tài)1、待發(fā)貨 2、待收貨 3、確認(rèn)收貨/已完成 5、已關(guān)閉
         */
        @Excel(name = "訂單狀態(tài)", readConverterExp = "1=待發(fā)貨,2=待收貨,3=確認(rèn)收貨/已完成 ,5=已關(guān)閉")
        @NotEmpty(message = "訂單狀態(tài)不能為空")
        private String orderStatus;

}

2、在接口中添加@valid注解

在controller類中添加接口，POST方法中接收設(shè)置了@Valid相關(guān)注解的實體對象，然后再參數(shù)中添加@Valid注解來開啟效驗功能，需要注意的是，@Valid對Get請求中接收的平面參數(shù)請求無效。

@RestController
public class TestController {
    @PostMapping("/sync")
    public String addUserInfo(@Valid @RequestBody OrderSync sync){
        return "調(diào)用成功";
    }
}

嵌套校驗：

為了能夠進行嵌套驗證，必須手動在Person實體的son字段上明確指出這個字段里面的實體也要進行驗證。

class Person {
    @NotNull
    private Integer id;

    @NotNull
    /**
     * @Validated不允許使用在成員屬性上，所以只能用@Valid
     * 如果不加  @Valid 就不會對 Son類進行校驗,只會判斷 @NotNull，List<Son>是否為空，并不會Son類里面的成員屬性
     */
    @Valid //嵌套驗證
    private List<Son> son;
}

class Son {
    @NotNull
    private Integer sid;

    @NotBlank(message = "姓名不能為空")
    private String name;

}

class MemberController {

    @ApiOperation(value = "會員注冊")
    @PostMapping("register")
                              //使用@Validated或者@Valid都可以,這樣就完成了嵌套驗證
    public JSONResult register(@Validated @RequestBody Person person, BindingResult bindingResult){

        if (bindingResult.hasErrors()) {
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
            return JSONResult.error().message(bindingResult.getFieldError().getDefaultMessage());
        }
        return JSONResult.ok();
    }

}

3、@Valid 與 @Validated注解的區(qū)別：

@Valid、@Validated 注解可以實現(xiàn)數(shù)據(jù)的驗證，你可以定義實體，在實體的屬性上添加校驗注解，如@NotEmpty，@NotBlank，@NotNull等等的注解就是，不加上就不會生效！
@Valid 包位置：javax.validation
@Validated 包位置 org.springframework.validation.annotation，是@Valid 的一次封裝，是Spring提供的校驗機制使用。

不同點：

1、使用位置：

• @Validated：用在類型、方法和方法參數(shù)上。但不能用于成員屬性（field）
• @Valid：可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性（field）上
  

如果@Validated注解在成員屬性上，則會報 ‘@Validdated’ not applicable to field 錯誤：

2、分組上：@Valid 不支持分組， @Validated則支持分組驗證。

定義分組接口：

public interface IGroupA {
}
 
public interface IGroupB {
}

定義需要檢驗的參數(shù)bean：

public class StudentBean implements Serializable{
    @NotBlank(message = "用戶名不能為空")
    private String name;
    //只在分組為IGroupB的情況下進行驗證
    @Min(value = 18, message = "年齡不能小于18歲", groups = {IGroupB.class})
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手機號格式錯誤")
    private String phoneNum;
    @Email(message = "郵箱格式錯誤")
    private String email;
    @MyConstraint
    private String className;
}

測試代碼：檢驗分組為IGroupA的情況，這里對分組IGroupB的就沒檢驗了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

如果把測試代碼改成下面這樣，就會檢驗B了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

說明：
1、不分 配groups，默認(rèn)每次都要進行驗證
2、對一個參數(shù)需要多種驗證方式時，也可通過分配不同的組達到目的。

相同點：

在檢驗Controller的入?yún)⑹欠穹弦?guī)范時，使用@Validated或者@Valid都可以實現(xiàn)，并且需要傳入BindingResult對象，用于獲取校驗失敗情況下的反饋信息，如下代碼：

  @PostMapping("register")
                             //@Valid這兩個用哪個效果都一樣
    public JSONResult register(@Validated @RequestBody RegisterVo registerVo, BindingResult bindingResult){

     //會把校驗失敗情況下的反饋信息
        if (bindingResult.hasErrors()) {
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
            return JSONResult.error().message(bindingResult.getFieldError().getDefaultMessage());
        }
        memberService.register(registerVo);
        return JSONResult.ok();
    }

總結(jié)：

1.常用校驗注解@NotEmpty，@NotBlank，@NotNull，需要搭配@Valid或@Validated使用

2.@Valid或@Validated 中有 BindingResult，可以獲取校驗失敗情況下的反饋信息，如果不添加，默認(rèn)情況下會拋出對應(yīng)的異常。

3.@Validated無法單獨提供嵌套驗證功能。不能用在成員屬性上，能配合嵌套驗證注解@Valid進行嵌套驗證。

4.@Valid無法單獨提供嵌套驗證功能。能夠用在成員屬性上，能配合嵌套驗證注解@Valid進行嵌套驗證。

參考鏈接：https://blog.csdn.net/weixin_46015018/article/details/122637042文章來源地址http://www.zghlxwxcb.cn/news/detail-766621.html

到了這里，關(guān)于【Java】在實體類中常用的注解校驗的文章就介紹完了。如果您還想了解更多內(nèi)容，請在右上角搜索TOY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！