Java Bean Validation+springboot对API接口入参（vo）参数校验

假发男孩@ming

已于 2024-03-04 17:21:48 修改

阅读量303

点赞数 1

文章标签： java spring boot 开发语言

于 2024-03-04 17:17:21 首次发布

本文链接：https://blog.csdn.net/aegsegher/article/details/136457533

版权

@Slf4j
@Api(tags = "相关API")
@Validated
@RestController
@RequestMapping("/api/xxx/xx/xxx")
public class NycfXzcfBaseApi {

    @ApiOperation(value = "1.xxxx")
    @ApiAuthentication
    @RequestMapping(value = "/reDeclare")
    public ResponseData<xxxVO> reDeclare(@RequestBody NycfPartyRequest partyRequest) {
        return ResponseData.success(nycfXzcfBaseService.reDeclare(partyRequest));
    }

}

@Data
@ApiModel(value = "Api请求对象")
@Validated
public class NycfPartyRequest {

    @ApiModelProperty(value = "主键id（重新填报时用）", required = true)
    private String id;

    @ApiModelProperty(value = "案由", required = true)
    @NotBlank(message = "案由不能为空")
    private String caseAction;

    @ApiModelProperty(value = "罚款金额", required = true)
    @NotNull(message = "罚款金额不能为空")
    private Double fine;

    @ApiModelProperty(value = "没收金额", required = true)
    @NotNull(message = "没收金额不能为空")
    private Double forfeiture;

    @ApiModelProperty(value = "", required = true)
    private String nycfBaseId;

    @ApiModelProperty(value = "当事人证件号", required = true)
    @Pattern(regexp="^(\\d{15}|\\d{18}|[1-9]\\d{5}(18|19|([23]\\d))\\d{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)\\d{3}[0-9Xx])$", message = "证件号格式不合法")
    @NotBlank(message = "当事人证件号不能为空")
    private String partyCertificateNumber;

    @ApiModelProperty(value = "当事人手机号", required = true)
    @NotBlank(message = "当事人手机号不能为空")
    @Size(min = 11, max = 11, message = "手机号长度必须为11位")
    @Pattern(regexp = "^1[3-9]\\d{9}$", message = "手机号格式不正确")
    private String partyMobile;

    @ApiModelProperty(value = "当事人姓名", required = true)
    @NotBlank(message = "当事人姓名不能为空")
    private String partyName;


    @ApiModelProperty(value = "行政决定书送达日期", required = true)
    @NotNull(message = "行政决定书送达日期不能为空")
    @DateTimeFormat(pattern = "yyyy-MM-dd")
    private Date serviceDate;

    private String serialNumber;
}

1. Api上加@Validated

2. 在vo上加@Validated

备注：可以使用@Pattern结合正则表达式对身份证号、手机号等常用号码进行格式校验

可以使用@Size进行长度校验