【亲测免费】 Apache ShenYu API网关安装与配置指南

1. 项目基础介绍

Apache ShenYu是一个基于Java的本地API网关，它主要用于服务代理、协议转换和API治理。ShenYu支持多种服务框架如Apache Dubbo、Spring Cloud、gRPC等，并且提供了安全、API治理、可观测性等功能。

2. 主要编程语言

本项目主要使用Java语言开发，同时也使用了少量的Shell、Dockerfile、HTML等辅助性语言。

3. 关键技术和框架

• 服务代理：支持多种服务框架的代理。
• 协议转换：支持不同服务协议之间的转换。
• API治理：支持请求和响应的参数映射，提供限流、熔断等功能。
• 安全性：提供签名、OAuth 2.0、JSON Web Tokens等安全认证机制。
• 可观测性：支持追踪、指标、日志等功能。
• 动态控制台：提供动态流量控制和可视化用户菜单权限的后端。

4. 安装和配置准备工作

在开始安装之前，请确保您的环境满足以下要求：

• JDK 17+版本
• Docker（如果需要使用Docker进行部署）

5. 安装步骤

5.1 克隆项目

首先，从GitHub上克隆项目到本地：

git clone https://github.com/Dromara/soul.git

5.2 构建项目

进入项目目录后，执行以下命令构建项目：

mvn clean install

5.3 使用Docker部署Apache ShenYu Admin

运行以下命令来创建一个网络：

docker network create shenyu

接着，拉取Apache ShenYu Admin的Docker镜像，并运行容器：

docker pull apache/shenyu-admin
docker run -d --name shenyu-admin-quickstart -p 9095:9095 --net shenyu apache/shenyu-admin

5.4 使用Docker部署Apache ShenYu Bootstrap

拉取Apache ShenYu Bootstrap的Docker镜像，并运行容器：

docker pull apache/shenyu-bootstrap
docker run -d --name shenyu-quickstart -p 9195:9195 -e "shenyu.local.enabled=true" -e SHENYU_SYNC_WEBSOCKET_URLS=ws://shenyu-admin-quickstart:9095/websocket --net shenyu apache/shenyu-bootstrap

5.5 配置路由规则

在配置路由规则之前，需要为请求添加一个localKey的Header。使用以下命令添加路由规则：

curl --location --request POST 'http://localhost:9195/shenyu/plugin/selectorAndRules' \
--header 'Content-Type: application/json' \
--header 'localKey: 123456' \
--data-raw '{
  "pluginName": "divide",
  "selectorHandler": "[{\"upstreamUrl\":\"127.0.0.1:8080\"}]",
  "conditionDataList": [{
    "paramType": "uri",
    "operator": "match",
    "paramValue": "/**"
  }],
  "ruleDataList": [{
    "ruleHandler": "{\"loadBalance\":\"random\"}",
    "conditionDataList": [{
      "paramType": "uri",
      "operator": "match",
      "paramValue": "/**"
    }]
  }]
}'

5.6 测试代理请求

配置完成后，可以使用以下请求来测试代理是否成功：

http://localhost:9195/helloworld

返回结果应该如下：

{
  "name": "Shenyu",
  "data": "hello world"
}

以上步骤即为Apache ShenYu API网关的安装和配置指南，按照这些步骤操作，您应该能够成功部署并使用Apache ShenYu。