springboot实战学习（12）(优化更新用户基本信息接口)(Validation实体参数校验)

• 接着上篇博客学习。
• 上一部分已经完成用户模块的第四个接口——更新用户基本信息的主逻辑。具体回看如下。

springboot实战学习（11）(更新用户基本信息接口主逻辑)-CSDN博客

目录

一、分析问题

（1）查看之前写的代码（UserController）

（2）讨论参数校验

（3）实体类对象的参数校验

（I）第一步。在实体类对应的成员变量上添加Validation提供的注解。

@NotNull。

@NotEmpty。

@Email。

（II）第二步。在具体使用该实体类参数的地方，添加注解@Validated。

二、IDEA实际操作。

（1）实体类User。

（2）UserController层。

（3）重新启动工程。测试。

（I）正常测试。

（II）异常测试。（查看参数校验）

三、总结

（1）实体参数校验具体操作步骤。

---

一、分析问题

（1）查看之前写的代码（UserController）

• 可以看到，在方法上接收前端传的参数User对象。但是并没有对参数完成校验。
• id必须传递，不能为null。nickname不仅不能为null，还要1~10非空字符。email不能为null，还要满足邮箱格式。
• 因为username不能修改，所以不需要去关注。

（2）讨论参数校验

---

• 具体学习如何使用Spring提供的参数校验可以看下方链接。
• 《Spring Validation参数校验框架》

springboot实战学习笔记（4）(Spring Validation参数校验框架、全局异常处理器)_springboot validation全局异常处理-CSDN博客

---

• 之前在登录与注册时，已经使用Validation对请求参数完成过校验。
• 不过在注册接口中，是直接在方法的参数上添加注解@Pattern，从而对参数完成校验。

---

• 而目前我们的更新用户基本信息的接口的方法是把请求参数封装到实体类对象user里面了。
• 则实体参数如何完成校验？？？？

（3）实体类对象的参数校验

（I）第一步。在实体类对应的成员变量上添加Validation提供的注解。

• 对指定的属性值完成校验。如下所示。

---

（这里会用到三个新的注解）

• @NotNull。

• @NotEmpty。

• 限制不能为null。且如果是字符串，不能为空字符串。（用这个来限定昵称、邮箱）

• @Email。

• 限制当前变量的值必须满足邮箱的格式。可以用来对email这个属性完成限定。当然可以用@Pattern注解自定义邮箱的规则。

（II）第二步。在具体使用该实体类参数的地方，添加注解@Validated。

• 添加完后，实体类中属性上的这些注解才能生效。
• 分析完实体参数校验的步骤后，直接去IDEA操作。

二、IDEA实际操作。

（1）实体类User。

package com.feisi.pojo;

import com.fasterxml.jackson.annotation.JsonIgnore;
import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Pattern;
import lombok.Data;


import java.time.LocalDateTime;

@Data
public class User {
    @NotNull
    private Integer id;//主键ID
    private String username;//用户名
    @JsonIgnore
    private String password;//密码
    @NotEmpty
    @Pattern(regexp = "^\\S{1,10}$")
    private String nickname;//昵称
    @NotEmpty
    @Email
    private String email;//邮箱
    private String userPic;//用户头像地址
    private LocalDateTime createTime;//创建时间
    private LocalDateTime updateTime;//更新时间
}

（2）UserController层。

• 在"/update"（更新）接口的实体参数前添加注解@Validated。

@PutMapping("/update")
    public Result update(@RequestBody @Validated User user){
        userService.update(user);
        return Result.success();
    }

（3）重新启动工程。测试。

• 测试前，记得重新登录。因为jwt令牌是有时效性的，需重新把请求头（Authorization）的值赋值最新token令牌的值。

---

（I）正常测试。

• 先看当前数据库已注册的用户信息。

• 点击测试。

• 数据库已成功修改基本信息。

（II）异常测试。（查看参数校验）

• id为null时。失败。

---

• nickname为null或者为空字符串。失败。

---

• 邮箱地址错误。失败。

三、总结

（1）实体参数校验具体操作步骤。