springcloud之zuul小栗子

你的名字 2022-12-17 15:53 219阅读 0赞

## 写在前面 ##

*  源码  
    [这里][Link 1]。
 *  阅读本文准备  
    本文在[这篇博文][Link 2]基础上继续分析。  
    本文会创建一个zuul的网关服务，调用之前博文中创建的服务。

## 1：创建`my-service-zuul` ##

`new`\->`module`,后续按照提示录入gav等信息，选择maven  
，java8等后finish即可，finish当前项目模块结构如下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]

## 2：设置parent ##

<parent>
        <groupId>dongshi.daddy</groupId>
        <artifactId>my-eureka</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath/> 
    </parent>

## 3：引入依赖 ##

<dependencies>
        <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-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
    </dependencies>

## 4：完整pom ##

<?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>
    
        <groupId>dongshi.daddy</groupId>
        <artifactId>my-service-zuul</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>my-service-zuul</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>dongshi.daddy</groupId>
            <artifactId>my-eureka</artifactId>
            <version>1.0-SNAPSHOT</version>
            <relativePath/> 
        </parent>
    
        <dependencies>
            <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-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
            </dependency>
        </dependencies>
    </project>

## 5：配置文件 ##

server:
      port: 8769
    
    eureka:
      client:
        serviceUrl:
          defaultZone: http://localhost:8761/eureka/
    
    spring:
      application:
        name: service-zuul
    zuul:
      routes:
        api-a:
          path: /api-a/**
          serviceId: dongshidaddy-first-ribbon
        api-b:
          path: /api-b/**
          serviceId: dongshidaddy-first-feign-client

通过`zuul.routes.{api-name}.path`设置要路由的API的路径，通过`zuul.routes.{api-name}.serviceId`设置具体处理API路径的的服务id`(在eureka服务端注册的id)`,这里存在如下的映射关系：

/api-a/** -> dongshidaddy-first-ribbon
    /api-b/** -> dongshidaddy-first-feign-client

## 6：启用相关注解 ##

@SpringBootApplication
    @EnableZuulProxy
    @EnableEurekaClient
    @EnableDiscoveryClient

作用都是启用相关的功能。

## 7：测试 ##

### 7.1：启动`my-enreka-server` ###

该服务作为`注册中心`使用。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]  
可以看到此时`No instances available`。

### 7.2：启动`myeureka-client` ###

该服务作为最终对外提供的服务的应用。注意这个不是咱们在`my-service-zuul`的`application.yml`中配置的`serviceId`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 2]  
此时服务id`DONGSHIDADDY-FIRST-EUREKA-CLIENT`就已经注册上来了。

### 7.3：启动`my-service-feign` ###

该服务就是我们在`my-service-zuul`中配置:

api-b:
          path: /api-b/**
          serviceId: dongshidaddy-first-feign-client

其中的`serviceId: dongshidaddy-first-feign-client`对应的具体服务。启动后注册信息下图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 3]

### 7.4：启动`my-service-ribbon` ###

该服务就是我们在`my-service-zuul`配置的

api-a:
          path: /api-a/**
          serviceId: dongshidaddy-first-ribbon

中的`dongshidaddy-first-ribbon`对应的具体服务，启动后eureka服务端如下图：  
![在这里插入图片描述][20201025110955748.png_pic_center]

### 7.5：启动`my-service-zuul` ###

启动后：  
![在这里插入图片描述][20201025112328704.png_pic_center]

### 7.6：访问`/api-a/**` ###

xbdeMacBook-Air:~ xb$ curl http://localhost:8769/api-a/hi?name=dongshidaddy
    hi dongshidaddy ,i am from port:8763

### 7.7：访问`/api-b/**` ###

xbdeMacBook-Air:~ xb$ curl http://localhost:8769/api-b/hi?name=dongshidaddy
    hi dongshidaddy ,i am from port:8763

## 8：增加过滤功能 ##

zuul除了路由的功能外，还支持过滤拦截功能，只需要实现`com.netflix.zuul.ZuulFilter`抽象类就可以了，如下定义:

@Component
    public class MyFilter extends ZuulFilter { 
    
        private static Logger log = LoggerFactory.getLogger(MyFilter.class);
        @Override
        public String filterType() { 
            return "pre";
        }
    
        @Override
        public int filterOrder() { 
            return 0;
        }
    
        @Override
        public boolean shouldFilter() { 
            return true;
        }
    
        @Override
        public Object run() { 
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
            Object accessToken = request.getParameter("token");
            if(accessToken == null) { 
                log.warn("token is empty");
                ctx.setSendZuulResponse(false);
                ctx.setResponseStatusCode(401);
                try { 
                    ctx.getResponse().getWriter().write("token is empty");
                }catch (Exception e){ }
    
                return null;
            }
            log.info("ok");
            return null;
        }
    }

### 8.1：测试 ###

注意重新启动`my-service-zuul`。

xbdeMacBook-Air:~ xb$ curl http://localhost:8769/api-b/hi?name=dongshidaddy
    token is empty
    xbdeMacBook-Air:~ xb$ curl "http://localhost:8769/api-b/hi?name=dongshidaddy&token=111"
    hi dongshidaddy ,i am from port:8763

## 最后：都让开，我要喝瑞幸 ##

![在这里插入图片描述][20200828090303329.png_pic_center]

[Link 1]: https://download.csdn.net/download/wang0907/13043382
[Link 2]: https://blog.csdn.net/wang0907/article/details/109245666
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221122/3bd6f4d5c72e4c4ca5e96952f42061c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221122/59f0ad4accd54b9aa5f94eda554ff82f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221122/20106789868144d199810fae6dc2e13e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221122/3180beab6bad4c71a33e89721c337299.png
[20201025110955748.png_pic_center]: /images/20221122/e31f04937e4b43298c5a40d969687a16.png
[20201025112328704.png_pic_center]: /images/20221122/50fe89d8e09949e6b2c80d3490e676be.png
[20200828090303329.png_pic_center]: /images/20221122/2d17b580f6eb4de581ff2113ef836dc7.png