SpringBoot实战学习
今天学习的是
- 环境配置
- 注册
- 登录
- 获取用户详细信息
环境配置
1.导入资料中的sql脚本,准备数据库表,注意将数据库设计为utf-8类型
2.创建一个springBoot工程,引入对应的依赖 (web、mybatis、MySQL驱动),注意要配置对应版本的,不然会报各种奇奇怪怪的错误
<!-- mybatis依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- web依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql依赖-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<version>8.0.31</version>
<scope>runtime</scope>
</dependency>
配置文件application.yml中引入mybatis配置信息
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/big_event
username: root
password: 123456
创建包结构,准备实体类
返回类型设置
//无参构造方法
@NoArgsConstructor
//全参构造方法
@AllArgsConstructor
@Data
public class Result<T> {
private Integer code;//业务状态码 0-成功 1-失败
private String message;//提示信息
private T data;//响应数据 使用的是泛型 将来使用的时候,这个data可以对应的是字符串、josn、mapper等等
//快速返回操作成功响应结果(带响应数据)
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);
}
}
注册
基本信息
请求路径:/user/register
请求方式:POST
接口描述:该接口用于注册新用户
请求参数
参数名称 | 说明 | 类型 | 是否必须 | 备注 |
---|---|---|---|---|
username | 用户名 | string | 是 | 5~16位非空字符 |
password | 密码 | string | 是 | 5~16位非空字符 |
响应数据
ode | number | 必须 | 响应码, 0-成功,1-失败 | ||
---|---|---|---|---|---|
message | string | 非必须 | 提示信息 | ||
data | object | 非必须 | 返回的数据 | ||
样例 |
{
"code": 0,
"message": "操作成功",
"data": null
}
代码部分
添加依赖,使用 Spring Validation, 对注册接口的参数进行合法性校验
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
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) {
// 查询用户 使用alt+enter自动生成
User u = userService.findByUserName(username);
System.out.println("==========");
if (u == null) {
userService.register(username, password);
return Result.success();
} else {
// 占用
return Result.error("用户名已被占用");
}
}
}
Mapper
@Mapper
public interface UserMapper {
//根据用户名查询用户
// @Insert("insert into user(username,password,create_time,update_time)" +
// "values (#{username},#{md5String},now(),now()) ")
@Insert("insert into user(username,password,create_time,update_time)" +
"values (#{username},#{md5String},now(),now()) ")
void add(String username, String md5String);
//添加
@Select("select * from user where username = #{username}")
public User findByUserName(String username);
}
参数校验失败异常处理
@RestControllerAdvice
public class GlobalExceptionHandler {
@ExceptionHandler(Exception.class)
public Result handleException(Exception e){
e.printStackTrace();
return Result.error(StringUtils.hasLength(e.getMessage())?e.getMessage():"操作失败");
}
}
Spring Validation总结
登录
准备:
MD5Util工具包
package com.example.bigevent.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);
}
}
jwtUtil
package com.example.bigevent.utils;
import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
import java.util.Date;
import java.util.Map;
public class JwtUtil {
private static final String KEY = "itheima";
//接收业务数据,生成token并返回
public static String genToken(Map<String, Object> claims) {
return JWT.create()
.withClaim("claims", claims)
.withExpiresAt(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 12))
.sign(Algorithm.HMAC256(KEY));
}
//接收token,验证token,并返回业务数据
public static Map<String, Object> parseToken(String token) {
return JWT.require(Algorithm.HMAC256(KEY))
.build()
.verify(token)
.getClaim("claims")
.asMap();
}
}
处理登录信息
@Component
public class LoginInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,Object handler) throws Exception{
String token = request.getHeader("Authorization");
//验证token
try {
Map<String,Object> claims = JwtUtil.parseToken(token);
return true;
} catch (Exception e) {
// http响应状态为401
response.setStatus(401);
return false;
}
}
}
controller
@PostMapping("/login")
public Result<String> login(@Pattern(regexp = "^\\S{5,16}$") String username, @Pattern(regexp = "^\\S{5,16}$") String password) {
// 根据用户名查询用户
User loginUser = userService.findByUserName(username);
// 判断该用户是否存在
if (loginUser == null) {
return Result.error("用户名错误");
}
// 判断密码是否正确,loginUser对象中的password是密文
if (Md5Util.getMD5String(password).equals(loginUser.getPassword())) {
//登录成功
Map<String, Object> claims = new HashMap<>();
claims.put("id", loginUser.getId());
claims.put("username", loginUser.getUsername());
String token = JwtUtil.genToken(claims);
return Result.success(token);
}
return Result.error("密码错误");
}