hamropatrorepo/web-grpc-envoy

gRPC Web网关镜像

镜像概述

本镜像提供一个中间件网关，专门用于实现web-grpc客户端与gRPC服务器之间的通信。它作为协议转换层，解决Web应用（通常使用HTTP/JSON）与gRPC服务（使用Protobuf协议）之间的通信兼容性问题，简化前端应用调用gRPC服务的流程。

核心功能与特性

• 协议转换：支持HTTP/JSON与gRPC协议之间的双向转换，实现Web客户端与gRPC服务的无缝通信
• 请求转发：接收web-grpc客户端请求并转发至目标gRPC服务器，同时将gRPC响应转换为Web可识别格式返回
• 轻量级设计：基于高效的中间件架构，资源占用低，响应速度快
• 配置灵活：支持通过环境变量或配置文件自定义转发规则、超时设置等参数
• 兼容性广：兼容主流gRPC服务实现，支持标准gRPC协议规范

使用场景

• Web前端调用gRPC服务：当Web应用（如React、Vue等前端框架）需要直接调用后端gRPC服务时
• 跨协议微服务通信：在微服务架构中，实现基于HTTP的服务与基于gRPC的服务之间的通信
• API网关扩展：作为现有API网关的补充组件，为gRPC服务提供Web访问能力
• 开发与测试环境：简化本地开发环境中Web应用与gRPC服务的联调流程

使用方法

基本使用

通过docker run命令快速启动网关：

bash
docker run -d \
  --name grpc-web-gateway \
  -p 8080:8080 \
  -e GRPC_SERVER_ADDRESS=grpc-server:50051 \
  -e LISTEN_PORT=8080 \
  docker.xuanyuan.run/your-image-name:latest

环境变量配置

Docker Compose配置示例

yaml
version: '3'
services:
  grpc-web-gateway:
    image: docker.xuanyuan.run/your-image-name:latest
    ports:
      - "8080:8080"
    environment:
      - GRPC_SERVER_ADDRESS=grpc-server:50051
      - LISTEN_PORT=8080
      - GRPC_TIMEOUT=3000
      - LOG_LEVEL=debug
    depends_on:
      - grpc-server

  grpc-server:
    image: docker.xuanyuan.run/your-grpc-server-image:latest
    ports:
      - "50051:50051"

高级配置（通过配置文件）

如需更复杂的转发规则，可通过挂载配置文件实现：

1. 创建配置文件 gateway-config.yaml：

yaml
grpcServers:
  - name: user-service
    address: grpc-user-service:50051
    routes:
      - path: /api/user/*
        grpcService: user.UserService
        grpcMethod: GetUser
  - name: order-service
    address: grpc-order-service:50052
    routes:
      - path: /api/order/*
        grpcService: order.OrderService
        grpcMethod: GetOrder

2. 启动容器时挂载配置文件：

bash
docker run -d \
  --name grpc-web-gateway \
  -p 8080:8080 \
  -v $(pwd)/gateway-config.yaml:/app/config.yaml \
  -e CONFIG_FILE=/app/config.yaml \
  docker.xuanyuan.run/your-image-name:latest

注意事项

• 确保目标gRPC服务器已启用HTTP/2支持
• 对于TLS加密的gRPC服务，需额外配置TLS证书（通过环境变量TLS_CERT_PATH和TLS_KEY_PATH）
• 高并发场景下建议调整容器资源限制（--memory和--cpus参数）以保证性能