如何在SpringBoot项目中使用JWT实现接口鉴权功能

最新推荐文章于 2024-09-05 17:59:05 发布

francis_zl

最新推荐文章于 2024-09-05 17:59:05 发布

阅读量3.2k

点赞数 4

文章标签： JWT springboot

本文链接：https://blog.csdn.net/qq_38306688/article/details/88643545

版权

一、简介JWT：

JWT由Header（请求头）、Payload（携带的用户信息）、Signature（加密后生成的签名）三部分组成，也就是我们用过JWT所眼熟的header.payload.signature。JWT可以自定义Signing Key，能够有效的防止伪造或篡改token签名。

二、思考：

为什么要接口鉴权？怎样的业务场景下需要使用鉴权功能？

1：客户端登录后可操作内容鉴权：打个比方，评论是很常见的业务功能，那么在评论之前客户端需校验用户是否登录，这个时候我们就可以通过使用jwt产生的token来判断用户的登录状态，登录后才会返回token，客户端请求，服务端校验。

2：登录状态过期校验：当然有了登录过后也得有登录过期，JWT可以很简便的设置token expire时间，服务端配置每次都自动校验token是否过期，如果过期就直接抛出异常，客户端需要重新登录申请token。

3：Restful Api 的身份认证：业务接口必须要使用身份验证才允许访问。

三、实践

1. 导入jwt的maven依赖

<dependency>
	<groupId>io.jsonwebtoken</groupId>
	<artifactId>jjwt</artifactId>
	<version>0.7.0</version>
</dependency>

2. 新建JwtHelper类

生定义生成sign key:

public static SecretKey generalKey(){
        byte[] encodedKey = Base64.decodeBase64("francis1q2we3");//自定义
        SecretKey key = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
        return key;
    }

创建jwt ,claim为自定义加密参数（可以吧用户id 或者用户昵称加入里面）。

/**
 * 创建JWT
 */
public static String createJWT(String name, String userId,
			long TTLMillis) {
	SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;

	long nowMillis = System.currentTimeMillis();
	Date now = new Date(nowMillis);
	// 添加构成JWT的参数
	JwtBuilder builder = Jwts.builder().setHeaderParam("typ", "JWT")
			.claim("nickName", name)
			.claim("memId", userId)
			.setIssuer("francis")//发行者，自定义
                        .setAudience("client")
			.signWith(signatureAlgorithm, generalKey());
	// 添加Token过期时间
	if (TTLMillis >= 0) {
		long expMillis = nowMillis + TTLMillis;
		Date exp = new Date(expMillis);
		builder.setExpiration(exp).setNotBefore(now);
	}
	// 生成JWT
	return builder.compact();
}

解析token：

public static Claims parseJWT(String jsonWebToken) {
	try {
		Claims claims = Jwts.parser().setSigningKey(generalKey())
				.parseClaimsJws(jsonWebToken).getBody();
		return claims;
	} catch (Exception ex) {
		System.out.println(ex);
		return null;
	}
}

从解析的JWT中获取参与加密的claims

public static Integer getUserId(String jsonWebToken){
	jsonWebToken = jsonWebToken.substring(7, jsonWebToken.length());
	Claims claims = parseJWT(jsonWebToken);
	return Integer.parseInt(claims.get("memId").toString());
}

public static String getNickName(String jsonWebToken){
	jsonWebToken = jsonWebToken.substring(7, jsonWebToken.length());
	Claims claims = parseJWT(jsonWebToken);
	return Integer.parseInt(claims.get("nickName").toString());
}

3. 添加JwtFilter过滤器检验token

package com.francis.api.config.jwt;

import java.io.IOException;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.filter.GenericFilterBean;

import com.feilong.core.Validator;
import com.xj.api.util.JsonUtil;
import com.xj.api.util.JwtHelper;
import com.xj.common.base.common.bean.Result;
import com.xj.common.base.common.exception.EnumSvrResult;
import com.xj.common.bussiness.member.entity.QMember;

public class JwtFilter extends GenericFilterBean {
	
	@Override
	public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
			throws IOException, ServletException {
		HttpServletRequest request = (HttpServletRequest) req;
		HttpServletResponse response = (HttpServletResponse) res;
		if("OPTIONS".equals(request.getMethod())){//预请求直接通行
			chain.doFilter(request, response);
			return;
		}
		String auth = request.getHeader("token");
		if ((auth != null) && (auth.length() > 7)) {
			String headStr = auth.substring(0, 6).toLowerCase();
			if (headStr.compareTo("bearer") == 0) { //按照国际惯例，客户端在发送token的时候需要告知来人，所以在token前面加上的“bearer;”,这里下步进行token校验时需要分离出来。
				auth = auth.substring(7, auth.length());
				System.out.println(auth);
				if (JwtHelper.parseJWT(auth) != null) {
					chain.doFilter(request, response);
					return;
				}
			}
		}
		response.setCharacterEncoding("UTF-8");    
		response.setContentType("application/json; charset=utf-8");   
		response.setStatus(HttpServletResponse.SC_OK);  
		response.getWriter().write(JsonUtil.getJsonFromObject(new Result(EnumSvrResult.ERROR_TOKEN)));  //自定义的token无效或不存在的返回异常
        return;  
	}
	
}

4. JwtConfig 用来定义需过滤那些接口。本文定义过滤后缀为“.auth”的接口。

package com.francis.api.config.jwt;

import java.util.ArrayList;
import java.util.List;

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration  
public class JwtConfig {
	
 	@Bean  
    public FilterRegistrationBean basicFilterRegistrationBean(){  
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();  
        registrationBean.setFilter(new JwtFilter);  
          
        List<String> urlPatterns = new ArrayList<>();  
        urlPatterns.add("*.auth");  
        registrationBean.setUrlPatterns(urlPatterns);  
        return registrationBean;  
    } 
 	
}

5. 获取token，登录成功后调用createJWT方法传入对应参数及失效时间（毫秒），即可生成token返回给客户端。