Apache ShenYu API 网关项目教程

Apache ShenYu API 网关项目教程

1. 项目的目录结构及介绍

Apache ShenYu 是一个基于 Java 的原生 API 网关，用于服务代理、协议转换和 API 治理。项目目录结构如下：

• ./devcontainer: 开发容器配置
• ./.github: GitHub 工作流和代码模板
• ./.idea: IntelliJ IDEA 项目配置
• ./.mvn/wrapper: Maven 包装器配置
• ./db: 数据库脚本和配置
• ./script: 脚本文件
• ./shenyu-admin-listener: 管理员监听器模块
• ./shenyu-admin: 管理后台模块
• ./shenyu-alert: 告警模块
• ./shenyu-bootstrap: 启动模块
• ./shenyu-client: 客户端模块
• ./shenyu-common: 公共模块
• ./shenyu-disruptor: 基于Disruptor的模块
• ./shenyu-dist: 分发模块
• ./shenyu-e2e: 端到端测试模块
• ./shenyu-examples: 示例模块
• ./shenyu-infra: 基础设施模块
• ./shenyu-integrated-test: 集成测试模块
• ./shenyu-kubernetes-controller: Kubernetes 控制器模块
• ./shenyu-loadbalancer: 负载均衡模块
• ./shenyu-plugin: 插件模块
• ./shenyu-protocol: 协议模块
• ./shenyu-register-center: 注册中心模块
• ./shenyu-registry: 注册模块
• ./shenyu-sdk: SDK 模块
• ./shenyu-spi: SPI 模块
• ./shenyu-spring-boot-starter: Spring Boot 引导模块
• ./shenyu-sync-data-center: 数据同步中心模块
• ./shenyu-web: Web 模块
• 其他配置和文档文件

每个模块负责不同的功能，例如shenyu-admin是管理后台，shenyu-bootstrap是网关启动模块，shenyu-plugin包含各种插件等。

2. 项目的启动文件介绍

项目的启动主要通过shenyu-bootstrap模块进行。以下是启动文件的基本介绍：

• ./shenyu-bootstrap: 该目录包含了启动网关的主要代码。
• ./shenyu-bootstrap/src/main/java/org/apache/shenyu/bootstrap/ShenyuBootstrapApplication.java: 这是网关的启动类，使用 Spring Boot 进行启动。

要启动项目，可以使用以下命令：

mvn clean install -DskipTests cd shenyu-bootstrap java -jar target/shenyu-bootstrap.jar

3. 项目的配置文件介绍

项目的配置文件位于shenyu-bootstrap模块下的src/main/resources目录中。以下是一些重要的配置文件：

• application.properties或application.yml: 这是 Spring Boot 的标准配置文件，用于配置网关的各种属性，如端口、数据库连接等。
• bootstrap.properties: 一些特定的启动配置，如服务发现和注册中心的配置。
• logback-spring.xml: Logback 的配置文件，用于配置日志记录。

以下是一个简单的application.yml配置文件示例：

server: port: 9195 spring: application: name: shenyu-bootstrap shenyu: local: enabled: true sha512Key: your-sha512-key

确保根据实际情况调整配置文件，以满足项目的需求。

以上就是 Apache ShenYu API 网关项目的简单教程。希望对您有所帮助。