自定义文件valid校验FileSize

在请求参数的校验中，一般使用validation进行校验。如@NotNull、@NotBlank、@Size等。

但validation仅提供了基础的校验规则，复杂的规则还需要自定义实现。

本文自定义**@FileSize**，实现文件非空和文件size限制。

FileSize注解定义

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 文件大小校验注解
 * @date 2023/6/2 4:08 PM
 */
@Target({ElementType.PARAMETER, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = FileSizeValidator.class)
public @interface FileSize {

    String message() default "File size is too large!";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    long max();
}

校验类实现

import org.springframework.web.multipart.MultipartFile;

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 文件大小验证器
 * @date 2023/6/2 4:10 PM
 */
public class FileSizeValidator implements ConstraintValidator<FileSize, MultipartFile> {

    private long maxSize;

    @Override
    public void initialize(FileSize fileSize) {
        this.maxSize = fileSize.max();
    }

    @Override
    public boolean isValid(MultipartFile file, ConstraintValidatorContext context) {

        // 文件为空
        if (file == null || file.isEmpty()) {
            // 重新定义错误消息内容
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("File is empty!").addConstraintViolation();

            return false;
        }

        // 文件过大
        return file.getSize() <= maxSize;
    }
}

使用

/**
 * @author 曳戈泰尔
 * @version 1.0
 * @description 企业认证请求实体
 * @date 2023/6/1 5:53 PM
 */
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
@ApiModel(value = "AuthCompanyReq", description = "企业认证请求实体")
public class AuthCompanyReq {

    @ApiModelProperty(value = "营业执照文件", required = true)
    @FileSize(max = 10 * 1024 * 1024, message = "文件大小不能超过10MB")
    private MultipartFile licenseFile;

}