gRPC-Swagger使用指南

1. 目录结构及介绍

gRPC-Swagger项目遵循了标准的Java Maven项目结构，其主要目录结构如下：

├── doc                   # 文档资料，包括截图等
├── grpc-swagger-core     # 核心逻辑实现模块
├── grpc-swagger-demo     # 示例应用，展示如何集成gRPC-Swagger
├── grpc-swagger-web      # 启动web服务的模块，用于提供Swagger UI界面
├── mvnw                  # Maven Wrapper，方便跨平台运行Maven命令
├── mvnw.cmd              # Windows下的Maven Wrapper命令
├── pom.xml               # Maven项目配置文件，定义项目依赖及构建过程
├── README.md             # 主要的项目说明文档
├── README_CN.md          # 中文版项目说明文档
├── CODE_OF_CONDUCT.md    # 代码行为规范文档
├── CONTRIBUTING.md       # 贡献者指南
├── LICENSE               # 许可证文件，本项目遵循MIT协议
├── Procfile              # 云部署配置文件（如Heroku）
└── docker-compose.yml   # Docker Compose配置文件，便于容器化部署

• doc: 包含了项目相关的屏幕截图和可能的手册或附加文档。
• grpc-swagger-core: 实现gRPC服务与Swagger集成的核心类库。
• grpc-swagger-demo: 提供了一个简单的gRPC服务示例，展示了如何使用gRPC-Swagger。
• grpc-swagger-web: 该模块负责启动一个Web服务器来托管Swagger UI界面，以便用户可以查看和调用gRPC方法。
• pom.xml: 定义了整个项目构建的依赖关系和构建流程。

2. 项目的启动文件介绍

运行示例应用

如果你想快速尝试gRPC-Swagger，你可以直接从grpc-swagger-demo模块开始。不过，更常见的是通过grpc-swagger-web模块启动服务来查看和测试gRPC接口。使用以下命令可以直接运行Swagger UI界面：

mvn clean package
java -jar grpc-swagger-web/target/grpc-swagger.jar

此命令默认在端口8080上启动服务。如果你希望更改端口，可以使用下面的命令：

java -jar grpc-swagger-web/target/grpc-swagger.jar --server.port=你的端口号

gRPC服务启动

为了配合gRPC-Swagger，你需要确保你的gRPC服务启用了反射服务。这通常在服务的主启动类中完成，例如：

Server server = ServerBuilder.forPort(SERVER_PORT)
    .addService(new YourGrpcServiceImpl())
    .addService(ProtoReflectionService.newInstance())
    .build()
    .start();

这里，ProtoReflectionService.newInstance()是关键，它允许gRPC-Swagger列出并调用服务中的方法。

3. 项目的配置文件介绍

Maven配置(pom.xml)

• 依赖管理：项目的核心依赖，比如gRPC相关库和Swagger工具，在此文件中定义。
• 插件配置：用于编译proto文件、打包等任务的Maven插件设置。

由于gRPC-Swagger主要是基于Maven进行构建和管理的，所以大部分配置都集中在pom.xml中。对于特定的服务配置，如gRPC服务地址、端口等，并不是在pom.xml中定义的，而是在服务的启动脚本或者具体的服务实现中进行配置。

对于更细粒度的配置，比如调整gRPC-Swagger的行为，往往通过命令行参数或环境变量来指定，而不是传统的配置文件形式。例如，启动时可以通过--enable.list.service和--service.expired.seconds等参数来控制服务列表的行为。

确保你有适当的Maven环境并且已经正确设置了项目的依赖，这是运行和使用gRPC-Swagger的前提条件。