基于SpringBoot使用JWT实现Token认证
目录
一、JWT的介绍
1、什么是JWT
2、、基于token的鉴权机制
3、JWT的构成
二、简单实战
1、新建一个简单的springboot项目
2、自定义登录异常处理
3、全局异常拦截处理输出
4、创建工具类
5、token的生成和拦截
三、参考文献
一、JWT的介绍
1、什么是JWT
Json web token（JWT）是为了网络应用环境间传递声明而执行的一种基于JSON的开发标准（RFC 7519），该token被设计为紧凑且安全的，特别适用于分布式站点的单点登陆（SSO）场景。JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源，也可以增加一些额外的其它业务逻辑所必须的声明信息，该token也可直接被用于认证，也可被加密。
2、、基于token的鉴权机制
基于token的鉴权机制类似于http协议也是无状态的，它不需要在服务端去保留用户的认证信息或会话信息。这也就意味着机遇tokent认证机制的应用不需要去考虑用户在哪一台服务器登陆了，这就为应用的扩展提供了便利
流程是这样的
- 用户使用用户名密码请求服务器
- 服务器进行验证用户信息
- 服务器通过验证发送给用户一个token
- 客户端存储token，并在每次请求时附加这个token值
- 服务器验证token，并返回数据
这个token必须要在每次请求时发送给服务器，它应该保存在请求头中，另外，服务器要支持CORS（跨来源资源共享）策略，一般我们在服务端这么做就可以了 Access-Control-Allow-Origin：*
3、JWT的构成
JWT是由三部分构成，将这三段信息文本用链接构成了JWT字符串。就像这样
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJVc2VySWQiOjEyMywiVXNlck5hbWUiOiJhZG1pbiJ9.Qjw1epD5P6p4Yy2yju3-fkq28PddznqRj3ESfALQy_U第一部分我们称它为头部（header）第二部分我们称其为载荷（payload，类似于飞机上承载的物品），第三部分是签证（signature）
header
JWT的头部承载的两部分信息：
- 声明类型，这里是jwt
- 声明加密的算法，通常直接使用HMAC SHA256
完整的头部就像下面这样的JSON
{
'typ':'JWT',
'alg':'HS256'
}然后将头部进行base64加密（该加密是可以对称解密的），构成了第一部分
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9plyload
载荷就是存放有效信息的地方。这个名字像是特指飞机上承载的货品，这些有效信息包含三个部分
- 标准中注册的声明
- 公共的声明
- 私有的声明
标注中注册的声明（建议不强制使用）
- iss：jwt签发者
- sub：jwt所面向的用户
- aud：接收jwt的一方
- exp：jwt的过期时间，这个过期时间必须大于签发时间
- nbf：定义在什么时间之前，该jwt都是不可用的
- iat：jwt的签发时间
- jti：jwt的唯一身份标识，主要用来作为一次性token，从而回避重放攻击
公共的声明：
公共的声明可以添加任何的信息，一般添加用户的相关信息或其它业务需要的必要信息，但不建议添加敏感信息，因为该部分在客户端可解密；
私有的声明
私有的声明是提供者和消费者功能定义的声明，一般不建议存放敏感信息，因为base64是对称解密的，意味着该部分信息可以归类为名文信息。
定义一个payload
{
"sub": "1234567890",
"name": "John Doe",
"admin": true
}然后将其base64加密，得到jwt的一部分
eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9Signature
jwt的第三部分是一个签证信息，这个签证信息由三部分组成：
- header(base64后的)
- payload(base64后的)
- secred
这个部分需要base64加密后的header和base64加密后的payload使用“.”连接组成的字符串，然后通过header中声明的加密方式进行加secret组合加密，然后就构成了jwt的第三部分
var encodedString = base64UrlEncode(header) + '.' + base64UrlEncode(payload);
var signature = HMACSHA256(encodedString, 'secret'); // TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ将这三部分用“.”连接成一个完整的字符串，构成了最终的jwt：
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ注意：secret是保存在服务器端的，jwt的签发也是在服务端的，secret就是用来进行jwt的签发和jwt的验证，所以它就是你服务端的私钥，在任何场景都不应该流露出去，一旦客户端得知这个secret，那就意味着客户端可以自我签发jwt了
应用
一般是在请求头里加入Authorization，并加上 Bearer 标注：
fetch('api/user/1', {
headers: {
'Authorization': 'Bearer ' + token
}
})优点：
- 因为json的通用性，所以JWT是可以跨语言支持的，像C#，JavaScript，NodeJS，PHP等许多语言都可以使用
- 因为由了payload部分，所以JWT可以在自身存储一些其它业务逻辑所必要的非敏感信息
- 便于传输，jwt的构成非常简单，字节占用很小，所以它是非常便于传输的
- 它不需要在服务端保存会话信息，所以它易于应用的扩展
安全相关
- 不应该在jwt的payload部分存储敏感信息，因为该部分是客户端可解密的部分
- 保护好secret私钥。该私钥非常重要
- 如果可以，请使用https协议
二、简单实战
1、新建一个简单的springboot项目
来源于之前一篇 SpringBoot 整合 Mybatis 的基础上改造
引入 jwt ， jwt用于token管理。
io.jsonwebtoken
jjwt
0.9.0
2、自定义登录异常处理
UserLoginException
/**
* 自定义登录异常
*/
public class UserLoginException extends RuntimeException {
private static final long serialVersionUID = 6958499248468627021L;
/** 错误码 */
private String errorCode;
/** 错误上下文 */
private ErrorContext errorContext;
public UserLoginException(String errorCode, String errorMsg){
super(errorMsg);
this.errorCode = errorCode;
}
public UserLoginException(SystemCodeAndMsg systemCodeAndMsg){
super(systemCodeAndMsg.getMsg());
this.errorCode = systemCodeAndMsg.getCode();
}
public UserLoginException(String errorCode, String errorMsg,Throwable throwable){
super(errorMsg,throwable);
this.errorCode = errorCode;
}
public UserLoginException(SystemCodeAndMsg systemCodeAndMsg,Throwable throwable){
super(systemCodeAndMsg.getMsg(),throwable);
this.errorCode = systemCodeAndMsg.getCode();
}
/**
* Getter method for property errorCode.
*
* @return property value of errorCode
*/
public String getErrorCode() {
return errorCode;
}
/**
* Setter method for property errorCode.
*
* @param errorCode value to be assigned to property errorCode
*/
public void setErrorCode(String errorCode) {
this.errorCode = errorCode;
}
/**
* Getter method for property errorContext.
*
* @return property value of errorContext
*/
public ErrorContext getErrorContext() {
return errorContext;
}
/**
* Setter method for property errorContext.
*
* @param errorContext value to be assigned to property errorContext
*/
public void setErrorContext(ErrorContext errorContext) {
this.errorContext = errorContext;
}
}
3、全局异常拦截处理输出
ExceptionConfig
/**
* 全局异常拦截
*/
@RestControllerAdvice
public class ExceptionConfig {
private static final Logger logger = LoggerFactory.getLogger(ExceptionConfig.class);
@ExceptionHandler(value = Exception.class)
public Message handleException(Exception e) {
// 自定义异常
if (e instanceof UserLoginException) {
UserLoginException userLoginException = (UserLoginException) e;
return new Message(userLoginException.getErrorCode(), userLoginException.getMessage());
}else {
logger.error("【系统异常】{}", e);
return new Message(SystemCodeAndMsg.SYSTEM_ERROR.getCode(), SystemCodeAndMsg.SYSTEM_ERROR.getMsg());
}
}
}
4、创建工具类
JwtTokenUtil
/**
* tokenTool
* @author leopard
*
*/
public class JwtTokenUtil {
public static final String TOKEN_HEADER = "Authorization";
public static final String TOKEN_PREFIX = "Bearer ";
private static final String SECRET = "jwtsecretdemo";
private static final String ISS = "leopard";
// 过期时间是3600秒，既是1个小时
public static final long EXPIRATION = 3600L;
// 选择了记住我之后的过期时间为7天
public static final long EXPIRATION_REMEMBER = 604800L;
/**
* 创建token
* 注：如果是根据可变的唯一值来生成，唯一值变化时，需重新生成token
* @param username
* @param isRememberMe
* @return
*/
public static String createToken(String id, String username, boolean isRememberMe) {
long expiration = isRememberMe ? EXPIRATION_REMEMBER : EXPIRATION;
//可以将基本不重要的对象信息放到claims中，此处信息不多,见简单直接放到配置内
// HashMap claims = new HashMap();
// claims.put("id", id);
// claims.put("username",username);
//id是重要信息，进行加密下
String encryId = RCUtils.encry_string(id);
return Jwts.builder()
.signWith(SignatureAlgorithm.HS512, SECRET)
// 这里要早set一点，放到后面会覆盖别的字段
// .setClaims(claims)
.setIssuer(ISS)
.setId(encryId)
.setSubject(username)
.setIssuedAt(new Date())
.setExpiration(new Date(System.currentTimeMillis() + expiration * 1000))
.compact();
}
/**
* 从token中获取用户名
* @param token
* @return
*/
public static String getUsername(String token){
return getTokenBody(token).getSubject();
}
/**
* 从token中获取ID，同时做解密处理
* @param token
* @return
*/
public static String getObjectId(String token){
return RCUtils.decry(getTokenBody(token).getId());
}
/**
* 是否已过期
* @param token
* @throws 过期无法判断，只能通过捕获ExpiredJwtException异常
* @return
*/
@Deprecated
public static boolean isExpiration(String token){
return getTokenBody(token).getExpiration().before(new Date());
}
/**
* 获取token信息，同时也做校验处理
* @param token
* @throws 自定义UserLoginException异常处理
* @return
*/
public static Claims getTokenBody(String token){
try{
return Jwts.parser()
.setSigningKey(SECRET)
.parseClaimsJws(token)
.getBody();
}catch(ExpiredJwtException expired){
//过期
throw new UserLoginException(SystemCodeAndMsg.TOKEN_EXPIRED);
}catch (SignatureException e){
//无效
throw new UserLoginException(SystemCodeAndMsg.INVALID_REQUEST);
}catch(MalformedJwtException malformedJwt){
//无效
throw new UserLoginException(SystemCodeAndMsg.INVALID_REQUEST);
}
}
}
5、token的生成和拦截
准备工作做完后，重点开始，获取配置在token内的信息
新建 BaseController 之后的token信息获取可以统一处理获取ID，也可以添加其他方法，获取配置在token内部的其他信息
public class BaseController {
/**
* 根据token获取用户ID
*
* @param request
* @return
*/
public String getUserId(HttpServletRequest request) {
// 取得token
String tokenHeader = request.getHeader(JwtTokenUtil.TOKEN_HEADER);
tokenHeader = tokenHeader.replace(JwtTokenUtil.TOKEN_PREFIX, "");
return JwtTokenUtil.getObjectId(tokenHeader);
}
}第一步生成，用户信息登录验证成功后，获取token放在请求头，返回给客户端
@RestController
@RequestMapping(value = "/admin/adminUser")
public class AdminUserController extends BaseController{
@Autowired
private AdminUserServiceImpl adminUserServiceImpl;
/**
* 查询管理用户名
*
* @param name
* @return
*/
@RequestMapping(value = "/adminLogin", method = RequestMethod.POST)
public Message adminLogin(HttpServletResponse response, String userName,String password) {
//此次简单处理，直接用登录名查找对象，不验证密码
AdminUser adminUser = adminUserServiceImpl.findAdminUserByAdminAccount(userName);
String token = JwtTokenUtil.createToken(adminUser.getId(), adminUser.getAdminName(), false);
//放到响应头部
response.setHeader(JwtTokenUtil.TOKEN_HEADER, JwtTokenUtil.TOKEN_PREFIX + token);
return new Message(SystemCodeAndMsg.SUCCESS.getCode(),SystemCodeAndMsg.SUCCESS.getMsg(),adminUser);
}
/**
* 退出
*
* @param name
* @return
*/
@RequestMapping(value = "/adminLoginOut", method = RequestMethod.POST)
public Message adminLoginOut(HttpServletRequest request) {
String userId = getUserId(request);
adminUserServiceImpl.removeAdminUserLoginInfo(userId);
return new Message(SystemCodeAndMsg.SUCCESS.getCode(),SystemCodeAndMsg.SUCCESS.getMsg());
}
}
访问：http://172.16.60.187:8081/admin/adminUser/adminLogin
先来看下测试结果，数据库本身有数据，直接测试后用postman请求，可以看到，效果如下，成功获取token.
第二步就是拦截并验证token
先配置我们的拦截器 JwtInterceptor
/**
* token验证拦截
*/
public class JwtInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
// 取得token
String tokenHeader = request.getHeader(JwtTokenUtil.TOKEN_HEADER);
if (tokenHeader == null || !tokenHeader.startsWith(JwtTokenUtil.TOKEN_PREFIX)) {
throw new UserLoginException(SystemCodeAndMsg.TOKEN_INEXISTENCE);
}
tokenHeader = tokenHeader.replace(JwtTokenUtil.TOKEN_PREFIX, "");
// 验证token是否有效--无效已做异常抛出，由全局异常处理后返回对应信息
JwtTokenUtil.getTokenBody(tokenHeader);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
// TODO Auto-generated method stub
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
throws Exception {
// TODO Auto-generated method stub
}
}
再创建 WebConfig 实现 WebMvcConfigurer 将拦截器配置进来。
@Configuration
public class WebConfig implements WebMvcConfigurer {
/**
* 添加拦截器
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
//拦截路径可自行配置多个 可用 ，分隔开
registry.addInterceptor(new JwtInterceptor()).addPathPatterns("/admin/adminUser/adminLoginO**");
}
/**
* 跨域支持
*
* @param registry
*/
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowCredentials(true)
.allowedMethods("GET", "POST", "DELETE", "PUT")
.maxAge(3600 * 24);
}
/**
* 配置消息转换器--这里用的是alibaba 开源的 fastjson
*
* @param converters
*/
@Override
public void configureMessageConverters(List> converters) {
//1.需要定义一个convert转换消息的对象;
FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
//2.添加fastJson的配置信息，比如：是否要格式化返回的json数据;
FastJsonConfig fastJsonConfig = new FastJsonConfig();
fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,
SerializerFeature.WriteMapNullValue,
SerializerFeature.WriteNullStringAsEmpty,
SerializerFeature.DisableCircularReferenceDetect,
SerializerFeature.WriteNullListAsEmpty,
SerializerFeature.WriteDateUseDateFormat);
//3处理中文乱码问题
List fastMediaTypes = new ArrayList<>();
fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
//4.在convert中添加配置信息.
fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
//5.将convert添加到converters当中.
converters.add(fastJsonHttpMessageConverter);
}
//这里暂时先展示主要使用的实现方法，关于WebMvcConfigurer 其他方法实现和实际应用，请自行搜寻
}
接下来开始测试我们的拦截效果，
先来试访问不带token： http://172.16.60.187:8081/admin/adminUser/adminLoginOut
再来访问下带之前登录生成的token：url同上
到此可用看到使用JWT进行token成功。
三、参考文献
SpringBoot集成JWT实现token验证
Springboot+Spring-Security+JWT+Redis实现restful Api的权限管理以及token管理（超详细用爱发电版）