gRPC-Web 项目教程

gRPC-Web 项目教程

grpc-webgRPC for Web Clients项目地址:https://gitcode.com/gh_mirrors/gr/grpc-web

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

gRPC-Web 项目的目录结构如下：

grpc-web/
├── BUILD
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
├── bower.json
├── package.json
├── proto
│   └── echo_service.proto
├── src
│   ├── index.js
│   ├── main.js
│   └── server.js
└── tsconfig.json

目录结构介绍

• BUILD: 用于构建项目的文件。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: 用于构建 Docker 镜像的文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• bower.json: Bower 包管理配置文件。
• package.json: npm 包管理配置文件。
• proto: 存放 Protocol Buffers 文件的目录。
• src: 源代码目录。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要位于 src 目录下：

• index.js: 项目的入口文件，负责启动服务器。
• main.js: 主逻辑文件，处理客户端请求。
• server.js: 服务器配置和启动文件。

启动文件介绍

• index.js:

  const server = require('./server');
  server.start();
  

• main.js:

  const grpc = require('grpc');
  const protoLoader = require('@grpc/proto-loader');
  const packageDefinition = protoLoader.loadSync('proto/echo_service.proto', {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true
  });
  const echo_proto = grpc.loadPackageDefinition(packageDefinition).echo;
  

• server.js:

  const grpc = require('grpc');
  const protoLoader = require('@grpc/proto-loader');
  const packageDefinition = protoLoader.loadSync('proto/echo_service.proto', {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true
  });
  const echo_proto = grpc.loadPackageDefinition(packageDefinition).echo;
  
  function main() {
    const server = new grpc.Server();
    server.addService(echo_proto.EchoService.service, {
      echo: (call, callback) => {
        callback(null, { message: call.request.message });
      }
    });
    server.bind('0.0.0.0:50051', grpc.ServerCredentials.createInsecure());
    server.start();
  }
  
  main();
  

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 tsconfig.json。

配置文件介绍

• package.json:

  {
    "name": "grpc-web",
    "version": "1.0.0",
    "description": "gRPC for Web Clients",
    "main": "index.js",
    "scripts": {
      "start": "node index.js"
    },
    "dependencies": {
      "@grpc/grpc-js": "^1.2.0",
      "@grpc/proto-loader": "^0.5.0"
    }
  }
  

• tsconfig.json:

  {
    "compilerOptions": {
      "target": "es5",
      "module": "commonjs",
      "outDir": "./dist",
      "strict": true
    },
    "include": [
      "src/**/*.ts"
    ]
  }
  

配置文件说明

• package.json: 定义了项目的名称、版本、描述、入口文件、脚本命令和依赖项。
• tsconfig.json: TypeScript 编译配置文件，定义了编译选项和包含的文件。

以上是 gRPC-Web 项目的目录结构、启动文件和配置文件的介绍。

grpc-webgRPC for Web Clients项目地址:https://gitcode.com/gh_mirrors/gr/grpc-web