微服务项目之电商--26.无状态登录原理及授权中心及cookie的登录验证

深藏阁楼爱情的钟 2021-10-15 23:53 343阅读 0赞

**目录**

1.无状态登录原理

1.1.什么是有状态？

1.2.什么是无状态

1.3.如何实现无状态

1.4.JWT

1.4.1.简介

1.4.2.数据格式

1.4.3.JWT交互流程

1.4.4.非对称加密

1.5.结合Zuul的鉴权流程

1.5.1.没有RSA加密时

1.5.2.结合RSA的鉴权

2.授权中心

2.1.创建授权中心

2.1.1.创建父module

2.1.2.通用module

2.1.3.授权服务

2.2.JWT工具类

2.3.测试工具类

2.3.编写登录授权接口

2.3.1.生成公钥和私钥

2.3.2.Controller

2.3.3.CookieUtils

2.3.3.UserClient

2.3.4.Service

2.3.5.项目结构

2.3.6.测试

4.网关的登录拦截器

4.1.引入jwt相关配置

4.2.编写过滤器逻辑

4.3.白名单

--------------------

# 1.无状态登录原理 #

## 1.1.什么是有状态？ ##

有状态服务，即服务端需要记录每次会话的客户端信息，从而识别客户端身份，根据用户身份进行请求的处理，典型的设计如tomcat中的session。

例如登录：用户登录后，我们把登录者的信息保存在服务端session中，并且给用户一个cookie值，记录对应的session。然后下次请求，用户携带cookie值来，我们就能识别到对应session，从而找到用户的信息。

缺点是什么？

*  服务端保存大量数据，增加服务端压力
 *  服务端保存用户状态，无法进行水平扩展
 *  客户端请求依赖服务端，多次请求必须访问同一台服务器

## 1.2.什么是无状态 ##

微服务集群中的每个服务，对外提供的都是Rest风格的接口。而Rest风格的一个最重要的规范就是：服务的无状态性，即：

*  服务端不保存任何客户端请求者信息
 *  客户端的每次请求必须具备自描述信息，通过这些信息识别客户端身份

带来的好处是什么呢？

*  客户端请求不依赖服务端的信息，任何多次请求不需要必须访问到同一台服务
 *  服务端的集群和状态对客户端透明
 *  服务端可以任意的迁移和伸缩
 *  减小服务端存储压力

## 1.3.如何实现无状态 ##

无状态登录的流程：

*  当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
 *  认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证
 *  以后每次请求，客户端都携带认证的token
 *  服务端对token进行解密，判断是否有效。

流程图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70][]

整个登录过程中，最关键的点是什么？

**token的安全性**

token是识别客户端身份的唯一标示，如果加密不够严密，被人伪造那就完蛋了。

采用何种方式加密才是安全可靠的呢？

我们将采用`JWT + RSA非对称加密`

## 1.4.JWT ##

### 1.4.1.简介 ###

JWT，全称是Json Web Token， 是JSON风格轻量级的授权和身份认证规范，可实现无状态、分布式的Web应用授权；官网：[https://jwt.io][https_jwt.io]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 1][]

GitHub上jwt的java客户端：[https://github.com/jwtk/jjwt][https_github.com_jwtk_jjwt]

### 1.4.2.数据格式 ###

JWT包含三部分数据：

*  Header：头部，通常头部有两部分信息：
    
     *  声明类型，这里是JWT
     *  加密算法，自定义
    
    我们会对头部进行base64加密（可解密），得到第一部分数据
 *  Payload：载荷，就是有效数据，一般包含下面信息：
    
     *  用户身份信息（注意，这里因为采用base64加密，可解密，因此不要存放敏感信息）
     *  注册声明：如token的签发时间，过期时间，签发人等
    
    这部分也会采用base64加密，得到第二部分数据
 *  Signature：签名，是整个数据的认证信息。一般根据前两步的数据，再加上服务的的密钥（secret）（不要泄漏，最好周期性更换），通过加密算法生成。用于验证整个数据完整和可靠性

生成的数据格式：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 2][]

可以看到分为3段，每段就是上面的一部分数据

### 1.4.3.JWT交互流程 ###

流程图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 3][]

步骤翻译：

*  1、用户登录
 *  2、服务的认证，通过后根据secret生成token
 *  3、将生成的token返回给浏览器
 *  4、用户每次请求携带token
 *  5、服务端利用公钥解读jwt签名，判断签名有效后，从Payload中获取用户信息
 *  6、处理请求，返回响应结果

因为JWT签发的token中已经包含了用户的身份信息，并且每次请求都会携带，这样服务的就无需保存用户信息，甚至无需去数据库查询，完全符合了Rest的无状态规范。

### 1.4.4.非对称加密 ###

加密技术是对信息进行编码和解码的技术，编码是把原来可读信息（又称明文）译成代码形式（又称密文），其逆过程就是解码（解密），加密技术的要点是加密算法，加密算法可以分为三类：

*  对称加密，如AES
    
     *  基本原理：将明文分成N个组，然后使用密钥对各个组进行加密，形成各自的密文，最后把所有的分组密文进行合并，形成最终的密文。
     *  优势：算法公开、计算量小、加密速度快、加密效率高
     *  缺陷：双方都使用同样密钥，安全性得不到保证
 *  非对称加密，如RSA
    
     *  基本原理：同时生成两把密钥：私钥和公钥，私钥隐秘保存，公钥可以下发给信任客户端
        
         *  私钥加密，持有私钥或公钥才可以解密
         *  公钥加密，持有私钥才可解密
     *  优点：安全，难以破解
     *  缺点：算法比较耗时
 *  不可逆加密，如MD5，SHA
    
     *  基本原理：加密过程中不需要使用[密钥][Link 1]，输入明文后由系统直接经过加密算法处理成密文，这种加密后的数据是无法被解密的，无法根据密文推算出明文。

RSA算法历史：

1977年，三位数学家Rivest、Shamir 和 Adleman 设计了一种算法，可以实现非对称加密。这种算法用他们三个人的名字缩写：RSA

## 1.5.结合Zuul的鉴权流程 ##

我们逐步演进系统架构设计。需要注意的是：secret是签名的关键，因此一定要保密，我们放到鉴权中心保存，其它任何服务中都不能获取secret。

### 1.5.1.没有RSA加密时 ###

在微服务架构中，我们可以把服务的鉴权操作放到网关中，将未通过鉴权的请求直接拦截，如图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 4][]

*  1、用户请求登录
 *  2、Zuul将请求转发到授权中心，请求授权
 *  3、授权中心校验完成，颁发JWT凭证
 *  4、客户端请求其它功能，携带JWT
 *  5、Zuul将jwt交给授权中心校验，通过后放行
 *  6、用户请求到达微服务
 *  7、微服务将jwt交给鉴权中心，鉴权同时解析用户信息
 *  8、鉴权中心返回用户数据给微服务
 *  9、微服务处理请求，返回响应

发现什么问题了？

每次鉴权都需要访问鉴权中心，系统间的网络请求频率过高，效率略差，鉴权中心的压力较大。

### 1.5.2.结合RSA的鉴权 ###

直接看图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 5][]

*  我们首先利用RSA生成公钥和私钥。私钥保存在授权中心，公钥保存在Zuul和各个微服务
 *  用户请求登录
 *  授权中心校验，通过后用私钥对JWT进行签名加密
 *  返回jwt给用户
 *  用户携带JWT访问
 *  Zuul直接通过公钥解密JWT，进行验证，验证通过则放行
 *  请求到达微服务，微服务直接用公钥解析JWT，获取用户信息，无需访问授权中心

# 2.授权中心 #

## 2.1.创建授权中心 ##

授权中心的主要职责：

*  用户鉴权：
    
     *  接收用户的登录请求，通过用户中心的接口进行校验，通过后生成JWT
     *  使用私钥生成JWT并返回
 *  服务鉴权：微服务间的调用不经过Zuul，会有风险，需要鉴权中心进行认证
    
     *  原理与用户鉴权类似，但逻辑稍微复杂一些（此处我们不做实现）

因为生成jwt，解析jwt这样的行为以后在其它微服务中也会用到，因此我们会抽取成工具。我们把鉴权中心进行聚合，一个工具module，一个提供服务的module

### 2.1.1.创建父module ###

我们先创建父module，名称为：leyou-auth

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 6][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 7][]

将pom打包方式改为pom：

### 2.1.2.通用module ###

然后是授权服务的通用模块：leyou-auth-common：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 8][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 9][]

pom.xml：

结构：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 10][]

### 2.1.3.授权服务 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 11][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 12][]

pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>leyou-auth</artifactId>
            <groupId>com.leyou.auth</groupId>
            <version>1.0.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.leyou.auth</groupId>
        <artifactId>leyou-auth-service</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>com.leyou.auth</groupId>
                <artifactId>leyou-auth-common</artifactId>
                <version>1.0.0-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>com.leyou.common</groupId>
                <artifactId>leyou-common</artifactId>
                <version>1.0.0-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
            </dependency>
        </dependencies>
    
    </project>

引导类：

@SpringBootApplication
    @EnableDiscoveryClient
    @EnableFeignClients
    public class LeyouAuthApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(LeyouAuthApplication.class, args);
        }
    }

application.yml

server:
      port: 8087
    spring:
      application:
        name: auth-service
    eureka:
      client:
        service-url:
          defaultZone: http://127.0.0.1:10086/eureka
        registry-fetch-interval-seconds: 10
      instance:
        lease-renewal-interval-in-seconds: 5 # 每隔5秒发送一次心跳
        lease-expiration-duration-in-seconds: 10 # 10秒不发送就过期
        prefer-ip-address: true
        ip-address: 127.0.0.1
        instance-id: ${spring.application.name}:${server.port}

结构：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 13][]

在leyou-gateway工程的application.yml中，修改路由：

zuul:
      prefix: /api # 路由路径前缀
      routes:
        item-service: /item/** # 商品微服务的映射路径
        search-service: /search/** # 搜索微服务
        user-service: /user/** # 用户微服务
        auth-service: /auth/** # 授权中心微服务

## 2.2.JWT工具类 ##

我们在`leyou-auth-common`中导入课前资料中的工具类：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 14][]

需要在`leyou-auth-common`中引入JWT依赖：

<dependencies>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>0.9.0</version>
        </dependency>
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
        </dependency>
    </dependencies>

## 2.3.测试工具类 ##

我们在`leyou-auth-common`中编写测试类：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 15][]

public class JwtTest {
    
        private static final String pubKeyPath = "C:\\tmp\\rsa\\rsa.pub";
    
        private static final String priKeyPath = "C:\\tmp\\rsa\\rsa.pri";
    
        private PublicKey publicKey;
    
        private PrivateKey privateKey;
    
        @Test
        public void testRsa() throws Exception {
            RsaUtils.generateKey(pubKeyPath, priKeyPath, "234");
        }
    
        @Before
        public void testGetRsa() throws Exception {
            this.publicKey = RsaUtils.getPublicKey(pubKeyPath);
            this.privateKey = RsaUtils.getPrivateKey(priKeyPath);
        }
    
        @Test
        public void testGenerateToken() throws Exception {
            // 生成token
            String token = JwtUtils.generateToken(new UserInfo(20L, "jack"), privateKey, 5);
            System.out.println("token = " + token);
        }
    
        @Test
        public void testParseToken() throws Exception {
            String token = "eyJhbGciOiJSUzI1NiJ9.eyJpZCI6MjAsInVzZXJuYW1lIjoiamFjayIsImV4cCI6MTUzMzI4MjQ3N30.EPo35Vyg1IwZAtXvAx2TCWuOPnRwPclRNAM4ody5CHk8RF55wdfKKJxjeGh4H3zgruRed9mEOQzWy79iF1nGAnvbkraGlD6iM-9zDW8M1G9if4MX579Mv1x57lFewzEo-zKnPdFJgGlAPtNWDPv4iKvbKOk1-U7NUtRmMsF1Wcg";
    
            // 解析token
            UserInfo user = JwtUtils.getInfoFromToken(token, publicKey);
            System.out.println("id: " + user.getId());
            System.out.println("userName: " + user.getUsername());
        }
    }

测试生成公钥和私钥，我们运行这段代码：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 16][]

运行之后，查看目标目录：

![2019082010213231.png][]

公钥和私钥已经生成了！

测试生成token，把@Before的注释去掉的：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 17][]

![20190820102156813.png][]

测试解析token：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 18][]

正常情况：

![20190820102302996.png][]

任意改动token，发现报错了：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 19][]

## 2.3.编写登录授权接口 ##

接下来，我们需要在`leyou-auth-servcice`编写一个接口，对外提供登录授权服务。基本流程如下：

*  客户端携带用户名和密码请求登录
 *  授权中心调用客户中心接口，根据用户名和密码查询用户信息
 *  如果用户名密码正确，能获取用户，否则为空，则登录失败
 *  如果校验成功，则生成JWT并返回

### 2.3.1.生成公钥和私钥 ###

我们需要在授权中心生成真正的公钥和私钥。我们必须有一个生成公钥和私钥的secret，这个可以配置到`application.yml`中：

leyou:
      jwt:
        secret: leyou@Login(Auth}*^31)&heiMa% # 登录校验的密钥
        pubKeyPath: C:\\tmp\\rsa\\rsa.pub # 公钥地址
        priKeyPath: C:\\tmp\\rsa\\rsa.pri # 私钥地址
        expire: 30 # 过期时间,单位分钟

然后编写属性类，加载这些数据：

@ConfigurationProperties(prefix = "ly.jwt")
    public class JwtProperties {
    
        private String secret; // 密钥
    
        private String pubKeyPath;// 公钥
    
        private String priKeyPath;// 私钥
    
        private int expire;// token过期时间
    
        private PublicKey publicKey; // 公钥
    
        private PrivateKey privateKey; // 私钥
    
        private static final Logger logger = LoggerFactory.getLogger(JwtProperties.class);
    
        /**
         * @PostContruct：在构造方法执行之后执行该方法
         */
        @PostConstruct
        public void init(){
            try {
                File pubKey = new File(pubKeyPath);
                File priKey = new File(priKeyPath);
                if (!pubKey.exists() || !priKey.exists()) {
                    // 生成公钥和私钥
                    RsaUtils.generateKey(pubKeyPath, priKeyPath, secret);
                }
                // 获取公钥和私钥
                this.publicKey = RsaUtils.getPublicKey(pubKeyPath);
                this.privateKey = RsaUtils.getPrivateKey(priKeyPath);
            } catch (Exception e) {
                logger.error("初始化公钥和私钥失败！", e);
                throw new RuntimeException();
            }
        }
        
        // getter setter ...
    }

### 2.3.2.Controller ###

编写授权接口，我们接收用户名和密码，校验成功后，写入cookie中。

*  请求方式：post
 *  请求路径：/accredit
 *  请求参数：username和password
 *  返回结果：无

代码：

@RestController
    @EnableConfigurationProperties(JwtProperties.class)
    public class AuthController {
    
        @Autowired
        private AuthService authService;
    
        @Autowired
        private JwtProperties prop;
    
        /**
         * 登录授权
         *
         * @param username
         * @param password
         * @return
         */
        @PostMapping("accredit")
        public ResponseEntity<Void> authentication(
                @RequestParam("username") String username,
                @RequestParam("password") String password,
                HttpServletRequest request,
                HttpServletResponse response) {
            // 登录校验
            String token = this.authService.authentication(username, password);
            if (StringUtils.isBlank(token)) {
                return new ResponseEntity<>(HttpStatus.UNAUTHORIZED);
            }
            // 将token写入cookie,并指定httpOnly为true，防止通过JS获取和修改
            CookieUtils.setCookie(request, response, prop.getCookieName(),
                    token, prop.getCookieMaxAge(), null, true);
            return ResponseEntity.ok().build();
        }
    }

这里的cookie的name和生存时间，我们配置到属性文件：application.yml：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 20][]

然后在`JwtProperties`中添加属性： ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 21][]

### 2.3.3.CookieUtils ###

要注意，这里我们使用了一个工具类，CookieUtils，可以在课前资料中找到，我们把它添加到`leyou-common`中，然后引入servlet相关依赖即可：

<dependency>
        <groupId>org.apache.tomcat.embed</groupId>
        <artifactId>tomcat-embed-core</artifactId>
    </dependency>

代码：略

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 22][]

### 2.3.3.UserClient ###

接下来我们肯定要对用户密码进行校验，所以我们需要通过FeignClient去访问 user-service微服务：

引入user-service依赖：

<dependency>
        <groupId>com.leyou.user</groupId>
        <artifactId>leyou-user-interface</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </dependency>

编写FeignClient：

@FeignClient(value = "user-service")
    public interface UserClient extends UserApi {
    }

在leyou-user-interface工程中添加api接口：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 23][]

内容：

@RequestMapping("user")
    public interface UserApi {
    
        @GetMapping("query")
        public User queryUser(
                @RequestParam("username") String username,
                @RequestParam("password") String password);
    }

### 2.3.4.Service ###

@Service
    public class AuthService {
    
        @Autowired
        private UserClient userClient;
    
        @Autowired
        private JwtProperties properties;
    
        public String authentication(String username, String password) {
    
            try {
                // 调用微服务，执行查询
                User user = this.userClient.queryUser(username, password);
    
                // 如果查询结果为null，则直接返回null
                if (user == null) {
                    return null;
                }
    
                // 如果有查询结果，则生成token
                String token = JwtUtils.generateToken(new UserInfo(user.getId(), user.getUsername()),
                        properties.getPrivateKey(), properties.getExpire());
                return token;
            } catch (Exception e) {
                e.printStackTrace();
            }
            return null;
        }
    }

### 2.3.5.项目结构 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 24][]

### 2.3.6.测试 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 25][]

# 4.网关的登录拦截器 #

## 4.1.引入jwt相关配置 ##

既然是登录拦截，一定是前置拦截器，我们在`leyou-gateway`中定义。

首先在pom.xml中，引入所需要的依赖：

<dependency>
        <groupId>com.leyou.common</groupId>
        <artifactId>leyou-common</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </dependency>
    <dependency>
        <groupId>com.leyou.auth</groupId>
        <artifactId>leyou-auth-common</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </dependency>

然后编写application.yml属性文件，添加如下内容：

leyou:
      jwt:
        pubKeyPath:  C:\\tmp\\rsa\\rsa.pub # 公钥地址
        cookieName: LY_TOKEN # cookie的名称

编写属性类，读取公钥：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 26][]

@ConfigurationProperties(prefix = "leyou.jwt")
    public class JwtProperties {
    
        private String pubKeyPath;// 公钥
    
        private PublicKey publicKey; // 公钥
    
        private String cookieName;
    
        private static final Logger logger = LoggerFactory.getLogger(JwtProperties.class);
    
        @PostConstruct
        public void init(){
            try {
                // 获取公钥和私钥
                this.publicKey = RsaUtils.getPublicKey(pubKeyPath);
            } catch (Exception e) {
                logger.error("初始化公钥失败！", e);
                throw new RuntimeException();
            }
        }
    
        public String getPubKeyPath() {
            return pubKeyPath;
        }
    
        public void setPubKeyPath(String pubKeyPath) {
            this.pubKeyPath = pubKeyPath;
        }
    
        public PublicKey getPublicKey() {
            return publicKey;
        }
    
        public void setPublicKey(PublicKey publicKey) {
            this.publicKey = publicKey;
        }
    
        public String getCookieName() {
            return cookieName;
        }
    
        public void setCookieName(String cookieName) {
            this.cookieName = cookieName;
        }
    }

## 4.2.编写过滤器逻辑 ##

基本逻辑：

*  获取cookie中的token
 *  通过JWT对token进行校验
 *  通过：则放行；不通过：则重定向到登录页

@Component
    @EnableConfigurationProperties(JwtProperties.class)
    public class LoginFilter extends ZuulFilter {
    
        @Autowired
        private JwtProperties properties;
    
        @Override
        public String filterType() {
            return "pre";
        }
    
        @Override
        public int filterOrder() {
            return 5;
        }
    
        @Override
        public boolean shouldFilter() {
            return true;
        }
    
        @Override
        public Object run() throws ZuulException {
            // 获取上下文
            RequestContext context = RequestContext.getCurrentContext();
            // 获取request
            HttpServletRequest request = context.getRequest();
            // 获取token
            String token = CookieUtils.getCookieValue(request, this.properties.getCookieName());
            // 校验
            try {
                // 校验通过什么都不做，即放行
                JwtUtils.getInfoFromToken(token, this.properties.getPublicKey());
            } catch (Exception e) {
                // 校验出现异常，返回403
                context.setSendZuulResponse(false);
                context.setResponseStatusCode(HttpStatus.FORBIDDEN.value());
            }
            return null;
        }
    }

重启，刷新页面，发现请求校验的接口也被拦截了：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 27][]

证明我们的拦截器生效了，但是，似乎有什么不对的。这个路径似乎不应该被拦截啊！

## 4.3.白名单 ##

要注意，并不是所有的路径我们都需要拦截，例如：

*  登录校验接口：`/auth/**`
 *  注册接口：`/user/register`
 *  数据校验接口：`/user/check/**`
 *  发送验证码接口：`/user/code`
 *  搜索接口：`/search/**`

另外，跟后台管理相关的接口，因为我们没有做登录和权限，因此暂时都放行，但是生产环境中要做登录校验：

*  后台商品服务：`/item/**`

所以，我们需要在拦截时，配置一个白名单，如果在名单内，则不进行拦截。

在`application.yaml`中添加规则：

leyou:
      filter:
        allowPaths:
          - /api/auth
          - /api/search
          - /api/user/register
          - /api/user/check
          - /api/user/code
          - /api/item

然后读取这些属性：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 28][]

内容：

@ConfigurationProperties(prefix = "leyou.filter")
    public class FilterProperties {
    
        private List<String> allowPaths;
    
        public List<String> getAllowPaths() {
            return allowPaths;
        }
    
        public void setAllowPaths(List<String> allowPaths) {
            this.allowPaths = allowPaths;
        }
    }

在过滤器中的`shouldFilter`方法中添加判断逻辑：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 29][]

代码：

@Component
    @EnableConfigurationProperties({JwtProperties.class, FilterProperties.class})
    public class LoginFilter extends ZuulFilter {
    
        @Autowired
        private JwtProperties jwtProp;
    
        @Autowired
        private FilterProperties filterProp;
    
        private static final Logger logger = LoggerFactory.getLogger(LoginFilter.class);
    
        @Override
        public String filterType() {
            return "pre";
        }
    
        @Override
        public int filterOrder() {
            return 5;
        }
    
        @Override
        public boolean shouldFilter() {
            // 获取上下文
            RequestContext ctx = RequestContext.getCurrentContext();
            // 获取request
            HttpServletRequest req = ctx.getRequest();
            // 获取路径
            String requestURI = req.getRequestURI();
            // 判断白名单
            return !isAllowPath(requestURI);
        }
    
        private boolean isAllowPath(String requestURI) {
            // 定义一个标记
            boolean flag = false;
            // 遍历允许访问的路径
            for (String path : this.filterProp.getAllowPaths()) {
                // 然后判断是否是符合
                if(requestURI.startsWith(path)){
                    flag = true;
                    break;
                }
            }
            return flag;
        }
    
        @Override
        public Object run() throws ZuulException {
            // 获取上下文
            RequestContext ctx = RequestContext.getCurrentContext();
            // 获取request
            HttpServletRequest request = ctx.getRequest();
            // 获取token
            String token = CookieUtils.getCookieValue(request, jwtProp.getCookieName());
            // 校验
            try {
                // 校验通过什么都不做，即放行
                JwtUtils.getInfoFromToken(token, jwtProp.getPublicKey());
            } catch (Exception e) {
                // 校验出现异常，返回403
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(403);
                logger.error("非法访问，未登录，地址：{}", request.getRemoteHost(), e );
            }
            return null;
        }
    }

再次测试：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 30][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70]: /images/20211015/913cc4c72bf749a980d5aaec9e3028fc.png
[https_jwt.io]: https://jwt.io
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 1]: /images/20211015/207a353664e247adaadef441bc7aaf38.png
[https_github.com_jwtk_jjwt]: https://github.com/jwtk/jjwt
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 2]: /images/20211015/7e33ee7c77a14ad38f7f0451cfc2aa0f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 3]: /images/20211015/b33b7f971b8e4287b02e4f5dab4b7a0b.png
[Link 1]: https://baike.baidu.com/item/%E5%AF%86%E9%92%A5
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 4]: /images/20211015/2720faedcc7e4d16915d9d38007e1536.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 5]: /images/20211015/fcfd7f9de8d4484984f9e941c0e61616.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 6]: /images/20211015/d8231f9017e849fab2fc2dff5cb1156c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 7]: /images/20211015/c8437aacfb854fbdbc27dd6bea051735.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 8]: /images/20211015/3000c8c264aa4bf79fc45b78bd546deb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 9]: /images/20211015/7754bbde830e4d27981cd6653f0ef195.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 10]: /images/20211015/c556865e5f434e279b46c1cf8b0e8566.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 11]: /images/20211015/f639fd27f5d0448584ac5e435831f5c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 12]: /images/20211015/d322e718d44c4acebbee3297eb53d414.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 13]: /images/20211015/3efc19cea50940ca9fe56ea087341213.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 14]: /images/20211015/5681f1e0da60435b8b10805bfc5881c1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 15]: /images/20211015/4227a101945c486abbb7b158b7fce524.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 16]: /images/20211015/d4abc0af948c43b19163fb7da4aaea01.png
[2019082010213231.png]: /images/20211015/8a1a218e1ace4b21b0784ebb3a87ff5a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 17]: /images/20211015/f8adc9c47f484e5b8ec419662857fea6.png
[20190820102156813.png]: /images/20211015/aa59a2def1f74ab0926e98732c9960e2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 18]: /images/20211015/fe0dc94089c24f0cb2c56e4cfa607de4.png
[20190820102302996.png]: /images/20211015/ea77480e78da4d1690fc29054c7ff368.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 19]: /images/20211015/edc5f5e71cde4646b7c22f1d8d369846.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 20]: /images/20211015/a86a1a37421f42dfa4232b104811846a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 21]: /images/20211015/0b41c6abcc7142fb9e8d4c3e9480d492.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 22]: /images/20211015/583192d9678c475ab1d4d44cee8b124b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 23]: /images/20211015/24be6aad71d34b318f221622917a3313.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 24]: /images/20211015/e80b357b47724f008fd8066b96f309fd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 25]: /images/20211015/708ea62ca16947a48fd34aaa13c2fbe9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 26]: /images/20211015/644fb60e07d64c84a23df609098d7514.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 27]: /images/20211015/36067252888e46acaae749105e8d98c5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 28]: /images/20211015/6701b4d43b864f1ea05e5d48a794f3fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 29]: /images/20211015/d39229d7a6c94203a12667fcfa969348.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3OTA5NTA4_size_16_color_FFFFFF_t_70 30]: /images/20211015/a47da4f68034486bb81c5773bd42bdaa.png