【SpringBoot】注册功能，参数校验及异常处理

秀秀_heo

已于 2024-01-18 23:38:00 修改

阅读量522

点赞数 10

分类专栏： SpringBoot 文章标签： spring boot 后端 java

于 2023-12-18 20:14:03 首次发布

本文链接：https://blog.csdn.net/XiugongHao/article/details/135070540

版权

SpringBoot 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

1. 注册功能

1.1 前置介绍

/pojo/User

@Data
public class User {
    @NotNull
    private Integer id;//主键ID

    private String username;//用户名

    @JsonIgnore // 让springmvc 将当前的对象转换为json字符串的时候，忽略password
    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;//更新时间
}

在这里插入图片描述

在这里插入图片描述
数据库中存放的是（用户头像）字符串，到时候会存放头像到第三方的服务器上，这里只是存放一个地址。

在这里插入图片描述

此外，数据库中的这三个采用下划线命名，而类中采用驼峰命名。配置 application.yml 实现数据库中下划线命名与实体类中驼峰命名的相互转化。

# application.yml
mybatis:
  configuration:
    map-underscore-to-camel-case: true  # 开启驼峰命名和下划线命名的自动转换

@Data 是 lombok 中的一个注解，自动生成 getter，setter，toString 等方法。

<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
</dependency>

/pojo/Result

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result<T> {
    private Integer code;//业务状态码  0-成功  1-失败
    private String message;//提示信息
    private T data;//响应数据

    //快速返回操作成功响应结果(带响应数据)
    public static <T> Result<T> success(T data) {
        return new Result<>(0, "操作成功", data);
    }

    //快速返回操作成功响应结果
    public static <T> Result <T> success() {
        return new Result<>(0, "操作成功", null);
    }

    public static <T> Result <T> error(String message) {
        return new Result<>(1, message, null);
    }
}

@NoArgsConstructor，@AllArgsConstructor 添加有参和无参的构造方法注解。

Md5Util

package com.heo.utils;


import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

public class Md5Util {
    /**
     * 默认的密码字符串组合，用来将字节转换成 16 进制表示的字符,apache校验下载的文件的正确性用的就是默认的这个组合
     */
    protected static char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};

    protected static MessageDigest messagedigest = null;

    static {
        try {
            messagedigest = MessageDigest.getInstance("MD5");
        } catch (NoSuchAlgorithmException nsaex) {
            System.err.println(Md5Util.class.getName() + "初始化失败，MessageDigest不支持MD5Util。");
            nsaex.printStackTrace();
        }
    }

    /**
     * 生成字符串的md5校验值
     *
     * @param s
     * @return
     */
    public static String getMD5String(String s) {
        return getMD5String(s.getBytes());
    }

    /**
     * 判断字符串的md5校验码是否与一个已知的md5码相匹配
     *
     * @param password  要校验的字符串
     * @param md5PwdStr 已知的md5校验码
     * @return
     */
    public static boolean checkPassword(String password, String md5PwdStr) {
        String s = getMD5String(password);
        return s.equals(md5PwdStr);
    }


    public static String getMD5String(byte[] bytes) {
        messagedigest.update(bytes);
        return bufferToHex(messagedigest.digest());
    }

    private static String bufferToHex(byte bytes[]) {
        return bufferToHex(bytes, 0, bytes.length);
    }

    private static String bufferToHex(byte bytes[], int m, int n) {
        StringBuffer stringbuffer = new StringBuffer(2 * n);
        int k = m + n;
        for (int l = m; l < k; l++) {
            appendHexPair(bytes[l], stringbuffer);
        }
        return stringbuffer.toString();
    }

    private static void appendHexPair(byte bt, StringBuffer stringbuffer) {
        char c0 = hexDigits[(bt & 0xf0) >> 4];// 取字节中高 4 位的数字转换, >>>
        // 为逻辑右移，将符号位一起右移,此处未发现两种符号有何不同
        char c1 = hexDigits[bt & 0xf];// 取字节中低 4 位的数字转换
        stringbuffer.append(c0);
        stringbuffer.append(c1);
    }

}

1.2 功能实现

/Controller/UserController

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    @Autowired
    private UserService userService;
    @PostMapping("/register")
    public Result register(@Pattern(regexp = "^\\S{5,16}$") String username,@Pattern(regexp = "^\\S{5,16}$") String password) {
        User u = userService.findByUserName(username);
        if (u == null) {
            userService.register(username, password);
            return Result.success();
        } else {
            return Result.error("用户名已被占用");
        }
    }
}

@Pattern 指定校验格式。

/service/Userservice

package com.heo.service;

import com.heo.pojo.User;

public interface UserService {
    User findByUserName(String username);
    void register(String username, String password);
}

/service/impl/UserServiceImpl

package com.heo.service.impl;

import com.heo.mapper.UserMapper;
import com.heo.pojo.User;
import com.heo.service.UserService;
import com.heo.utils.Md5Util;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;
    @Override
    public User findByUserName(String username) {
        User u = userMapper.findByUserName(username);
        return u;
    }

    @Override
    public void register(String username, String password) {
        String md5String = Md5Util.getMD5String(password);
        userMapper.add(username, md5String);
    }
}

mapper/UserMapper

package com.heo.mapper;

import com.heo.pojo.User;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;

@Mapper
public interface UserMapper {
    @Select("select * from user where username=#{username}")
    User findByUserName(String username);

    @Insert("insert into user(username,password,create_time,update_time) " +
            "values(#{username},#{password},now(),now())")
    void add(String username, String password);
}

实现注册功能时经常遇到参数校验的问题。

在这里插入图片描述

2. 参数校验

引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

参数前添加注解，并指定校验规则
控制器类添加注解

@RestController
@RequestMapping("/user")
@Validated
public class UserController {
    @Autowired
    private UserService userService;
    @PostMapping("/register")
    public Result register(@Pattern(regexp = "^\\S{5,16}$") String username,@Pattern(regexp = "^\\S{5,16}$") String password) {
        User u = userService.findByUserName(username);
        if (u == null) {
            userService.register(username, password);
            return Result.success();
        } else {
            return Result.error("用户名已被占用");
        }

    }
}

@Validated注解添加时机：

类内部方法的参数有 @NotNull ，@NotEmpty 等检验注解，则该类添加@Validated注解
参数是一个 pojo，pojo类里面有 @NotNull ，@NotEmpty 等检验注解，则该参数前面添加@Validated注解

此时还可以校验一下账号不能包含特殊字符：

String validPattern = "[`~!@#$%^&*()+=|{}':;',\\\\[\\\\].<>/?~！@#￥%……&*（）——+|{}【】‘；：”“’。，、？]";

Spring 框架也自带加密：

String encryptPassword = DigestUtils.md5DigestAsHex((SALT + userPassword).getBytes());

2.1 参数校验失败异常处理

全局异常处理器。

/exception/GlobalExceptionHandler

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public Result handleException(Exception e) {
    	// 输出错误信息到控制台
        e.printStackTrace();
        return Result.error(StringUtils.hasLength(e.getMessage()) ? e.getMessage() : "操作失败");
    }
}