Java实现JWT登录认证的示例代码
作者：TimberWill
Java中我们可以使用诸如JJWT这样的库来生成和验证JWT,本文主要介绍了Java实现JWT登录认证的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
什么是JWT?
JWT（Json Web Token），简单来说就是：web领域中基于json格式的令牌。是最常用的令牌规范。
- 第一部分：Header（头），指定了令牌的签名算法、令牌类型。
- 第二部分：Payload（有效载荷），使用Base64来编码的，不是加密算法，能够解码。因此，该部分不适合存放用户的私密信息（如：密码）。
- 第三部分：Signature（签名），将第一部分和第二部分通过密钥加密得到。
解析Token可以根据第三部分解密得到前两部分的信息，再比对前端传来的用户信息，完成校验。
Token验证失败的情况？
token过期
密钥不正确
篡改了头部、载荷等
为什么需要令牌?
- 承载了一定的数据信息，减少数据库访问次数
- 具有一定的防伪功能
如何实现?
该部分代码不需要硬记，理解后直接使用即可。
添加依赖：
<dependency>
<groupId>io.jsonwebtoken</groupId>
<artifactId>jjwt</artifactId>
<version>0.9.1</version>
</dependency>
JwtUtils.java（生成、解析Token的工具类）
public class JwtUtil {
/**
* 生成Token
* @param secretKey
* @param ttlMillis
* @param claims
* @return
*/
public static String createToken(String secretKey, long ttlMillis, Map<String, Object> claims) {
// 指定签名的时候使用的签名算法，也就是header那部分
SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
// 生成token的过期时间
long expMillis = System.currentTimeMillis() + ttlMillis;
Date exp = new Date(expMillis);
// 设置jwt的body
JwtBuilder builder = Jwts.builder()
// 如果有私有声明，一定要先设置这个自己创建的私有的声明，这个是给builder的claim赋值，一旦写在标准的声明赋值之后，就是覆盖了那些标准的声明的
.setClaims(claims)
// 设置签名使用的签名算法和签名使用的秘钥
.signWith(signatureAlgorithm, secretKey.getBytes(StandardCharsets.UTF_8))
// 设置过期时间
.setExpiration(exp);
return builder.compact();
}
/**
* 解析token
* @param secretKey
* @param token
* @return
*/
public static Claims parseToken(String secretKey, String token) {
// 得到DefaultJwtParser
Claims claims = Jwts.parser()
// 设置签名的秘钥
.setSigningKey(secretKey.getBytes(StandardCharsets.UTF_8))
// 设置需要解析的jwt
.parseClaimsJws(token).getBody();
return claims;
}
}
jwt配置：
application.yaml：
user:
jwt:
# 设置jwt签名加密时使用的秘钥
user-secret-key: xxx
# 设置jwt过期时间
user-ttl: 7200000
# 设置前端传递过来的令牌名称
user-token-name: token
JwtProperties：
@Component
@ConfigurationProperties(prefix = "user.jwt")
@Data
public class JwtProperties {
private String userSecretKey;
private long userTtl;
private String userTokenName;
}
JwtClaimsConstant（管理常量）：
public class JwtClaimsConstant {
public static final String USER_ID = "userId";
}
jwt拦截器：
@Component
@Slf4j
public class JwtInterceptor implements HandlerInterceptor {
@Resource
private JwtProperties jwtProperties;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
//1. 获取用户信息
String token = request.getHeader(jwtProperties.getUserTokenName());
//2. 判断用户信息是否有效，存入ThreadLocal
try {
Claims claims = JwtUtil.parseToken(jwtProperties.getUserSecretKey(), token);
String userInfo = claims.get(JwtClaimsConstant.USER_ID).toString();
if (StrUtil.isNotBlank(userInfo)){
UserContext.setUser(Long.valueOf(userInfo));
}
//3. 放行
return true;
}catch (Exception e){
//4. 不通过
response.setStatus(401);
return false;
}
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
//清除用户信息
UserContext.removeUser();
}
}
WebMvc配置（添加jwt拦截器）
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Resource
private JwtInterceptor jwtInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(jwtInterceptor)
.addPathPatterns("/user/**")
.excludePathPatterns("/user/user/login");
}
}
UserContext（存储用户登录信息，方便其他业务需求获取）
public class UserContext {
private static final ThreadLocal<Long> threadLocal = new ThreadLocal<>();
/**
* 获取用户信息
* @return
*/
public static Long getUser() {
return threadLocal.get();
}
/**
* 设置用户信息
* @param userId
*/
public static void setUser(Long userId){
threadLocal.set(userId);
}
/**
* 移除用户信息
*/
public static void removeUser(){
threadLocal.remove();
}
}
登录业务逻辑：
controller层：
@RestController
@RequestMapping("/user/user")
@Slf4j
public class UserController {
@Resource
private UserService userService;
@PostMapping("/login")
public UserLoginVO login(@RequestBody UserLoginDTO userLoginDTO){
log.info("用户登录：{}",userLoginDTO);
return userService.login(userLoginDTO);
}
}
service层：
public interface UserService {
UserLoginVO login(UserLoginDTO userLoginDTO);
}
@Service
@Slf4j
public class UserServiceImpl implements UserService {
@Resource
private UserMapper userMapper;
@Resource
private JwtProperties jwtProperties;
@Override
public UserLoginVO login(UserLoginDTO userLoginDTO) {
String username = userLoginDTO.getUsername();
String password = userLoginDTO.getPassword();
//1. 校验用户名和密码
UserLogin userLogin = userMapper.getUserByName(username);
if (userLogin == null){
throw new BaseException("用户名或密码错误");
}
password = DigestUtils.md5DigestAsHex(password.getBytes());
if (!password.equals(userLogin.getPassword())){
throw new BaseException("用户名或密码错误");
}
//2. 生成token
HashMap<String, Object> claims = new HashMap<>();
claims.put(JwtClaimsConstant.USER_ID, userLogin.getId());
String token = JwtUtil.createToken(
jwtProperties.getUserSecretKey(),
jwtProperties.getUserTtl(),
claims);
//3. 封装vo
UserLoginVO loginVO = UserLoginVO.builder()
.token(token)
.userId(userLogin.getId())
.username(userLogin.getUsername())
.build();
return loginVO;
}
}
mapper层：
@Mapper
public interface UserMapper {
UserLogin getUserByName(String username);
}
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.sky.user.mapper.UserMapper">
<select id="getUserByName" resultType="com.sky.user.pojo.entity.UserLogin">
select *
from user_login where username = #{username} and is_delete = 0;
</select>
</mapper>
其他关联代码：
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserLoginDTO {
/**
* 用户名
*/
private String username;
/**
* 密码
*/
private String password;
}
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserLoginVO {
private String token;
private Long userId;
private String username;
}
测试：
登录接口：
其他接口：
到此这篇关于Java实现JWT登录认证的示例代码的文章就介绍到这了,更多相关Java JWT登录认证内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！