AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

互联网并发与安全系列教程（15） - 基于Zuul实现API网关

2023-11-07 135
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
AI 网关免费试用，2900元额度，限量100份
云原生 API 网关，700元额度，多规格可选
简介： 互联网并发与安全系列教程（15） - 基于Zuul实现API网关

基于Zuul(网上找不到音标，读“猪”第四音)实现API网关，需要按如下步骤实现：

  1. 搭建Eureka注册中心
  2. 创建Zuul网关项目
  3. 创建A项目服务
  4. 创建B项目服务

流程示意图如下：

启动项目需要按上面顺序执行，否则会报错，下面开始讲解代码。

1. 创建Eureka注册中心

1.创建eureka_server项目

2.添加Maven依赖：

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>2.0.1.RELEASE</version>
</parent>
<!-- 管理依赖 -->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-dependencies</artifactId>
      <version>Finchley.M7</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
<dependencies>
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
  </dependency>
</dependencies>
<!-- 注意： 这里必须要添加， 否者各种依赖有问题 -->
<repositories>
  <repository>
    <id>spring-milestones</id>
    <name>Spring Milestones</name>
    <url>https://repo.spring.io/libs-milestone</url>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
  </repository>
</repositories>
<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
  </plugins>
</build>

3.application.yml 配置信息

server:
  port: 8100
eureka:
  instance:
    hostname: server1
  client:
    serviceUrl:
          defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
    register-with-eureka: false
    fetch-registry: false

4.启动类

@SpringBootApplication
@EnableEurekaServer
public class EurekaApplication {
  public static void main(final String[] args) {
    SpringApplication.run(EurekaApplication.class, args);
  }
}

2. 创建Zuul网关

1.创建zuul-gateway maven项目

2.添加maven依赖：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.RELEASE</version>
    <relativePath /> <!-- lookup parent from repository -->
  </parent>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <spring-cloud.version>Finchley.RC1</spring-cloud.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <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-ribbon</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.3</version>
    </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>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.0.1</version>
        <executions>
          <execution>
            <id>copy-conf</id>
            <phase>package</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <encoding>UTF-8</encoding>
              <outputDirectory>${project.build.directory}/ext/conf</outputDirectory>
              <resources>
                <resource>
                  <directory>ext/conf</directory>
                  <includes>
                    <include>logback.xml</include>
                  </includes>
                  <filtering>true</filtering>
                </resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.7.5.201505241946</version>
        <executions>
          <execution>
            <id>default-prepare-agent</id>
            <goals>
              <goal>prepare-agent</goal>
            </goals>
          </execution>
          <execution>
            <id>default-prepare-agent-integration</id>
            <goals>
              <goal>prepare-agent-integration</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>com.spotify</groupId>
        <artifactId>docker-maven-plugin</artifactId>
        <version>0.4.3</version>
        <configuration>
          <imageName>hy_uav_gateway</imageName>
          <dockerDirectory>src/main/docker</dockerDirectory>
          <resources>
            <resource>
              <targetPath>/</targetPath>
              <directory>${project.build.directory}</directory>
              <include>${project.build.finalName}.jar</include>
              <include>ext/conf/logback.xml</include>
            </resource>
          </resources>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <repositories>
    <repository>
      <id>spring-milestones</id>
      <name>Spring Milestones</name>
      <url>https://repo.spring.io/milestone</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
  </repositories>

3.配置application 依赖信息

###注册 中心
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8100/eureka/
server:
  port: 80
###网关名称
spring:
  application:
    name: service-zuul
### 配置网关反向代理    
zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: project_a
    api-b:
      path: /api-b/**
      serviceId: project_b

4.ZuulApplication启动运行，并把过滤器拦截注册到SpringBoot容器

@EnableZuulProxy
@EnableEurekaClient
@SpringBootApplication
public class AppZuul {
  // @EnableZuulProxy 开启Zuul网关代理
  // @EnableEurekaClient 注册到EurekaC
  public static void main(String[] args) {
    SpringApplication.run(AppZuul.class, args);
  }
  // 注册到SpringBoot 容器
  @Bean
  public TokenFilter accessFilter() {
    return new TokenFilter();
  }
}

5.过滤器拦截参数

// 使用网关拦截Token参数
public class TokenFilter extends ZuulFilter {
  public Object run() throws ZuulException {
    RequestContext ctx = RequestContext.getCurrentContext();
    HttpServletRequest request = ctx.getRequest();
    Object accessToken = request.getParameter("accessToken");
    if (accessToken == null) {
      // 返回错误信息
      ctx.setSendZuulResponse(false);
      ctx.setResponseStatusCode(401);
      ctx.setResponseBody("accessToken is null");
      return null;
    }
    return null;
  }
  public boolean shouldFilter() {
    return true;// 是否执行该过滤器，此处为true，说明需要过滤
  }
  @Override
  public int filterOrder() {
    return 0;// 优先级为0，数字越大，优先级越低
  }
  @Override
  public String filterType() {
    return "pre"; // 前置过滤器
  }
}

3. 创建A项目及B项目

A服务与B服务的创建方式大同小异，以A项目为例子：

1.创建api-a项目

2.添加maven依赖：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.1.RELEASE</version>
    <relativePath /> <!-- lookup parent from repository -->
  </parent>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
    <spring-cloud.version>Finchley.RC1</spring-cloud.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <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-ribbon</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <optional>true</optional>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.3</version>
    </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>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.0.1</version>
        <executions>
          <execution>
            <id>copy-conf</id>
            <phase>package</phase>
            <goals>
              <goal>copy-resources</goal>
            </goals>
            <configuration>
              <encoding>UTF-8</encoding>
              <outputDirectory>${project.build.directory}/ext/conf</outputDirectory>
              <resources>
                <resource>
                  <directory>ext/conf</directory>
                  <includes>
                    <include>logback.xml</include>
                  </includes>
                  <filtering>true</filtering>
                </resource>
              </resources>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.jacoco</groupId>
        <artifactId>jacoco-maven-plugin</artifactId>
        <version>0.7.5.201505241946</version>
        <executions>
          <execution>
            <id>default-prepare-agent</id>
            <goals>
              <goal>prepare-agent</goal>
            </goals>
          </execution>
          <execution>
            <id>default-prepare-agent-integration</id>
            <goals>
              <goal>prepare-agent-integration</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>com.spotify</groupId>
        <artifactId>docker-maven-plugin</artifactId>
        <version>0.4.3</version>
        <configuration>
          <imageName>hy_uav_gateway</imageName>
          <dockerDirectory>src/main/docker</dockerDirectory>
          <resources>
            <resource>
              <targetPath>/</targetPath>
              <directory>${project.build.directory}</directory>
              <include>${project.build.finalName}.jar</include>
              <include>ext/conf/logback.xml</include>
            </resource>
          </resources>
        </configuration>
      </plugin>
    </plugins>
  </build>
  <repositories>
    <repository>
      <id>spring-milestones</id>
      <name>Spring Milestones</name>
      <url>https://repo.spring.io/milestone</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
  </repositories>

3.配置application 依赖信息（b项目名字为：project_b）

server:
  port: 8001
###服务名称
spring:
    application:
        name: project_a
###注册中心地址
eureka:
  client:
    service-url:
           defaultZone: http://localhost:8100/eureka

4.启动类（b项目index方法返回“我是B项目”）

@SpringBootApplication
@EnableDiscoveryClient
@RestController
public class AIndexController {
  @RequestMapping("/")
  public String index() {
    return "我是A项目....";
  }
  public static void main(String[] args) {
    SpringApplication.run(AIndexController.class, args);
  }
}

4. 测试

4.1 运行Eureka注册中心

启动应用：http://localhost:8100/，可以看到Eureka注册中心管理平台。

4.2 运行Zuul网关

会发现Zuul网关注册上Eureka中心了

4.3 运行A项目和B项目

可以看到项目A和项目B都注册上Eureka中心了

4.4 访问测试

浏览器输入http://localhost/api-a，返回内容如下

可以看出tonken为null，要加token。

访问：http://localhost/api-a?token=123456

访问：http://localhost/api-b?token=123456

文章标签：
API 网关
API
安全
Java
Maven
容器
关键词：
教程API
并发API
安全API
安全网关
并发网关
阿甘兄
目录
相关文章
一个幽默的程序员
|
15天前
|
人工智能 数据可视化 测试技术
Postman 性能测试教程：快速上手 API 压测
本文介绍API上线后因高频调用导致服务器告警，通过Postman与Apifox进行压力测试排查性能瓶颈。对比两款工具在批量请求、断言验证、可视化报告等方面的优劣，探讨API性能优化策略及行业未来发展方向。
一个幽默的程序员
101 0
Postman 性能测试教程：快速上手 API 压测
HELLO程序员
|
27天前
|
消息中间件 JSON Java
高效的并发管理：房间预订 API 的乐观锁和消息队列
本文探讨了在高并发场景下酒店预订系统的挑战，重点分析了乐观锁定和消息队列两种策略。通过代码示例展示了如何使用 Spring Boot 和 RabbitMQ 实现异步流程，以及如何通过乐观锁和 ReentrantLock 避免超卖问题，从而确保系统在多用户同时请求时的稳定性与数据一致性。
HELLO程序员
41 0
高效的并发管理：房间预订 API 的乐观锁和消息队列
1461729147809229
|
3月前
|
JSON 监控 API
在线网络PING接口检测服务器连通状态免费API教程
接口盒子提供免费PING检测API，可测试域名或IP的连通性与响应速度，支持指定地域节点，适用于服务器运维和网络监控。
1461729147809229
314 0
1461729147809229
|
3月前
|
JSON API PHP
通用图片搜索API：百度源免费接口教程
本文介绍一款基于百度图片搜索的免费API接口，由接口盒子提供。支持关键词搜索，具备详细请求与返回参数说明，并提供PHP及Python调用示例。开发者可快速集成实现图片搜索功能，适用于内容聚合、素材库建设等场景。
1461729147809229
337 0
1461729147809229
|
3月前
|
JSON 机器人 API
随机昵称网名API接口教程：轻松获取百万创意昵称库
接口盒子提供随机昵称网名API，拥有百万级中文昵称库，支持聊天机器人、游戏角色等场景的昵称生成。提供详细调用指南及多语言示例代码，助力开发者高效集成。
1461729147809229
164 0
上云小帮手
|
28天前
|
人工智能 API 开发者
图文教程：阿里云百炼API-KEY获取方法，亲测全流程
本文详细介绍了如何获取阿里云百炼API-KEY，包含完整流程与截图指引。需先开通百炼平台及大模型服务，再通过控制台创建并复制API-KEY。目前平台提供千万tokens免费额度，适合开发者快速上手使用。
上云小帮手
505 5
1461729147809229
|
3月前
|
存储 JSON API
文本存储免费API接口教程
接口盒子提供免费文本存储服务，支持1000条记录，每条最多5000字符，适用于公告、日志、配置等场景，支持修改与读取。
1461729147809229
101 0
1461729147809229
|
3月前
|
数据采集 JSON 监控
获取网页状态码（可指定地域）免费API接口教程
本文介绍如何使用接口盒子的免费API获取网页状态码，支持国内、香港、美国等不同地域访问节点。内容包括接口参数、调用方法及示例，适用于网站监控、链接检查等场景。
1461729147809229
248 0
兵临天下19970108016
|
2月前
|
JSON API 数据安全/隐私保护
深度分析淘宝卖家订单详情API接口，用json返回数据
淘宝卖家订单详情API（taobao.trade.fullinfo.get）是淘宝开放平台提供的重要接口，用于获取单个订单的完整信息，包括订单状态、买家信息、商品明细、支付与物流信息等，支撑订单管理、ERP对接及售后处理。需通过appkey、appsecret和session认证，并遵守调用频率与数据权限限制。本文详解其使用方法并附Python调用示例。
兵临天下19970108016
343 57
一个幽默的程序员
|
21天前
|
数据可视化 测试技术 API
从接口性能到稳定性：这些API调试工具，让你的开发过程事半功倍
在软件开发中，接口调试与测试对接口性能、稳定性、准确性及团队协作至关重要。随着开发节奏加快，传统方式已难满足需求，专业API工具成为首选。本文介绍了Apifox、Postman、YApi、SoapUI、JMeter、Swagger等主流工具，对比其功能与适用场景，并推荐Apifox作为集成度高、支持中文、可视化强的一体化解决方案，助力提升API开发与测试效率。
一个幽默的程序员
351 122

热门文章

最新文章

  • 1
    稳定支撑大规模模型调用，携程旅游的 AI 网关实践
  • 2
    Dify 性能瓶颈？Higress AI 网关为它注入「高可用之魂」！
  • 3
    阿里云微服务引擎 MSE 及 API 网关 2025 年 8 月产品动态
  • 4
    Python采集淘宝评论API接口及JSON数据返回全流程指南
  • 5
    阿里云百炼API-KEY在哪查询？如何获取阿里云AI百炼大模型的API-KEY？
  • 6
    图文教程：阿里云百炼API-KEY获取方法，亲测全流程
  • 7
    基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
  • 8
    从接口性能到稳定性：这些API调试工具，让你的开发过程事半功倍
  • 9
    掌握使用 requests 库发送各种 HTTP 请求和处理 API 响应
  • 10
    告别旅行规划的"需求文档地狱"！这个AI提示词库，让你像调API一样定制完美旅程
  • 1
    API 别乱跑：自动化运维里的流量管理秘籍
    69
  • 2
    如何调用体育数据足篮接口API
    78
  • 3
    揭秘天猫详情 API 接口：开启电商数据新大门
    44
  • 4
    淘宝关键词搜索与商品详情API接口（JSON数据返回）
    92
  • 5
    揭秘京东详情 API 接口：技术开发者的宝藏之门
    37
  • 6
    探秘1688详情API接口：解锁无限应用场景的技术密钥
    32
  • 7
    揭秘淘宝详情 API 接口：解锁电商数据应用新玩法
    72
  • 8
    Midjourney 技术拆解与阿里云开发者实战指南：从扩散模型到 API 批量生成
    193
  • 9
    Java新特性：使用Stream API重构你的数据处理
    204
  • 10
    汽车配件：使用VIN码查询API精准匹配车型配件，提升用户信任
    230

    • 相关课程

    更多
  • 使用Higress AI网关优化AI调用成本
  • 从概念、部署到优化，Kubernetes Ingress 网关的落地实践

    • 相关电子书

    更多
  • 阿里云容器 AHAS Sentinel 网关流控揭秘
  • 阿里Tengine网关最佳实践
  • 《MSE 微服务网关》

    • 相关实验场景

    更多
  • 基于Assistant Api的旅游助手
  • 快速体验智能体API应用
  • 通过云原生API网关进行AI缓存
  • 通过云原生API网关实现Token管控
    • 下一篇
    深度 | 从0到3.0，揭秘阿里云洛神云网络的进化之路