TinyRPC 开源项目教程

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

TinyRPC 项目的目录结构如下：

tinyrpc/
├── bin/
│   └── tinyrpc
├── conf/
│   ├── config.yaml
│   └── log.yaml
├── src/
│   ├── core/
│   │   ├── rpc_server.py
│   │   └── rpc_client.py
│   ├── utils/
│   │   └── logger.py
│   └── main.py
├── tests/
│   └── test_rpc.py
├── README.md
└── LICENSE

目录结构介绍

• bin/: 存放可执行文件。
• conf/: 存放配置文件。
• src/: 存放源代码文件。
  • core/: 核心功能模块，包括 rpc_server.py 和 rpc_client.py。
  • utils/: 工具模块，如日志记录 logger.py。
  • main.py: 项目的主入口文件。
• tests/: 存放测试文件。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。

2. 项目的启动文件介绍

项目的启动文件是 src/main.py。该文件负责初始化配置、启动 RPC 服务器和客户端。

启动文件内容概览

# src/main.py

import sys
from core.rpc_server import start_server
from core.rpc_client import start_client
from conf.config import load_config

def main():
    config = load_config()
    if sys.argv[1] == 'server':
        start_server(config)
    elif sys.argv[1] == 'client':
        start_client(config)

if __name__ == '__main__':
    main()

启动命令

• 启动服务器：python src/main.py server
• 启动客户端：python src/main.py client

3. 项目的配置文件介绍

项目的配置文件存放在 conf/ 目录下，主要包括 config.yaml 和 log.yaml。

config.yaml 配置文件

server:
  host: '0.0.0.0'
  port: 50051
client:
  server_host: 'localhost'
  server_port: 50051

log.yaml 配置文件

logging:
  version: 1
  disable_existing_loggers: false
  formatters:
    simple:
      format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
  handlers:
    console:
      class: logging.StreamHandler
      level: DEBUG
      formatter: simple
      stream: ext://sys.stdout
  loggers:
    tinyrpc:
      level: DEBUG
      handlers: [console]
      propagate: no

配置文件说明

• config.yaml: 包含服务器和客户端的配置信息，如主机地址和端口号。
• log.yaml: 包含日志记录的配置信息，如日志格式和输出级别。

通过以上内容，您可以了解 TinyRPC 项目的目录结构、启动文件和配置文件的基本信息，从而更好地使用和开发该项目。