参数校验器使用场景例子及小知识

使用方式一

如果spring-boot版本小于2.3.x，spring-boot-starter-web会自动传入hibernate-validator依赖。如果spring-boot版本大于2.3.x，则需要手动引入依赖：

 <dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.1.Final</version>
</dependency>

在用户注册的场景下-SpringBoot

只需要引入依赖便可以使用注解，无需其他操作

• controller类

 @PostMapping("register")
    public R register(@Validated @RequestBody UserRegisterPo userRegisterPo) {
        UserRegisterContext userRegisterContext = userConverter.userRegisterPOToUserRegisterContext(userRegisterPo);
        Long userId= userService.register(userRegisterContext);
        return  R.data(IdUtil.encrypt(userId));
    }

• 接收参数的实体类

  • 小知识1：serialVersionUID作用 （在实现serializable的类中）

  • 在Java中，当一个类实现了Serializable接口时，它可以被序列化和反序列化。序列化是将对象的状态信息转换为字节流的过程，以便将其存储到文件或通过网络传输。反序列化则是将字节流转换回对象的过程。
  • serialVersionUID是一个用于标识类版本的静态常量。它的作用是在反序列化过程中，确保接收到的字节流与当前类的序列版本一致。如果接收到的字节流的serialVersionUID与当前类的serialVersionUID不匹配，就会抛出InvalidClassException异常。
  • 通过为类显式定义一个serialVersionUID值，可以控制类的序列化版本。如果没有显式定义serialVersionUID，Java会根据类的结构自动生成一个默认值。但是，如果类的结构发生了变化（例如添加、删除或修改字段），那么自动生成的默认值可能会发生变化，导致无法正确反序列化之前序列化的对象。

因此，为了确保在类结构变化后仍能正确进行序列化和反序列化，建议显式定义一个稳定的serialVersionUID值。这样，即使类的结构发生了变化，只要serialVersionUID保持不变，就可以保证兼容性。

package com.wu.pan.server.modules.user.po;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import org.hibernate.validator.constraints.Length;

import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Pattern;
import java.io.Serializable;

/**
 * @Date 2024-02-19 21:26
 * @Created by cc
 * @Classname UserRegisterPo
 * @Description :  注册用户参数实体对象
 */
@Data
@ApiModel(value = "用户注册参数")
public class UserRegisterPo implements Serializable {


    private static final long serialVersionUID = -5521427813609988931L;

    @ApiModelProperty(value = "用户名", required = true)
    @NotBlank(message = "用户名不能为空")
    @Pattern(regexp = "^[0-9A-Za-z]{6,16}$", message = "请输入6-16位只包含数字和字母的用户名")
    private String username;

    @ApiModelProperty(value = "密码", required = true)
    @NotBlank(message = "密码不能为空")
    @Length(min = 8, max = 16, message = "请输入8-16位的密码")
    private String password;

    @ApiModelProperty(value = "密码问题", required = true)
    @NotBlank(message = "密保问题不能为空")
    @Length(max = 100, message = "密保问题不能超过100个字符")
    private String question;

    @ApiModelProperty(value = "密码答案", required = true)
    @NotBlank(message = "密保答案不能为空")
    @Length(max = 100, message = "密保答案不能超过100个字符")
    private String answer;
}

使用方式二

@validate较方式一直接使用controller类上，如@NotBlank等注解直接使用到方法上

小知识2：各种路径扫描区别

• @ComponentScan、@ServletComponentScan和@MapperScan都是Spring框架中的注解，用于指定Spring容器在启动时需要扫描的包路径。但它们之间存在一些差异。

---

• @ComponentScan：这个注解会告诉Spring去扫描指定的包路径下的类，并且将带有@Component、@Service、@Repository、@Controller等注解的类注册为Spring容器中的bean。这样，这些类就可以被Spring容器管理，实现依赖注入等功能。
• @ServletComponentScan：这个注解是@ComponentScan的一个扩展，主要用于Web应用上下文。它不仅会扫描带有上述注解的类，还会扫描带有@WebServlet、@WebFilter等Web相关注解的类，确保这些Web组件也能被正确地注册到Spring Web应用上下文中。
• @MapperScan：这个注解主要用于MyBatis框架，它会告诉Spring扫描指定的包路径下带有@Mapper或@Repository注解的接口，并将这些接口注册为MyBatis的Mapper接口，使得可以通过MyBatis来访问数据库。

---

• 总的来说，@ComponentScan是一个通用的组件扫描注解，适用于大多数Spring应用；@ServletComponentScan专门用于Web应用上下文，确保Web组件也能被扫描和管理；而@MapperScan则是针对MyBatis框架的Mapper接口进行扫描的注解。

package com.wu.pan.server;


import com.wu.pan.framework.constants.RPanConstants;
import com.wu.pan.framework.response.R;
import io.swagger.annotations.Api;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.constraints.NotBlank;

@SpringBootApplication(scanBasePackages = RPanConstants.BASE_COMPONENT_SCAN_PATH)
@ServletComponentScan(basePackages = RPanConstants.BASE_COMPONENT_SCAN_PATH+".web")
@EnableTransactionManagement    //开启事务
@MapperScan(basePackages =RPanConstants.BASE_COMPONENT_SCAN_PATH + ".server.modules.**.mapper")
@Api("接口测试类")

//以上注解可忽略，与参数校验无关
@RestController
@Validated  //开启参数校验
public class RPanServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(RPanServerApplication.class);
    }

    @GetMapping("hello")
    public R hello(@NotBlank(message = "名称不能为空") @RequestParam(value = "name")  String name) {
        //@RequestParam(value = "name", required = false)
        return R.data("new hello " + name + "!");
    }
}

使用讲解（转载）

来自 终码一生