day17项目【权限管理】-02 SpringCloud【GateWay网关】

01-GATEWAY网关

一、网关基本概念

1、API网关介绍

API 网关出现的原因是微服务架构的出现，不同的微服务一般会有不同的网络地址，而外部客户端可能需要调用多个服务的接口才能完成一个业务需求，如果让客户端直接与各个微服务通信，会有以下的问题：

（1）客户端会多次请求不同的微服务，增加了客户端的复杂性。

（2）存在跨域请求，在一定场景下处理相对复杂。

（3）认证复杂，每个服务都需要独立认证。

（4）难以重构，随着项目的迭代，可能需要重新划分微服务。例如，可能将多个服务合并成一个或者将一个服务拆分成多个。如果客户端直接与微服务通信，那么重构将会很难实施。

（5）某些微服务可能使用了防火墙 / 浏览器不友好的协议，直接访问会有一定的困难。

以上这些问题可以借助 API 网关解决。API 网关是介于客户端和服务器端之间的中间层，所有的外部请求都会先经过 API 网关这一层。也就是说，API 的实现方面更多的考虑业务逻辑，而安全、性能、监控可以交由 API 网关来做，这样既提高业务灵活性又不缺安全性

2、Spring Cloud Gateway

Spring cloud gateway是spring官方基于Spring 5.0、Spring Boot2.0和Project Reactor等技术开发的网关，Spring Cloud Gateway旨在为微服务架构提供简单、有效和统一的API路由管理方式，Spring Cloud Gateway作为Spring Cloud生态系统中的网关，目标是替代Netflix Zuul，其不仅提供统一的路由方式，并且还基于Filer链的方式提供了网关基本的功能，例如：安全、监控/埋点、限流等。

3、Spring Cloud Gateway核心概念

网关提供API全托管服务，丰富的API管理功能，辅助企业管理大规模的API，以降低管理成本和安全风险，包括协议适配、协议转发、安全策略、防刷、流量、监控日志等贡呢。一般来说网关对外暴露的URL或者接口信息，我们统称为路由信息。如果研发过网关中间件或者使用过Zuul的人，会知道网关的核心是Filter以及Filter Chain（Filter责任链）。Sprig Cloud Gateway也具有路由和Filter的概念。下面介绍一下Spring Cloud Gateway中几个重要的概念。

（1）路由。路由是网关最基础的部分，路由信息有一个ID、一个目的URL、一组断言和一组Filter组成。如果断言路由为真，则说明请求的URL和配置匹配。

（2）断言。Java8中的断言函数。Spring Cloud Gateway中的断言函数输入类型是Spring5.0框架中的ServerWebExchange。Spring Cloud Gateway中的断言函数允许开发者去定义匹配来自于http request中的任何信息，比如请求头和参数等。

（3）过滤器。一个标准的Spring webFilter。Spring cloud gateway中的filter分为两种类型的Filter，分别是Gateway Filter和Global Filter。过滤器Filter将会对请求和响应进行修改处理。

如上图所示，Spring cloud Gateway发出请求。然后再由Gateway Handler Mapping中找到与请求相匹配的路由，将其发送到Gateway web handler。Handler再通过指定的过滤器链将请求发送到我们实际的服务执行业务逻辑，然后返回。

二、创建api-gateway模块（网关服务）

1、在infrastructure模块下创建api_gateway模块

2、在api_gateway中的pom.xml引入依赖

<dependencies>

        <dependency>

            <groupId>com.atguigu</groupId>

            <artifactId>common_utils</artifactId>

            <version>0.0.1-SNAPSHOT</version>

        </dependency>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-gateway</artifactId>

        </dependency>

        <!--gson-->

        <dependency>

            <groupId>com.google.code.gson</groupId>

            <artifactId>gson</artifactId>

        </dependency>

        <!--服务调用-->

        <dependency>

            <groupId>org.springframework.cloud</groupId>

            <artifactId>spring-cloud-starter-openfeign</artifactId>

        </dependency>

    </dependencies>

3、编写application.properties配置文件

# 服务端口

server.port=8222

# 服务名

spring.application.name=service-gateway

# nacos服务地址

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848


#使用服务发现路由

spring.cloud.gateway.discovery.locator.enabled=true


#设置路由id

#spring.cloud.gateway.routes[0].id=service-acl

#设置路由的uri  lb://nacos注册服务名称

#spring.cloud.gateway.routes[0].uri=lb://service-acl

#设置路由断言,代理servicerId为auth-service的/auth/路径

#spring.cloud.gateway.routes[0].predicates= Path=/*/acl/**


#配置service-edu服务

spring.cloud.gateway.routes[0].id=service-edu

spring.cloud.gateway.routes[0].uri=lb://service-edu

spring.cloud.gateway.routes[0].predicates=Path=/eduservice/**

#配置service-edu服务

spring.cloud.gateway.routes[1].id=service-msm

spring.cloud.gateway.routes[1].uri=lb://service-msm

spring.cloud.gateway.routes[1].predicates=Path=/edumsm/**

#配置service-cms服务

spring.cloud.gateway.routes[2].id=service-cms

spring.cloud.gateway.routes[2].uri=lb://service-cms

spring.cloud.gateway.routes[2].predicates=Path=/educms/**

...................(后面需要再进行配置)

或yml文件：

server:

    port:8222


spring:

  application:

  cloud:

       gateway:

           discovery:

               locator:

                    enabled:true

         routes:

        -id: SERVICE-ACL

         uri: lb://SERVICE-ACL

         predicates:

         -Path=/*/acl/**# 路径匹配

        -id: SERVICE-EDU

         uri: lb://SERVICE-EDU

         predicates:

         -Path=/eduservice/**# 路径匹配

       -id: SERVICE-UCENTER

        uri: lb://SERVICE-UCENTER

        predicates:

       -Path=/ucenter/**# 路径匹配

   nacos:

     discovery:

        server-addr:127.0.0.1:8848

4、编写启动类

@SpringBootApplication

@EnableDiscoveryClient

public class ApiGatewayApplication {

    public static void main(String[] args) {

        SpringApplication.run(ApiGatewayApplication.class, args);

    }

}

测试：启动service_edu和service_gateway

使用service_edu的8001端口访问：

使用service_gateway的8222端口访问：成功

负载均衡：

二、网关相关配置

1、网关解决跨域问题（固定代码）

（1）创建配置类

@Configuration

public class CorsConfig {

    @Bean

    public CorsWebFilter corsFilter() {

        CorsConfiguration config = new CorsConfiguration();

        config.addAllowedMethod("*");

        config.addAllowedOrigin("*");

        config.addAllowedHeader("*");

        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());

        source.registerCorsConfiguration("/**", config);

        return new CorsWebFilter(source);

    }

}

#######配置过这个解决跨域的类之后，就不需要在controller上添加@CrossOrigin注解，否则会报错。#####

测试：把端口号修改为网关的端口

Access to XMLHttpRequest at 'http://localhost:8222/eduservice/user/login' from origin 'http://localhost:9528' has been blocked by CORS policy: The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

删除@CrossOrigin注解或者删除跨域配置类即可。

2、全局Filter，统一处理会员登录与外部不允许访问的服务

AuthGlobalFilter：

package com.atguigu.gateway.filter;

import com.google.gson.JsonObject;

import org.springframework.cloud.gateway.filter.GatewayFilterChain;

import org.springframework.cloud.gateway.filter.GlobalFilter;

import org.springframework.core.Ordered;

import org.springframework.core.io.buffer.DataBuffer;

import org.springframework.http.server.reactive.ServerHttpRequest;

import org.springframework.http.server.reactive.ServerHttpResponse;

import org.springframework.stereotype.Component;

import org.springframework.util.AntPathMatcher;

import org.springframework.web.server.ServerWebExchange;

import reactor.core.publisher.Mono;

import java.nio.charset.StandardCharsets;

import java.util.List;

/**

* <p>

* 全局Filter，统一处理会员登录与外部不允许访问的服务

* </p>

*

* @author qy

* @since 2019-11-21

*/

@Component

public class AuthGlobalFilter implements GlobalFilter, Ordered {

    private AntPathMatcher antPathMatcher = new AntPathMatcher();

    @Override

    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        ServerHttpRequest request = exchange.getRequest();

        String path = request.getURI().getPath();

        //谷粒学院api接口，校验用户必须登录

        if(antPathMatcher.match("/api/**/auth/**", path)) {

            List<String> tokenList = request.getHeaders().get("token");

            if(null == tokenList) {

                ServerHttpResponse response = exchange.getResponse();

                return out(response);

            } else {

//                Boolean isCheck = JwtUtils.checkToken(tokenList.get(0));

//                if(!isCheck) {

                    ServerHttpResponse response = exchange.getResponse();

                    return out(response);

//                }

            }

        }

        //内部服务接口，不允许外部访问

        if(antPathMatcher.match("/**/inner/**", path)) {

            ServerHttpResponse response = exchange.getResponse();

            return out(response);

        }

        return chain.filter(exchange);

    }

    @Override

    public int getOrder() {

        return 0;

    }

    private Mono<Void> out(ServerHttpResponse response) {

        JsonObject message = new JsonObject();

        message.addProperty("success", false);

        message.addProperty("code", 28004);

        message.addProperty("data", "鉴权失败");

        byte[] bits = message.toString().getBytes(StandardCharsets.UTF_8);

        DataBuffer buffer = response.bufferFactory().wrap(bits);

        //response.setStatusCode(HttpStatus.UNAUTHORIZED);

        //指定编码，否则在浏览器中会中文乱码

        response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");

        return response.writeWith(Mono.just(buffer));

    }

}

3、自定义异常处理

服务网关调用服务时可能会有一些异常或服务不可用，它返回错误信息不友好，需要我们覆盖处理。

ErrorHandlerConfig：

package com.atguigu.gateway.handler;

import org.springframework.beans.factory.ObjectProvider;

import org.springframework.boot.autoconfigure.web.ResourceProperties;

import org.springframework.boot.autoconfigure.web.ServerProperties;

import org.springframework.boot.context.properties.EnableConfigurationProperties;

import org.springframework.boot.web.reactive.error.ErrorAttributes;

import org.springframework.boot.web.reactive.error.ErrorWebExceptionHandler;

import org.springframework.context.ApplicationContext;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.core.Ordered;

import org.springframework.core.annotation.Order;

import org.springframework.http.codec.ServerCodecConfigurer;

import org.springframework.web.reactive.result.view.ViewResolver;

import java.util.Collections;

import java.util.List;

/**

* 覆盖默认的异常处理

*

* @author yinjihuan

*

*/

@Configuration

@EnableConfigurationProperties({ServerProperties.class, ResourceProperties.class})

public class ErrorHandlerConfig {

    private final ServerProperties serverProperties;

    private final ApplicationContext applicationContext;

    private final ResourceProperties resourceProperties;

    private final List<ViewResolver> viewResolvers;

    private final ServerCodecConfigurer serverCodecConfigurer;

    public ErrorHandlerConfig(ServerProperties serverProperties,

                                    ResourceProperties resourceProperties,

                                    ObjectProvider<List<ViewResolver>> viewResolversProvider,

                                        ServerCodecConfigurer serverCodecConfigurer,

                                    ApplicationContext applicationContext) {

        this.serverProperties = serverProperties;

        this.applicationContext = applicationContext;

        this.resourceProperties = resourceProperties;

        this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);

        this.serverCodecConfigurer = serverCodecConfigurer;

    }

    @Bean

    @Order(Ordered.HIGHEST_PRECEDENCE)

    public ErrorWebExceptionHandler errorWebExceptionHandler(ErrorAttributes errorAttributes) {

        JsonExceptionHandler exceptionHandler = new JsonExceptionHandler(

                errorAttributes,

                this.resourceProperties,

                this.serverProperties.getError(),

                this.applicationContext);

        exceptionHandler.setViewResolvers(this.viewResolvers);

        exceptionHandler.setMessageWriters(this.serverCodecConfigurer.getWriters());

        exceptionHandler.setMessageReaders(this.serverCodecConfigurer.getReaders());

        return exceptionHandler;

    }

}

JsonExceptionHandler：

package com.atguigu.gateway.handler;

import org.springframework.boot.autoconfigure.web.ErrorProperties;

import org.springframework.boot.autoconfigure.web.ResourceProperties;

import org.springframework.boot.autoconfigure.web.reactive.error.DefaultErrorWebExceptionHandler;

import org.springframework.boot.web.reactive.error.ErrorAttributes;

import org.springframework.context.ApplicationContext;

import org.springframework.web.reactive.function.server.*;

import java.util.HashMap;

import java.util.Map;

/**

* 自定义异常处理

*

* <p>异常时用JSON代替HTML异常信息<p>

*

* @author yinjihuan

*

*/

public class JsonExceptionHandler extends DefaultErrorWebExceptionHandler {

    public JsonExceptionHandler(ErrorAttributes errorAttributes, ResourceProperties resourceProperties,

                                ErrorProperties errorProperties, ApplicationContext applicationContext) {

        super(errorAttributes, resourceProperties, errorProperties, applicationContext);

    }

    /**

    * 获取异常属性

    */

    @Override

    protected Map<String, Object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {

        Map<String, Object> map = new HashMap<>();

        map.put("success", false);

        map.put("code", 20005);

        map.put("message", "网关失败");

        map.put("data", null);

        return map;

    }

    /**

    * 指定响应处理方法为JSON处理的方法

    * @param errorAttributes

    */

    @Override

    protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {

        return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);

    }

    /**

    * 根据code获取对应的HttpStatus

    * @param errorAttributes

    */

    @Override

    protected int getHttpStatus(Map<String, Object> errorAttributes) {

        return 200;

    }

}

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 157,298评论 4赞 360
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 66,701评论 1赞 290
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 107,078评论 0赞 237
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 43,687评论 0赞 202
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 52,018评论 3赞 286
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 40,410评论 1赞 211
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 31,729评论 2赞 310
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 30,412评论 0赞 194
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 34,124评论 1赞 239
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,379评论 2赞 242
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,903评论 1赞 257
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 28,268评论 2赞 251
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 32,894评论 3赞 233
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,014评论 0赞 8
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,770评论 0赞 192
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 35,435评论 2赞 269
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 35,312评论 2赞 260