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

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

2023-11-07 74
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
本文涉及的产品
云原生 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
安全网关
并发网关
阿甘兄
目录
相关文章
游仔
|
1天前
|
安全 API 数据安全/隐私保护
自学记录HarmonyOS Next DRM API 13：构建安全的数字内容保护系统
在完成HarmonyOS Camera API开发后，我深入研究了数字版权管理（DRM）技术。最新DRM API 13提供了强大的工具，用于保护数字内容的安全传输和使用。通过学习该API的核心功能，如获取许可证、解密内容和管理权限，我实现了一个简单的数字视频保护系统。该系统包括初始化DRM模块、获取许可证、解密视频并播放。此外，我还配置了开发环境并实现了界面布局。未来，随着数字版权保护需求的增加，DRM技术将更加重要。如果你对这一领域感兴趣，欢迎一起探索和进步。
游仔
42 18
1461729147809229
|
25天前
|
网络协议 API
检测指定TCP端口开放状态免费API接口教程
此API用于检测指定TCP端口是否开放，支持POST/GET请求。需提供用户ID、KEY、目标主机，可选指定端口（默认80）和地区（默认国内）。返回状态码、信息提示、检测主机、端口及状态（开放或关闭）。示例中ID和KEY为公共测试用，建议使用个人ID和KEY以享受更高调用频率。
1461729147809229
45 14
1461729147809229
|
26天前
|
API
获取网页状态码[可指定地域]免费API接口教程
该接口用于获取指定网址的访问状态码，支持从国内、香港、美国等地域节点访问。通过POST或GET请求，需提供用户ID、KEY及目标网址等参数。返回结果包括状态码和信息提示。 示例：https://cn.apihz.cn/api/wangzhan/getcode.php?id=88888888&key=88888888&type=1&url=www.apihz.cn。
1461729147809229
36 6
1461729147809229
|
26天前
|
缓存 算法 API
查询域名WHOIS信息免费API接口教程
该API用于查询顶级域名的WHOIS信息，不支持国别域名和中文域名。通过POST或GET请求，需提供用户ID、KEY及待查询域名。返回信息包括域名状态、注册商、时间等详细数据。示例与文档见官网。
1461729147809229
49 5
1461729147809229
|
26天前
|
API
icp备案查询免费API接口教程
该接口用于查询指定域名的ICP备案信息，支持POST或GET请求方式。请求时需提供用户ID、用户KEY及待查询的域名，可选参数为查询通道。响应中包含状态码、消息内容、备案号、备案主体、域名及审核时间等信息。示例中提供了GET和POST请求方式及返回数据样例。
1461729147809229
78 4
1461729147809229
|
26天前
|
API 区块链
获取指定网页基础信息【TDK】免费API接口教程
该接口用于从标准网页中提取标题、关键词、描述和图标等信息。支持POST/GET请求，需提供用户ID、KEY及目标网址等参数，可选指定访问节点。返回状态码、信息提示及提取的内容。示例与详细文档见官网。
1461729147809229
32 4
1461729147809229
|
27天前
|
API 数据格式
关帝灵签免费API接口教程
接口简介：提供随机获取一枝关帝灵签的服务，共100签。通过POST或GET请求，需提交用户ID和KEY。返回内容包括状态码、消息内容及灵签详情，如序号、吉凶、诗文等。示例请求与响应展示了使用方法和数据格式。
1461729147809229
37 5
1461729147809229
|
25天前
|
前端开发 JavaScript API
提取网页所有链接免费API接口教程
此API用于提取指定网页内的所有链接信息并进行分类，支持POST和GET请求方式。需提供用户ID、KEY及目标网址等参数，可选指定访问节点。返回结果包括状态码、信息提示及各类链接集合，如图片、视频、文档等。示例中展示了请求格式与返回数据结构。
1461729147809229
42 0
蚝油菜花
|
14天前
|
人工智能 自然语言处理 API
Multimodal Live API：谷歌推出新的 AI 接口，支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口，能够处理文本、音频和视频输入，提供自然流畅的对话体验，适用于多种应用场景。
蚝油菜花
64 3
Multimodal Live API：谷歌推出新的 AI 接口，支持多模态交互和低延迟实时互动
技术交流18179014480
|
1天前
|
JSON 安全 API
淘宝商品详情API接口（item get pro接口概述）
淘宝商品详情API接口旨在帮助开发者获取淘宝商品的详细信息，包括商品标题、描述、价格、库存、销量、评价等。这些信息对于电商企业而言具有极高的价值，可用于商品信息展示、市场分析、价格比较等多种应用场景。
技术交流18179014480
26 3

热门文章

最新文章

  • 1
    👀探秘微服务：从零开启网关 SSO 服务搭建之旅
  • 2
    项目中用的网关Gateway及SpringCloud
  • 3
    多协议网关BL110钡铼6路RS485转MQTT协议云网关
  • 4
    小红书详情API接口的获取与应用
  • 5
    Python调用API接口的方法
  • 6
    实时获取小红书详情 API 数据
  • 7
    淘宝实时 API 接口丨淘宝商品详情接口（Taobao.item_get）
  • 8
    基于百炼平台qwen-max的api 打造一套 检索增强 图谱增强 基于指令的智能工具调用决策 智能体
  • 9
    GLM-4V-Flash：智谱 AI 免费开放的图像理解大模型 API 接口
  • 10
    API 数据接口使用与安全指南
  • 1
    Java Stream API详解与使用
    99
  • 2
    Kubernetes学习-集群搭建篇(三) Node配置完善和API概述
    86
  • 3
    HTML5 Canvas 提供丰富的绘图API，支持绘制图形、文本、渐变和图像，助力游戏开发
    76
  • 4
    Java 8新特性之Lambda表达式与Stream API的深度解析
    103
  • 5
    Linux系统编程之文件编程常用API回顾和文件编程一般步骤
    85
  • 6
    阿里云微服务引擎及 API 网关 2024 年 4 月产品动态
    394
  • 7
    阿里云微服务引擎 MSE 及 API 网关 2024 年 04 月产品动态
    276
  • 8
    智能体-Agent能力升级！新增Assistant API & Tools API服务接口
    560
  • 9
    使用Performance API进行性能监控
    114
  • 10
    RESTful API的最佳实践
    67

    • 相关课程

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

    • 相关电子书

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

    • 相关实验场景

    更多
  • 基于Assistant Api的旅游助手
  • 快速体验智能体API应用
  • 通过HTTPS加速网关快速部署网站加密
    • 下一篇
    手把手教你白嫖阿里云服务器(免费领服务器)