ZanTCP Boilerplate 使用教程

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

ZanTCP Boilerplate 项目的目录结构如下：

zantcp-boilerplate/
├── bin/
│   └── nova
├── resource/
├── src/
│   └── Service/
├── .gitignore
├── LICENSE
├── README-Eng.md
├── README.md
├── composer.json
└── phpunit.xml

目录介绍

• bin/: 包含项目的启动文件 nova。
• resource/: 存放项目资源文件。
• src/: 项目的主要代码目录，其中 Service/ 目录包含服务相关的代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README-Eng.md: 英文版项目说明文档。
• README.md: 中文版项目说明文档。
• composer.json: Composer 依赖管理文件。
• phpunit.xml: PHPUnit 测试配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 nova。该文件用于启动 TCP 服务器。

启动文件内容概述

#!/usr/bin/env php
<?php
// 启动脚本内容

该文件是一个可执行的 PHP 脚本，用于启动 ZanPHP TCP 服务器。

3. 项目的配置文件介绍

项目的配置文件主要包括 composer.json 和 phpunit.xml。

composer.json

composer.json 文件用于管理项目的依赖和配置 Composer。

{
    "name": "youzan/zantcp-boilerplate",
    "description": "Youzan ZanPHP TCP project Boilerplate",
    "require": {
        "php": ">=5.4.0"
    },
    "autoload": {
        "psr-4": {
            "Youzan\\": "src/"
        }
    }
}

phpunit.xml

phpunit.xml 文件用于配置 PHPUnit 测试框架。

<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="ZanTCP Boilerplate Test Suite">
            <directory>tests/</directory>
        </testsuite>
    </testsuites>
</phpunit>

以上是 ZanTCP Boilerplate 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。