ti-rpc 项目教程

ti-rpc 项目教程

ti-rpc 基于swoole封装的一个简易的JSON协议的RPC框架，思路是借鉴的，代码是自己写的。小修小改的，目前服务于前公司（注意是前公司）生产环境，每日支撑大约8000万次调用。 项目地址: https://gitcode.com/gh_mirrors/ti/ti-rpc

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

ti-rpc/
├── bin/
│   └── start.sh
├── config/
│   ├── default.json
│   └── production.json
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── index.js
├── test/
│   └── test.js
├── .gitignore
├── package.json
└── README.md

• bin/: 存放项目的启动脚本，如 start.sh。
• config/: 存放项目的配置文件，如 default.json 和 production.json。
• src/: 项目的源代码目录，包含控制器、模型、路由等。
  • controllers/: 存放控制器文件。
  • models/: 存放模型文件。
  • routes/: 存放路由文件。
  • index.js: 项目的入口文件。
• test/: 存放测试文件，如 test.js。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 bin/start.sh。该脚本通常用于启动项目的服务器或执行其他启动任务。具体内容如下：

#!/bin/bash

# 启动项目的命令
node src/index.js

该脚本通过 node 命令启动项目的入口文件 src/index.js。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括 default.json 和 production.json。

default.json

default.json 是项目的默认配置文件，包含项目的通用配置项。示例如下：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "ti-rpc"
  }
}

production.json

production.json 是生产环境的配置文件，通常会覆盖 default.json 中的某些配置项。示例如下：

{
  "port": 8080,
  "database": {
    "host": "production-db.example.com",
    "port": 27017,
    "name": "ti-rpc-production"
  }
}

通过这些配置文件，项目可以根据不同的环境加载相应的配置，确保在不同环境下正常运行。

ti-rpc 基于swoole封装的一个简易的JSON协议的RPC框架，思路是借鉴的，代码是自己写的。小修小改的，目前服务于前公司（注意是前公司）生产环境，每日支撑大约8000万次调用。 项目地址: https://gitcode.com/gh_mirrors/ti/ti-rpc