JWT在SPA项目开发中的使用

在传统的jsp开发中，要对系统的资源进行保护，那么会用到session机制里完成，但session是跟随Tomcat存在的，也就是说session是在前后端分离中的后端服务器里面，而现在浏览器请求的却是前端服务器（node.js），这也就意味着在浏览器输入网址（路由跳组件）的时候，它并不能获取到session，所以目前存在的问题是：不进行登录也能对其他组件进行访问，在本例中，意味着不登录也能访问MainApp.vue

这时就需要另一种机制来解决身份验证的问题， 它就是JWT（JSON Web Token ），它是目前最流行的跨域身份验证解决方案。当登录成功后，会在后端生成一个token令牌（jwt）并将令牌返回给前端服务器，然后每次请求其他路由的时候，在请求头（Request Headers）中携带jwt到后端服务器进行校验，如果通过，则进行业务处理

前端处理重点代码如图：

注：每次刷新浏览器时state里变量的值都会变为默认值，然后会导致传给后端的jwt为null，接着就会请求不到想要的资源，我这里的处理方法是将后端返回的jwt先存到localStorage里面，然后再改变state，取jwt的时候也先从localStorage里面取，取不到才将jwt赋为null，需要注意的是存在localStorage里的数据是没有时间期限的，除非将它移除，所以在退出登录的时候要记得把jwt从localStorage里面移除掉

1、为什么要使用JWT

JWT的精髓在于：“去中心化”，即数据是保存在客户端的

2、JWT的工作原理

在服务器身份验证之后，将生成一个JSON对象并将其发送回用户，示例如下：

{"UserName": "Chongchong","Role": "Admin","Expire": "2018-08-08 20:15:56"}

之后，当用户与服务器通信时，客户在请求中发回JSON对象，为了防止用户篡改数据，服务器将在生成对象时添加签名，并对发回的数据进行验证

3、JWT的组成

一个JWT实际上就是一个字符串，它由三部分组成：头部(Header)、载荷(Payload)与签名(signature)，它是一个很长的字符串，中间用点（.）分隔成三个部分。注意，JWT内部是没有换行的，写成一行，就是下面的样子：Header.Payload.Signature

a、Header

{"typ":"JWT","alg":"HS256"}

这个json中的typ属性，是用来标识整个token字符串是一个JWT字符串；它的alg属性，是用来说明这个JWT签发的时候所使用的签名和摘要算法，typ跟alg属性的全称其实是type跟algorithm，分别是类型跟算法的意思。之所以都用三个字母来表示，也是基于JWT最终字串大小的考虑，同时也是跟JWT这个名称保持一致，这样就都是三个字符了，typ跟alg是JWT标准中规定的属性名称

b、Payload(负荷)

{"sub":"123","name":"Tom","admin":true}

payload用来承载要传递的数据，它的json结构实际上是对JWT要传递的数据的一组声明，这些声明被JWT标准称为claims，它的一个“属性值对”其实就是一个claim(要求)，每一个claim都代表特定的含义和作用。

      注1：英文“claim”就是要求的意思

      注2：如上面结构中的sub代表这个token的所有人，存储的是所有人的ID；name表示这个所有人的名字；admin表示所有人是否管理员的角色，当后面对JWT进行验证的时候，这些claim都能发挥特定的作用

      注3：根据JWT的标准，这些claims可以分为以下三种类型：

           A. Reserved claims(保留)

它的含义就像是编程语言的保留字一样，属于JWT标准里面规定的一些claim。JWT标准里面定义好的claim有：

              iss(Issuser)：代表这个JWT的签发主体；

              sub(Subject)：代表这个JWT的主体，即它的所有人；

              aud(Audience)：代表这个JWT的接收对象；

              exp(Expiration time)：是一个时间戳，代表这个JWT的过期时间；

              nbf(Not Before)：是一个时间戳，代表这个JWT生效的开始时间，意味着在这个时间之前验证JWT是会失败的；

              iat(Issued at)：是一个时间戳，代表这个JWT的签发时间；

              jti(JWT ID)：是JWT的唯一标识。

           B. Public claims，略（不重要）

           C. Private claims(私有)

这个指的就是自定义的claim，比如前面那个示例中的admin和name都属于自定的claim，这些claim跟JWT标准规定的claim区别在于：JWT规定的claim，JWT的接收方在拿到JWT之后，都知道怎么对这些标准的claim进行验证；而private claims不会验证，除非明确告诉接收方要对这些claim进行验证以及规则才行

按照JWT标准的说明：保留的claims都是可选的，在生成payload不强制用上面的那些claim，你可以完全按照自己的想法来定义payload的结构，不过这样搞根本没必要：第一是，如果把JWT用于认证， 那么JWT标准内规定的几个claim就足够用了，甚至只需要其中一两个就可以了，假如想往JWT里多存一些用户业务信息，比如角色和用户名等，这倒是用自定义的claim来添加；第二是，JWT标准里面针对它自己规定的claim都提供了有详细的验证规则描述，每个实现库都会参照这个描述来提供JWT的验证实现，所以如果是自定义的claim名称，那么你用到的实现库就不会主动去验证这些claim

c、signature

签名是把header和payload对应的json结构进行base64url编码之后得到的两个串用英文句点号拼接起来，然后根据header里面alg指定的签名算法生成出来的,算法不同，签名结果不同。以alg: HS256为例来说明前面的签名如何来得到，按照前面alg可用值的说明，HS256其实包含的是两种算法：HMAC算法和SHA256算法，前者用于生成摘要，后者用于对摘要进行数字签名，这两个算法也可以用HMACSHA256来统称  

4、JWT的验证过程

它验证的方法其实很简单，只要把header做base64url解码，就能知道JWT用的什么算法做的签名，然后用这个算法，再次用同样的逻辑对header和payload做一次签名，并比较这个签名是否与JWT本身包含的第三个部分的串是否完全相同，只要不同，就可以认为这个JWT是一个被篡改过的串，自然就属于验证失败了，接收方生成签名的时候必须使用跟JWT发送方相同的密钥

注1：在验证一个JWT的时候，签名认证是每个实现库都会自动做的，但是payload的认证是由使用者来决定的。因为JWT里面可能会包含一个自定义claim，所以它不会自动去验证这些claim，以jjwt-0.7.0.jar为例：

        A.如果签名认证失败会抛出如下的异常：

          io.jsonwebtoken.SignatureException: JWT signature does not match locally computed signature. JWT validity cannot be asserted and should not be trusted，即签名错误，JWT的签名与本地计算机的签名不匹配

        B.JWT过期异常：

          io.jsonwebtoken.ExpiredJwtException: JWT expired at 2017-06-13T11:55:56Z. Current time: 2017-06-13T11:55:57Z, a difference of 1608 milliseconds.  Allowed

注2：认证失败，返回401 Unauthorized响应

注3：认证服务作为一个Middleware HOOK对请求进行拦截，首先在cookie中查找Token信息，如果没有找到，则在HTTP Authorization Head中查找

5、JWT令牌刷新思路

登陆成功后，将生成的JWT令牌通过响应头返回给客户端，WEB APP项目每次请求后台数据时将JWT令牌从请求头中带过来，验证通过，则刷新JWT，并保存在响应头返回给客户端，有效时间30分钟

注：原来在默认的请求上， 浏览器只能访问以下默认的响应头Cache-Control、Content-Language、 Content-Type、Expires、Last-Modified、Pragma，如果想让浏览器能访问到其他的响应头的话，需要在服务器上设置Access-Control-Expose-Headers，如下图（springboot）：

使用jwt所需pom依赖：

	io.jsonwebtoken
	jjwt
	0.9.1


	com.auth0
	java-jwt
	3.4.0

JwtInterceptor.java（拦截器）代码： 

package com.ue.Interceptor;

import com.alibaba.fastjson.JSONObject;
import com.ue.result.Result;
import com.ue.util.JwtUtils;
import io.jsonwebtoken.Claims;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.OutputStream;

import static com.ue.result.CodeMsg.JWT_NONE;
import static com.ue.util.JwtUtils.JWT_HEADER_KEY;

/**
 * @author LiJun
 * @Date 2020年02月03日
 * @Time 17:36
 */
public class JwtInterceptor extends HandlerInterceptorAdapter {
    private boolean OFF = false;//true为关闭jwt令牌验证功能

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object o) throws Exception {
        if (OFF){
            return true;
        }

        //获取到目标方法对象
        HandlerMethod method = (HandlerMethod) o;
        //取到方法上的注解
        ExcludeInterceptor methodAnnotation = method.getMethodAnnotation(ExcludeInterceptor.class);
        if (methodAnnotation != null) {//如果该方法上有自定义的注解，则直接跳过这个拦截器
            return true;
        }

        //从客户端请求头中获得令牌并验证
        String jwt = request.getHeader(JwtUtils.JWT_HEADER_KEY);
        Claims claims = this.validateJwtToken(jwt);
        if (null == claims) {
            returnErrorResponse(response,Result.error(JWT_NONE));
            return false;
        }
        else {
            String newJwt = JwtUtils.copyJwt(jwt, JwtUtils.JWT_WEB_TTL);
            response.setHeader("Access-Control-Expose-Headers",JWT_HEADER_KEY);
            response.addHeader(JwtUtils.JWT_HEADER_KEY, newJwt);
            return true;
        }
    }

    /**
     * 验证jwt令牌，验证通过返回声明(包括公有和私有)，返回null则表示验证失败
     */
    private Claims validateJwtToken(String jwt) {
        Claims claims = null;
        try {
            if (null != jwt) {
                claims = JwtUtils.parseJwt(jwt);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return claims;
    }

    /**
     * 发送jwt的验证结果到客户端
     * @author LiJun
     * @Date 2019/9/28
     * @Time 15:13
     * @param response
     * @param result
     * @return void
     */
    private void returnErrorResponse(HttpServletResponse response, Result result) throws IOException {
        OutputStream out = null;
        try{
            response.setCharacterEncoding("utf-8");
            response.setContentType("text/json");
            out = response.getOutputStream();
            out.write(JSONObject.toJSONString(result).getBytes("utf-8"));
            out.flush();
        } finally{
            if(out != null){
                out.close();
            }
        }
    }
}

WebConfig.java代码（配置类）： 

package com.ue.config;

import com.ue.Interceptor.JwtInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 配置使拦截器生效
 * @author LiJun
 * @Date 2020年02月03日
 * @Time 17:54
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 拦截所有请求
        registry.addInterceptor(LoginInterceptor()).addPathPatterns("/**");
    }

    @Bean
    public JwtInterceptor LoginInterceptor() {
        return new JwtInterceptor();
    }
}

JwtUtils.java代码（jwt工具类）： 

package com.ue.util;

import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.apache.commons.codec.binary.Base64;

import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

/**
 * JWT验证过滤器：配置顺序 CorsFilte->JwtUtilsr-->StrutsPrepareAndExecuteFilter
 */
public class JwtUtils {
	/**
	 * JWT_WEB_TTL：WEBAPP应用中token的有效时间,默认30分钟
	 */
	public static final long JWT_WEB_TTL = 30 * 60 * 1000;

	/**
	 * 将jwt令牌保存到header中的key
	 */
	public static final String JWT_HEADER_KEY = "jwt";

	// 指定签名的时候使用的签名算法，也就是header那部分，jjwt已经将这部分内容封装好了。
	private static final SignatureAlgorithm SIGNATURE_ALGORITHM = SignatureAlgorithm.HS256;
	private static final String JWT_SECRET = "f356cdce935c42328ad2001d7e9552a3";// JWT密匙
	private static final SecretKey JWT_KEY;// 使用JWT密匙生成的加密key

	static {
		byte[] encodedKey = Base64.decodeBase64(JWT_SECRET);
		JWT_KEY = new SecretKeySpec(encodedKey, 0, encodedKey.length, "AES");
	}

	private JwtUtils() {
	}

	/**
	 * 解密jwt，获得所有声明(包括标准和私有声明)
	 * @param jwt
	 * @return
	 * @throws Exception
	 */
	public static Claims parseJwt(String jwt) {
		Claims claims = Jwts.parser().setSigningKey(JWT_KEY).parseClaimsJws(jwt).getBody();
		return claims;
	}

	/**
	 * 创建JWT令牌，签发时间为当前时间
	 * @param claims
	 *            创建payload的私有声明（根据特定的业务需要添加，如果要拿这个做验证，一般是需要和jwt的接收方提前沟通好验证方式的）
	 * @param ttlMillis
	 *            JWT的有效时间(单位毫秒)，当前时间+有效时间=过期时间
	 * @return jwt令牌
	 */
	public static String createJwt(Map claims, long ttlMillis) {
		// 生成JWT的时间，即签发时间
		long nowMillis = System.currentTimeMillis();

		// 下面就是在为payload添加各种标准声明和私有声明了
		// 这里其实就是new一个JwtBuilder，设置jwt的body
		JwtBuilder builder = Jwts.builder()
				// 如果有私有声明，一定要先设置这个自己创建的私有的声明，这个是给builder的claim赋值，一旦写在标准的声明赋值之后，就是覆盖了那些标准的声明的
				.setClaims(claims)
				// 设置jti(JWT ID)：是JWT的唯一标识，根据业务需要，这个可以设置为一个不重复的值，主要用来作为一次性token,从而回避重放攻击。
				// 可以在未登陆前作为身份标识使用
				.setId(UUID.randomUUID().toString().replace("-", ""))
				// iss(Issuser)签发者，写死
				// .setIssuer("zking")
				// iat: jwt的签发时间
				.setIssuedAt(new Date(nowMillis))
				// 代表这个JWT的主体，即它的所有人，这个是一个json格式的字符串，可放数据{"uid":"zs"}。此处没放
				// .setSubject("{}")
				// 设置签名使用的签名算法和签名使用的秘钥
				.signWith(SIGNATURE_ALGORITHM, JWT_KEY)
				// 设置JWT的过期时间
				.setExpiration(new Date(nowMillis + ttlMillis));
		return builder.compact();
	}

	/**
	 * 复制jwt，并重新设置签发时间(为当前时间)和失效时间
	 * @param jwt:被复制的jwt令牌
	 * @param ttlMillis:jwt的有效时间(单位毫秒)，当前时间+有效时间=过期时间
	 * @return
	 */
	public static String copyJwt(String jwt, Long ttlMillis) {
		Claims claims = parseJwt(jwt);

		// 生成JWT的时间，即签发时间
		long nowMillis = System.currentTimeMillis();

		// 下面就是在为payload添加各种标准声明和私有声明了
		// 这里其实就是new一个JwtBuilder，设置jwt的body
		JwtBuilder builder = Jwts.builder()
				// 如果有私有声明，一定要先设置这个自己创建的私有的声明，这个是给builder的claim赋值，一旦写在标准的声明赋值之后，就是覆盖了那些标准的声明的
				.setClaims(claims)
				// 设置jti(JWT ID)：是JWT的唯一标识，根据业务需要，这个可以设置为一个不重复的值，主要用来作为一次性token,从而回避重放攻击。
				// 可以在未登陆前作为身份标识使用
				//.setId(UUID.randomUUID().toString().replace("-", ""))
				// iss(Issuser)签发者，写死
				// .setIssuer("zking")
				// iat: jwt的签发时间
				.setIssuedAt(new Date(nowMillis))
				// 代表这个JWT的主体，即它的所有人，这个是一个json格式的字符串，可放数据{"uid":"zs"}。此处没放
				// .setSubject("{}")
				// 设置签名使用的签名算法和签名使用的秘钥
				.signWith(SIGNATURE_ALGORITHM, JWT_KEY)
				// 设置JWT的过期时间
				.setExpiration(new Date(nowMillis + ttlMillis));
		return builder.compact();
	}
}

参考：http://javaxl.com/blog/articles/281