SpringCloud微服务小白也能搭(Hoxton.SR8)（六）Zuul|服务网关

简单上手，直接照搬，就可搭建微服务(Hoxton.SR8) 2020.8.28发布，SpringCloud搭建的文章正在整理，干货不要错过哦

• SpringCloud微服务小白也能搭(Hoxton.SR8)（一）Eureka|服务的注册与发现

• SpringCloud微服务小白也能搭(Hoxton.SR8)（二）Ribbon|服务消费者

• SpringCloud微服务小白也能搭(Hoxton.SR8)（三）Feign|服务消费者

• SpringCloud微服务小白也能搭(Hoxton.SR8)（四）Hystrix|断路器

• SpringCloud微服务小白也能搭(Hoxton.SR8)（五）Dashboard/Turbine|断路器监控

• SpringCloud微服务小白也能搭(Hoxton.SR8)（六）Zuul|服务网关

• SpringCloud微服务小白也能搭(Hoxton.SR8)（七）Gateway|服务网关

• SpringCloud微服务小白也能搭(Hoxton.SR8)（八）Sleuth|服务链路跟踪​​​​​​​​​​​​​​

摘要

Spring Cloud Zuul 是Spring Cloud Netflix 子项目的核心组件之一，可以作为微服务架构中的API网关使用，支持动态路由与过滤功能。API网关为微服务架构中的服务提供了统一的访问入口，客户端通过API网关访问相关服务。API网关的定义类似于设计模式中的门面模式，它相当于整个微服务架构中的门面，所有客户端的访问都通过它来进行路由及过滤。它实现了请求路由、负载均衡、校验过滤、服务容错、服务聚合等功能。

1.创建一个api-zuul模块

  

1.1 pom.xml新增 zuul依赖

 <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-netflix-zuul</artifactId>
        </dependency>
</dependencies>

 1.2 启动类新增 @EnableZuulProxy 和 @EnableDiscoveryClient

package com.zqh.www;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.core.env.Environment;

/**
 * 开启zuul代理
 */
@EnableZuulProxy
/**
 * 开启服务发现客户端
 *
 * @EnableEurekaClient只适用于Eureka作为注册中心，@EnableDiscoveryClient 可以是其他注册中心。
 */
@EnableDiscoveryClient
@SpringBootApplication
public class ApiZuulApplication {

    private final static Logger logger = LoggerFactory.getLogger(ApiZuulApplication.class);

    public static void main(String[] args) {
        Environment env = SpringApplication.run(ApiZuulApplication.class, args).getEnvironment();
        logger.info(
                "\n----------------------------------------------------------\n\t"
                        + "Application '{}' is running! Access URLs:\n\t"
                        + "Local: \t\thttp://localhost:{}{}"
                        + "\n----------------------------------------------------------",
                env.getProperty("spring.application.name"), env.getProperty("server.port"),
                env.getProperty("server.servlet.context-path") != null ? env.getProperty("server.servlet.context-path") : "");
    }
}

1.3 yml配置

server:
  port: 8092
spring:
  application:
    name: api-zuul
eureka:
  client:
    service-url:
      #注册地址
      defaultZone: http://root:root@localhost:8081/eureka/
  #显示服务器IP加端口
  instance:
    hostname: localhost
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${server.port}

zuul:
  #网关路由前缀
  prefix: /
  routes:
    # 配置服务路由
    user-service:
      path: /userService/**
    feign-service:
      path: /feignService/**
    ribbon-service:
      path: /ribbon-service/**
  #重定向添加host请求头
  add-host-header: true
  #配置过滤敏感的请求头信息，设置为空就不会过滤
  sensitive-headers: Cookie,Set-Cookie,Authorization
  #关闭默认路由配置，自动配置的路由以服务名称为匹配路径
  ignored-services: user-service
  # 关闭重试机制
  retryable: true
  LogFilter:
    pre:
      #控制是否禁用过滤器
      disable: false

1.4 拦截器

package com.zqh.www.filters;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

/**
 *
 */
@Component
public class LogFilter extends ZuulFilter {

    private static final Logger LOGGER = LoggerFactory.getLogger(LogFilter.class);

    /**
     * 过滤器类型，有pre、routing、post、error四种。
     * pre：在请求被路由到目标服务前执行，比如权限校验、打印日志等功能；
     * routing：在请求被路由到目标服务时执行，这是使用Apache HttpClient或Netflix Ribbon构建和发送原始HTTP请求的地方；
     * post：在请求被路由到目标服务后执行，比如给目标服务的响应添加头信息，收集统计数据等功能；
     * error：请求在其他阶段发生错误时执行。
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤器执行顺序，数值越小优先级越高。
     */
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * 是否进行过滤，返回true会执行过滤。
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 自定义的过滤器逻辑，当shouldFilter()返回true时会执行。
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext currentContext = RequestContext.getCurrentContext();
        HttpServletRequest request = currentContext.getRequest();
        String remoteHost = request.getRemoteHost();
        String method = request.getMethod();
        String requestURI = request.getRequestURI();
        LOGGER.info("remoteHost:{},method:{},requestURI:{}", remoteHost, method, requestURI);
        return null;
    }
}

2.网关测试

测试方式：调用网关映射的接口路径

请求：http://localhost:8092/userService/api/user/getUserList

请求：http://localhost:8092/user-service/api/user/getUserList ，原因：因为yml配置了：ignored-services: user-service，所以不能采用服务名称为匹配路径

请求：http://localhost:8092/feignService/api/feign/getUserList

请求：http://localhost:8092/feign-service/api/feign/getUserList

3.gitee地址

源码参考