GateWay中添加白名单

谁践踏了优雅 2023-07-06 14:31 57阅读 0赞

项目地址：[https://github.com/hx1098/leyou][https_github.com_hx1098_leyou]

最近开发中有一个鉴权的操作，最后需要进行添加白名单的，废话不多说，直接上代码吧，

这是我的项目结构

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3_size_16_color_FFFFFF_t_70][]

applicaton启动类：

import org.springframework.boot.SpringApplication;
    import org.springframework.cloud.client.SpringCloudApplication;
    import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
    
    /**
     * Created with IDEA
     * author:hanxiao
     * Date:2019/12/9
     * Time:21:44
     */
    @EnableZuulProxy
    @SpringCloudApplication //代表springbootapplication  熔断器
    public class LyGateWayApplication {
        public static void main(String[] args) {
            SpringApplication.run(LyGateWayApplication.class,args);
        }
    }

2.application.yml

server:
      port: 10010
    spring:
      application:
        name: api-gateway
    eureka:
      client:
        service-url:
          defaultZone: http://127.0.0.1:10086/eureka
    zuul:
      prefix: /api # 添加路由前缀
      routes:
        item-service: /item/** # 商品微服务的映射路径
        search-service: /search/** # 搜索微服务
        user-service: /user/** # 用户微服务
        auth-service: /auth/** # 授权中心微服务
        upload-service:
          path: /upload/**
          serviceId: upload-service
          strip-prefix: false
      add-host-header: true #添加头
      sensitive-headers:  #覆盖敏感头信息，是cookie可以正常写入。
    
    hystrix:
      command:
        default:
          execution:
            isolation:
              thread:
                timeoutInMillisecond: 5000 # 熔断超时时长：10000ms
    ribbon:
      ConnectTimeout: 250 # 连接超时时间(ms)
      ReadTimeout: 2000 # 通信超时时间(ms)
      MaxAutoRetriesNextServer: 1 # 同一服务不同实例的重试次数
      MaxAutoRetries: 0 # 同一实例的重试次数
    
    leyou:
      jwt:
        pubKeyPath: C:\\tmp\\rsa\\rsa.pub # 公钥地址
        cookieName: LY_TOKEN
      filter:  #需要进行过滤的白名单
        allowPaths:
          - /api/search
          - /api/auth
          - /api/user/register
          - /api/user/check
          - /api/user/code
          - /api/item

![20200219160652718.png][]

这几行是白名单。

3.FilterProperties.class

import lombok.Data;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 import java.util.List;
 
 /**
 * @author hx 
 * @Title: 
 * @Package 
 * @Description: 网关白名单 
 * @date 2020/2/1914:03
 */
 @Data
 @ConfigurationProperties(prefix = "leyou.filter")
 public class FilterProperties {
 
 private List<String> allowPaths;
 
 
 
 }

4.GlobalCors.class

package com.leyou.gateway.config;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.cors.CorsConfiguration;
    import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
    import org.springframework.web.filter.CorsFilter;
    
    /**
     * Created with IDEA
     * author:hanxiao
     * Date:2019/12/12
     * Time:11:01
     */
    @Configuration
    public class GlobalCorsConfig {
    
        @Bean
        public CorsFilter corsFilter() {
            //1.添加CORS配置信息
            CorsConfiguration config = new CorsConfiguration();
            //1) 允许的域,不要写*，否则cookie就无法使用了
            config.addAllowedOrigin("http://manage.leyou.com");
            config.addAllowedOrigin("http://www.leyou.com");
            config.addAllowedOrigin("http://api.leyou.com");
            //config.addAllowedOrigin("*");
            //2) 是否发送Cookie信息
            config.setAllowCredentials(true);
            //3) 允许的请求方式
            config.addAllowedMethod("OPTIONS");
            config.addAllowedMethod("HEAD");
            config.addAllowedMethod("GET");
            config.addAllowedMethod("PUT");
            config.addAllowedMethod("POST");
            config.addAllowedMethod("DELETE");
            config.addAllowedMethod("PATCH");
            // 4）允许的头信息
            config.addAllowedHeader("*");
            // 4）有效时间
            config.setMaxAge(3600L);
    
            //2.添加映射路径，我们拦截一切请求
            UrlBasedCorsConfigurationSource configSource = new UrlBasedCorsConfigurationSource();
            configSource.registerCorsConfiguration("/**", config);
    
            //3.返回新的CorsFilter.
            return new CorsFilter(configSource);
        }
    }

4.JwtProperties.calss

package com.leyou.gateway.config;
    
    import com.leyou.auth.utils.RsaUtils;
    import lombok.Data;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    
    import javax.annotation.PostConstruct;
    import java.io.File;
    import java.security.PrivateKey;
    import java.security.PublicKey;
    
    @Data
    @EnableConfigurationProperties
    @ConfigurationProperties(prefix = "leyou.jwt")
    public class JwtProperties {
    
            private String pubKeyPath;// 公钥
            private String cookieName;
    
            private PublicKey publicKey; // 公钥
    
            // 对象一旦实例化后，就应该读取公钥和私钥
            @PostConstruct // 构造函数执行完毕后就执行
            public void init(){
    
                    // 获取公钥和私钥
                    try {
                            this.publicKey = RsaUtils.getPublicKey(pubKeyPath);
                    } catch (Exception e) {
                            e.printStackTrace();
                    }
            }
    }

5.AuthFilter.calss

package com.leyou.gateway.filters;
 
 import com.leyou.auth.entity.UserInfo;
 import com.leyou.auth.utils.JwtUtils;
 import com.leyou.common.utils.CookieUtils;
 import com.leyou.gateway.config.FilterProperties;
 import com.leyou.gateway.config.JwtProperties;
 import com.netflix.zuul.ZuulFilter;
 import com.netflix.zuul.context.RequestContext;
 import com.netflix.zuul.exception.ZuulException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cloud.netflix.zuul.filters.support.FilterConstants;
 import org.springframework.stereotype.Component;
 
 import javax.servlet.http.Cookie;
 import javax.servlet.http.HttpServletRequest;
 
 /**
 * @author hx 
 * @Title: 
 * @Package 
 * @Description: 拦截登录 
 * @date 2020/2/1913:25
 */
 @Component
 @EnableConfigurationProperties({JwtProperties.class, FilterProperties.class})
 public class AuthFilter extends ZuulFilter {
 
 @Autowired
 private JwtProperties prop;
 
 @Autowired
 private FilterProperties filterProperties;
 
 /**
 * filter类型
 * @return
 */
 @Override
 public String filterType() {
 return FilterConstants.PRE_TYPE; //前置过滤
 }
 
 /**
 * filter执行顺序，值越小优先级越高
 * 官方推荐使用x-1方式优先排序
 * @return
 */
 @Override
 public int filterOrder() {
 return FilterConstants.PRE_DECORATION_FILTER_ORDER - 1;
 }
 
 /**
 * filter 开启关闭
 * @return
 */
 @Override
 public boolean shouldFilter() {
 /* return true;*/
 //获取上下文
 RequestContext ctx = RequestContext.getCurrentContext();
 //获取request
 HttpServletRequest request = ctx.getRequest();
 //获取请求的url路径
 String path = request.getRequestURI();
 //判断是否是白名单进行放行 放行返回false
 return !isAllowPath(path);//是否过滤
 }
 
 private boolean isAllowPath(String path) {
 //遍历白名单
 for (String allowPath : filterProperties.getAllowPaths()) {
 //判断是否允许
 if(path.startsWith(allowPath)){
 return true;
 }
 }
 return false;
 }
 
 /**
 * 实现filter逻辑
 * @return
 * @throws ZuulException
 */
 @Override
 public Object run() throws ZuulException {
 //获取上下文
 RequestContext ctx = RequestContext.getCurrentContext();
 //获取request
 HttpServletRequest request = ctx.getRequest();
 //获取cookie总的token，
 // Cookie[] cookies = request.getCookies();
 //获取token
 String token = CookieUtils.getCookieValue(request, prop.getCookieName());
 //解析token
 try {
 UserInfo userInfo = JwtUtils.getInfoFromToken(token, prop.getPublicKey());
 //Todo 校验权限
 //校验用户的权限
 }catch (Exception e){
 //解析失败，未登录,进行拦截
 ctx.setSendZuulResponse(false);
 //返回状态码
 ctx.setResponseStatusCode(403);
 }
 
 return null;
 }
 }

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</artifactId>
 <groupId>com.leiyou.parent</groupId>
 <version>1.0-SNAPSHOT</version>
 </parent>
 <modelVersion>4.0.0</modelVersion>
 
 <groupId>com.leyou.common</groupId>
 <artifactId>ly-gateway</artifactId>
 <dependencies>
 <dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
 </dependency>
 <dependency>
 <groupId>org.springframework.cloud</groupId>
 <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
 </dependency>
 
 <dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-actuator</artifactId>
 </dependency>
 <dependency>
 <groupId>com.leiyou.parent</groupId>
 <artifactId>ly-auth-interface</artifactId>
 <version>1.0-SNAPSHOT</version>
 </dependency>
 <dependency>
 <groupId>com.leiyou.common</groupId>
 <artifactId>ly-common</artifactId>
 <version>1.0-SNAPSHOT</version>
 </dependency>
 
 </dependencies>
 
 </project>

ok完毕！

不过在代码写完的时候，我的网关总是在登录之后突然跳到了登录页面，调试了好久才发现，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3_size_16_color_FFFFFF_t_70 1][]

这个地方一直是返回的true，所以他是都进行拦截的，根本没有拦截的效果。/衰/衰

[https_github.com_hx1098_leyou]: https://github.com/hx1098/leyou
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200219160406665.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3,size_16,color_FFFFFF,t_70
[20200219160652718.png]: https://img-blog.csdnimg.cn/20200219160652718.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200219161213430.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMyNTY1MjY3,size_16,color_FFFFFF,t_70