Thrift-Mock 项目使用教程

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

Thrift-Mock 项目的目录结构如下：

thrift-mock/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── didi/
│   │   │           └── thrift/
│   │   │               └── mock/
│   │   │                   ├── generator/
│   │   │                   ├── model/
│   │   │                   ├── parser/
│   │   │                   └── utils/
│   │   └── resources/
│   └── test/
│       ├── java/
│       │   └── com/
│       │       └── didi/
│       │           └── thrift/
│       │               └── mock/
│       └── resources/
├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── thrift-mock.iml

目录结构介绍

• src/main/java/com/didi/thrift/mock/: 包含项目的主要代码，分为 generator、model、parser 和 utils 四个子目录。
  • generator/: 生成 mock 数据的代码。
  • model/: 定义数据模型的代码。
  • parser/: 解析 thrift 文件的代码。
  • utils/: 工具类代码。
• src/main/resources/: 项目资源文件，如配置文件等。
• src/test/java/com/didi/thrift/mock/: 测试代码。
• src/test/resources/: 测试资源文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• pom.xml: Maven 项目配置文件。
• thrift-mock.iml: IntelliJ IDEA 项目文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/main/java/com/didi/thrift/mock/ 目录下，主要包含以下几个关键类：

• Main.java: 项目的入口类，负责启动和配置项目。
• ThriftMockGenerator.java: 生成 mock 数据的核心类。
• ThriftParser.java: 解析 thrift 文件的类。

启动文件介绍

• Main.java:

  public class Main {
      public static void main(String[] args) {
          // 初始化配置
          Config config = new Config();
          // 解析命令行参数
          new CommandLine(new MainCommand()).execute(args);
          // 启动生成器
          ThriftMockGenerator generator = new ThriftMockGenerator(config);
          generator.generate();
      }
  }
  

• ThriftMockGenerator.java:

  public class ThriftMockGenerator {
      private final Config config;
  
      public ThriftMockGenerator(Config config) {
          this.config = config;
      }
  
      public void generate() {
          // 解析 thrift 文件
          ThriftParser parser = new ThriftParser(config);
          List<ThriftDefinition> definitions = parser.parse();
          // 生成 mock 数据
          for (ThriftDefinition definition : definitions) {
              // 生成逻辑
          }
      }
  }
  

• ThriftParser.java:

  public class ThriftParser {
      private final Config config;
  
      public ThriftParser(Config config) {
          this.config = config;
      }
  
      public List<ThriftDefinition> parse() {
          // 解析逻辑
      }
  }
  

3. 项目的配置文件介绍

项目的配置文件主要位于 src/main/resources/ 目录下，关键配置文件为 application.properties。

配置文件介绍

• application.properties:

  # 项目基本配置
  project.name=thrift-mock
  project.version=1.0.0
  
  # Thrift 文件路径
  thrift.file.path=/path/to/thrift/files
  
  # 输出文件路径
  output.file.path=/path/to/output/files