Apisix 网关快速入门实践

2022-11-18
上海
本文字数：2160 字
阅读完需：约 7 分钟

一、Apisix 简介

APISIX 是一个微服务 API 网关，具有高性能、可扩展性等优点。它基于 nginx（openresty）、Lua、etcd 实现功能，借鉴了 Kong 的思路。和传统的 API 网关相比，APISIX 具有较高的性能和较低的资源消耗，并且具有丰富的插件，也方便自己进行插件扩展。

（软件架构图）

二、网关搭建

Docker 安装方式

2.1 下载 apisix-docker 仓库

git clone https://github.com/apache/apisix-docker.git
cd apisix-docker/example

2.2 docker-compose 启用 APISIX

docker-compose -p docker-apisix up -d

2.3 RPM 安装方式

通过在线 RPM 仓库安装
sudo yum install -y
https://repos.apiseven.com/packages/centos/apache-apisix-repo-1.0-1.noarch.rpm
sudo yum install apisix
通过离线 RPM 包安装
sudo mkdir -p apisix
sudo yum install -y
https://repos.apiseven.com/packages/centos/apache-apisix-repo-1.0-1.noarch.rpm
sudo yum clean all && yum makecache
sudo yum install -y --downloadonly --downloaddir=./apisix apisix
apisix init #配置初始化
apisix start #启动网关

三、路由配置

3.1 重点概念：

路由（Route）：通过定义一些规则来匹配客户端的请求，然后根据匹配结果加载并执行相应的插件，并把请求转发给到指定 Upstream。主要包含三部分内容：匹配规则（比如 uri、host、remote_addr 等），插件配置（限流限速等）和上游信息。请看下图示例，是一些 Route 规则的实例，当某些属性值相同时，图中用相同颜色标识。

消费方（Consumer)：对于 API 网关通常可以用请求域名、客户端 IP 地址等字段识别到某类请求方，然后进行插件过滤并转发请求到指定上游，通过抽象出消费方，可通过插件聚合创建出消费方，通过在设置路由规则时绑定和启用。

上游（Upstream）：是虚拟主机抽象，对给定的多个服务节点按照配置规则进行负载均衡。Upstream 的地址信息可以直接配置到 Route（或 Service)上，当 Upstream 有重复时，就需要用“引用”方式避免重复了。

服务（Service）：是某类 API 的抽象（也可以理解为一组 Route 的抽象）。它通常与上游服务抽象是一一对应的，Route 与 Service 之间，通常是 N:1 的关系。不同 Route 规则同时绑定到一个 Service 上，这些 Route 将具有相同的上游和插件配置，减少冗余配置。

Script（脚本）：表示将在 HTTP 请求/响应生命周期期间执行的脚本。配置可直接绑定在 Route 上。Script 与 Plugin 互斥，且优先执行 Script ，这意味着配置 Script 后，Route 上配置的 Plugin 将不被执行。Script 也有执行阶段概念，支持 access、header_filter、body_filter 和 log 阶段。系统会在相应阶段中自动执行 Script 脚本中对应阶段的代码。

{    ...    "script": "local _M = {} \n function _M.access(api_ctx) \n ngx.log(ngx.INFO,"hit access phase") \n end \nreturn _M"}

复制代码

3.2 基于 Apisix Dashboard 的路由配置

开放控制台访问：

修改/usr/local/apisix/conf/config.yaml 配置文件，增加允许访问的远程 IP 地址

 allow_admin:                    - 127.0.0.0/24              # If we don't set any IP list, then any IP access is allowed by default.    - 1.1.1.0/24           # 新增加的远程IP地址段。

复制代码

3.2.1 创建上游

3.2.2 创建路由

3.2.3 配置路径

3.2.4 选择上游

四、插件使用

4.1 插件加载流程

请求路由是通过查询 ETCD 的路由和消费方进行插件匹配，过滤得到可使用的插件后运行插件进行动态上游反向代理。

4.2 插件使用

通过配置路由时进行插件配置启用响应插件，并进行插件文件配置信息配置

4.2.1 以 limt-req 为例的基于漏桶原理的请求限速

漏桶算法(Leaky Bucket)是网络世界中流量整形（Traffic Shaping）或速率限制（Rate Limiting）时经常使用的一种算法，它的主要目的是控制数据注入到网络的速率，平滑网络上的突发流量。漏桶算法提供了一种机制，通过它，突发流量可以被整形以便为网络提供一个稳定的流量。

4.2.2 属性说明

rate：指定的请求速率（以秒为单位），请求速率超过 rate 但没有超过（rate + brust）的请求会被加上延时 burst：请求速率超过（rate + brust）的请求会被直接拒绝 rejected_code：当请求超过阈值被拒绝时，返回的 HTTP 状态码 key：是用来做请求计数的依据，当前接受的 key 有："remote_addr"(客户端 IP 地址), "server_addr"(服务端 IP 地址), 请求头中的"X-Forwarded-For" 或 "X-Real-IP"。