＜六＞spring-cloud Hoxton.SR2 网关组件zuul搭建使用

比眉伴天荒 2021-09-23 17:30 125阅读 0赞

# <六>spring-cloud Hoxton.SR2 网关组件zuul搭建使用 #

### 文章目录 ###

*  <六>spring-cloud Hoxton.SR2 网关组件zuul搭建使用
 *   *  1、项目搭建
     *   *  1.1、搭建新的项目\`badger-spring-cloud-zuul\`，pom文件如下
         *  1.2、主类上加网关注解\`@EnableZuulProxy\`和eureka的注解\`@EnableEurekaClient\`
         *  1.3、yaml的配置文件
     *  2、项目启动，测试使用

本地项目的基础环境

<table> 
 <thead> 
  <tr> 
   <th align="center">环境</th> 
   <th align="center">版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">jdk</td> 
   <td align="center">1.8.0_201</td> 
  </tr> 
  <tr> 
   <td align="center">maven</td> 
   <td align="center">3.6.0</td> 
  </tr> 
  <tr> 
   <td align="center">Spring-boot</td> 
   <td align="center">2.2.4.RELEASE</td> 
  </tr> 
  <tr> 
   <td align="center">Spring-cloud</td> 
   <td align="center">Hoxton.SR2</td> 
  </tr> 
 </tbody> 
</table>

本次例子是基于上一次构建的`badger-spring-cloud-api`项目的基础上，使用的；

[《<一>spring-cloud Hoxton.SR2版 服务注册与发现–eureka搭建以及集群搭建》][spring-cloud Hoxton.SR2_ _eureka]

[《<二>spring-cloud Hoxton.SR2 负载均衡ribbon搭建使用》][spring-cloud Hoxton.SR2 _ribbon]

[《<三>spring-cloud Hoxton.SR2 负载均衡openfeign搭建使用》][spring-cloud Hoxton.SR2 _openfeign]

[《<四>spring-cloud Hoxton.SR2 断路器hystrix搭建使用》][spring-cloud Hoxton.SR2 _hystrix]

[《<五>spring-cloud Hoxton.SR2 hystrix Dashboard监控搭建使用》][spring-cloud Hoxton.SR2 hystrix Dashboard]

具体代码信息，可以查看《[码云》][Link 1]

## 1、项目搭建 ##

### 1.1、搭建新的项目`badger-spring-cloud-zuul`，pom文件如下 ###

主要是新增注册中心eureka的包`spring-cloud-starter-netflix-eureka-client`，网关zuul的包`spring-cloud-starter-netflix-zuul`

<?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>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.2.4.RELEASE</version>
            <relativePath /> 
        </parent>
        <groupId>com.badger</groupId>
        <artifactId>badger-spring-cloud-zuul</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>badger-spring-cloud-zuul</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <maven-jar-plugin.version>3.1.1</maven-jar-plugin.version>
            <spring-cloud.version>Hoxton.SR2</spring-cloud.version>
        </properties>
    
        <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>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

### 1.2、主类上加网关注解`@EnableZuulProxy`和eureka的注解`@EnableEurekaClient` ###

/** * @EnableEurekaClient 标记为eureka的客户端 * @EnableZuulProxy 开启zuul网关代理 * @author liqi * */
    @SpringBootApplication
    @EnableEurekaClient
    @EnableZuulProxy
    public class ZuulApplication { 
    
        public static void main(String[] args) throws Exception { 
            SpringApplication.run(ZuulApplication.class, args);
        }
    }

### 1.3、yaml的配置文件 ###

server:
      port: 9000
    eureka:
      client:
        serviceUrl:
          defaultZone: http://172.16.2.50:8761/eureka/
      instance:
        instance-id: ${ spring.cloud.client.ip-address}:${ server.port}
        prefer-ip-address: true
    spring:
      application:
        name: '@project.name@'
    zuul:
      prefix: /badger  #前缀，默认为空的字符串
      ignored-services: '*' #隐藏（忽略）其他的没有被网关暴露的其他的所有的路径
      routes:
        api: #应用的别名
          path: /api/** #服务的路径的映射名字
          service-id: badger-spring-cloud-api #被访问的应用

到这里，项目就搭建完成了

## 2、项目启动，测试使用 ##

启动步骤如下：

1.  启动eureka的服务，端口8761；
2.  修改yaml的配置文件，启动端口为7001，启动服务的提供者badger-spring-cloud-api；
3.  启动服务的消费者badger-spring-cloud-zuul，端口为9000；

访问地址http://localhost:9000/badger/api/demo可以看到结果

`我的地址是-->172.16.2.50:7001`；表示测试成功

解释下访问地址http://localhost:9000/badger/api/demo的路由，配合上述的yaml的配置文件一起观察

`badger`：在zuul.prefix=/badger 表示访问的前缀，默认为空字符串

`api`：在zuul.routes.api.path=/api/\*\* 表示被访问的应用（eureka中注册的名称）`badger-spring-cloud-api`的访问路径；

`demo`：表示应用`badger-spring-cloud-api`的controller的访问路由

最后说下`zuul.ignored-services='*'`属性的意义

既然我们能使用`zuul.routes.api.path=/api/**`的api替换应用的`badger-spring-cloud-api`，那么可以直接使用`badger-spring-cloud-api`访问？答案是可以的，访问地址如下

http://localhost:9000/badger/badger-spring-cloud-api/demo

可以看到，访问不成功；找不到访问的路由；

![13235d8134c71ab8d2f082bea7d89793.png][]

主要是原因，就是`zuul.ignored-services='*'`属性，隐藏（忽略）其他的没有被网关暴露的其他的所有的路径；我们把这个属性注释掉，重启zuul的项目，再次访问，就可以成功了；

具体代码信息，可以查看《[码云》][Link 1]

[spring-cloud Hoxton.SR2_ _eureka]: https://blog.csdn.net/qq_28410283/article/details/100891529
[spring-cloud Hoxton.SR2 _ribbon]: https://blog.csdn.net/qq_28410283/article/details/102631536
[spring-cloud Hoxton.SR2 _openfeign]: https://blog.csdn.net/qq_28410283/article/details/102721520
[spring-cloud Hoxton.SR2 _hystrix]: https://blog.csdn.net/qq_28410283/article/details/102864239
[spring-cloud Hoxton.SR2 hystrix Dashboard]: https://blog.csdn.net/qq_28410283/article/details/103766142
[Link 1]: https://gitee.com/liqi01/badger-spring-cloud
[13235d8134c71ab8d2f082bea7d89793.png]: /images/20210923/06354ea5d549405c8d2b8421191f28dc.png