springcloud之zuul网关-优快云博客

本文链接：https://blog.youkuaiyun.com/weixin_45174537/article/details/103497884

本章目标

Zuul路由网关简介及基本使用
Zuul路由映射配置
Zuul请求过滤配置
zuul的服务断路处理

Zuul路由网关简介及基本使用

简介

Zuul API路由网关服务简介

在这里插入图片描述
请看上图，这里的API 路由网关服务由Zuul实现，主要就是对外提供服务接口的时候，起到了请求的路由和过滤作用，也因此能够隐藏内部服务的接口细节，从来有利于保护系统的安全性；

Zuul 路由配置

增加一个zuul项目： microservice-zuul-3001

pom.xml增加了:

	 <!--zuul网关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

全部的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.cgl</groupId>
        <artifactId>microservice</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>microservice-zuul-3001</artifactId>
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!--相当于全局的一个依赖关系，这个导入能确保整个项目使用的包版本一致
            比如全局中的： spring-cloud-dependencies
                           spring-boot-dependencies
                           druid-spring-boot-starter
        -->
        <dependency>
            <groupId>com.cgl</groupId>
            <artifactId>microservice-common</artifactId>
        </dependency>
        <!--处理web请求-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--test测试的包-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- actuator监控引入，点击后的追责 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!--添加注册中心Eureka相关配置,就是说这个是客户端-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <!--Hystrix相关依赖,用来处理服务处理异常情况-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
        <!--zuul网关-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

        <!-- Hystrix，Feign是基于Hystrix的 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

yml文件的配置

server:
  port: 3001
  context-path: /
spring:
  application:
    name: microservice-zuul
eureka:
  instance:
    instance-id: microservice-zuul:3001
    prefer-ip-address: true
  client:
    service-url:
      defaultZone: http://eureka2001.cgl.com:2001/eureka/,http://eureka2002.cgl.com:2002/eureka/,http://eureka2003.cgl.com:2003/eureka/
info:
  groupId: com.cgl.testSpringcloud
  artifactId: microservice-zuul-3001
  version: 1.0-SNAPSHOT
  userName: http://cgl.com
  phone: 123456

启动类:

加下@EnableZuulProxy注解

package com.cgl.microservicezuul3001;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})//不用数据库
@EnableZuulProxy //zuul注解配置
public class MicroserviceZuul3001Application {

    public static void main(String[] args) {
        SpringApplication.run(MicroserviceZuul3001Application.class, args);
    }

}

ok，可以直接输入：
http://zuul.cgl.com:3001/microservice-student/student/hystrix
记得要修改host
在这里插入图片描述

Zuul路由映射配置

隐藏真实请求路径

上面是zuul的简单使用，从接口地址很轻易的就暴露了服务提供者的唯一标识名microservice-student；有安全风险，我们需要将其隐藏；
ignored-services的作用是将原来的服务提供者唯一标识名禁用；
Prefix的作用是给服务加前缀

在yml文件中加上：

zuul:
  routes:
    studentServer.serviceId: microservice-student
    studentServer.path: /studentServer/**
  ignored-services: "*"
  prefix: /cgl

那么我的一个请求就变成了：

http://zuul.cgl.com:3001/cgl/studentServer/student/hystrix

Zuul请求过滤配置

比如我们登录某个系统需要身份验证，用户名密码啥的；

我们请求服务，也可以来设置身份验证，也就是过滤非法请求；Zuul通过ZuulFilter过滤器实现；
一般具体实现的话每次经过Zuul服务网关我们都对带来的token进行有效性验证；

AccessFilter

package com.cgl.microservicezuul3001.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.log4j.Logger;

import javax.servlet.http.HttpServletRequest;


public class AccessFilter extends ZuulFilter {

    Logger logger=Logger.getLogger(AccessFilter.class);

    /**
     * 判断该过滤器是否要被执行
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体执行逻辑
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        String parameter = request.getParameter("accessToken");
        logger.info(request.getRequestURL().toString()+" 请求访问");
        if(parameter==null){
            logger.error("accessToken为空！");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            ctx.setResponseBody("{\"result\":\"accessToken is empty!\"}");
            return null;
        }
        //  token判断逻辑
        logger.info(request.getRequestURL().toString()+" 请求成功");
        return null;
    }

    /**
     * 过滤器的类型 这里用pre，代表会再请求被路由之前执行
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤器的执行顺序
     */
    @Override
    public int filterOrder() {
        return 0;
    }

}

ZuulConfig

package com.cgl.microservicezuul3001.config;

import com.cgl.microservicezuul3001.filter.AccessFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class ZuulConfig {

    @Bean
    public AccessFilter accessFilter(){
        return new AccessFilter();
    }
}

那么请求路径就为
http://zuul.cgl.com:3001/cgl/studentServer/student/hystrix?accessToken=1

有的时候
在这里插入图片描述
没有的时候

zuul的服务断路处理

这个有两种方法:

Zuul作为服务网关为了保证自己不被服务拖垮，本身已经集成了Hystrix对路由转发进行隔离。为了方便开发人员对服务短路进行自定义处理，

ZuulFallbackProvider ：Zuul 提供了 ZuulFallbackProvider 接口，开发人员可以通过实现该接口来完成自定义Hystrix Fallback

FallbackProvider ：Spring Cloud Zuul 提供了 FallbackProvider替代了ZuulFallbackProvider接口。

但是本次本次只使用ZuulFallbackProvider接口来演示

ZuulFallBack

package com.cgl.microservicezuul3001.fallback;

import org.springframework.cloud.netflix.zuul.filters.route.ZuulFallbackProvider;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;

@Component
public class ZuulFallBack implements ZuulFallbackProvider {

    @Override
    public String getRoute() {
        return "*";
    }

    /**
     * 在给zuul整合回退功能时，只要类实现ZuulFallbackProvider接口，并且注册bean即可。
     *
     * 不过需要注意的时，这个回退只有服务掉线或者超时的情况下才会触发（Camden.SR4版本测试是这样），
     * 如果服务程序出现异常，此回退程序是不能处理的，异常会直接返回给调用者，比如页面。
     *
     * @return
     */
    @Override
    public ClientHttpResponse fallbackResponse() {
        return new ClientHttpResponse() {
            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.APPLICATION_JSON_UTF8);//application/json;charset=UTF-8
                return headers;
            }

            @Override
            public InputStream getBody() throws IOException {
                String msg = "服务繁忙，请稍后.....";
                //new ByteArrayInputStream("{\"code\":-1,\"msg\":\"服务暂不可用\"}".getBytes(StandardCharsets.UTF_8))
                return new ByteArrayInputStream(msg.getBytes());
            }

            @Override
            public String getStatusText() throws IOException {
                return HttpStatus.BAD_REQUEST.getReasonPhrase();//400
            }

            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST.value();//"Bad Request"
            }

            @Override
            public void close() {

            }
        };
    }
}

方法名	说明
getRoute()	该Provider应用的Route ID，例如：testservice，如果设置为 * ，那就对所有路由生效
fallbackResponse()	快速回退失败/响应，即处理异常并返回对应输出/响应内容。