【SpringBoot】实战-开发接口-用户-注册
注册
界面
接口文档
总体思路
代码编写
1.实体类
通过查看接口文档,我们可以看出响应数据都有都包含code,message,data三个属性,所以建立result实体类
package com.zwh.bojo;import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;//统一响应结果
@NoArgsConstructor//创建没有参数的构造函数
@AllArgsConstructor//创建全参数的构造函数
public class Result<T> {private Integer code;//业务状态码 0-成功 1-失败private String message;//提示信息private T data;//响应数据 泛型//快速返回操作成功响应结果(带响应数据)public static <E> Result<E> success(E data) {return new Result<>(0, "操作成功", data);}//快速返回操作成功响应结果public static Result success() {return new Result(0, "操作成功", null);}public static Result error(String message) {return new Result(1, message, null);}
}
2.Controller(控制器)类
package com.zwh.controller;import com.zwh.bojo.Result;
import com.zwh.bojo.User;
import com.zwh.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
@RequestMapping("/user")
public class UserController {@Autowiredprivate UserService userService;@PostMapping("/register")public Result register(String username, String password) {//查询用户User user = userService.findByUsername(username);//注册if (user == null) {userService.register(username, password);return Result.success();}else {return Result.error("注册失败:用户名已经被占用");}}
}
3.Service接口类
package com.zwh.service;import com.zwh.bojo.User;public interface UserService {public User findByUsername(String username);public void register(String username, String password);
}
4.Impl接口实现
package com.zwh.service.impl;import com.zwh.bojo.User;
import com.zwh.mapper.UserMapper;
import com.zwh.service.UserService;
import com.zwh.utils.Md5Util;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;@Service
public class UserServiceImpl implements UserService {@Autowiredprivate UserMapper userMapper;//根据用户名查询对象@Overridepublic User findByUsername(String username) {User user = userMapper.findByUsername(username);return user;}@Overridepublic void register(String username, String password) {//加密String passwordMd5 = Md5Util.getMD5String(password);//添加userMapper.register(username,passwordMd5);}
}
5.Mapper类
package com.zwh.mapper;import com.zwh.bojo.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 public.user where username = #{username}")User findByUsername(String username);@Insert("insert into public.user(username,password,create_time,update_time) values(#{username},#{password},now(),now())" )void register(String username, String password);
}
6.工具类
package com.zwh.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);}}
测试
由于没有前端页面,需要其他工具来进行测试(apifox或者postman)
406问题:是因为Result没有添加Data注解,就没办法生成getter和setter方法以及tostring方法,result转json字符串的时候就不知道怎么转换了。
解决后测试
小结
参数校验
但是以上方法比较繁琐
参数校验框架
Spring Validation 是Spring提供的一个参数校验框架,使用预定义的注解完成参数校验
使用步骤
全局异常处理器
处理参数校验失败异常处理