PhalApi 开源接口框架快速入门教程

1. 项目目录结构及介绍

PhalApi 的目录结构如下：

├── app                      # 应用目录，放置业务代码
│   ├── Controllers         # 控制器目录，存放处理请求的类
│   ├── Models              # 模型目录，存放数据操作的类
│   └── Services            # 服务目录，存放通用服务类
├── conf                     # 配置目录，存放各种配置文件
│   ├── App.php             # 应用配置文件
│   ├── Database.php        # 数据库配置文件
│   └── ...                 # 其他配置文件
├── logs                     # 日志目录，存放应用运行时的日志
├── public                   # 公共目录，对外提供访问的静态资源
├── tests                    # 测试目录，存放单元测试代码
└── vendor                   # 第三方依赖包，由 Composer 管理
    └── ...

• app 目录存储应用的核心代码。
• conf 目录包含了所有配置文件，如数据库连接和其他服务设置。
• logs 用于存储系统日志。
• public 是对外可访问的公共目录，通常放置入口文件和静态资源。
• tests 存放测试用例，帮助进行功能验证。
• vendor 存放通过 Composer 安装的第三方库。

2. 项目的启动文件介绍

在 PhalApi 中，启动文件通常是 public/index.php。这是一个简单的 PHP 文件，负责加载框架核心并初始化应用程序。例如：

<?php
// 加载Composer自动加载文件
require __DIR__ . '/../vendor/autoload.php';

// 初始化 PhalApi 实例
$di = new \PhalApi\DI();
$server = new \PhalApi\Server($di);
$server->run();

这个文件首先引入了 Composer 自动加载器，然后创建 PhalApi 的依赖注入容器（\PhalApi\DI），接着实例化服务器对象（\PhalApi\Server）并调用其 run() 方法来处理请求和响应。

3. 项目的配置文件介绍

3.1 App.php

conf/App.php 是应用的基础配置文件，你可以在这里定义全局变量、常量以及一些自定义的服务。例如：

return array(
    'APP_DEBUG' => true, // 是否开启调试模式
    'APP_TIMEZONE' => 'Asia/Shanghai', // 设置时区
    'APP_CUSTOM_SERVICES' => array( // 注册自定义服务
        'myService' => 'MyNamespace\MyService',
    ),
);

3.2 Database.php

conf/Database.php 配置数据库连接参数，例如使用 MySQL：

return array(
    'DB_ADAPTER' => '\PhalApi\Database\PDO\Mysql', // 数据库适配器
    'DB_HOSTNAME' => 'localhost', // 主机名
    'DB_PORT' => '3306', // 端口号
    'DB_DATABASE' => 'test_db', // 数据库名称
    'DB_USERNAME' => 'root', // 用户名
    'DB_PASSWORD' => 'password', // 密码
    'DB_CHARSET' => 'utf8mb4', // 字符集
);

更多的配置文件可以根据实际需求添加，比如邮件、缓存等服务的配置。

请记得，这些配置可以通过环境变量或者部署时的脚本进行动态替换，以适应不同环境的需求。了解这些基本概念后，你就可以开始着手搭建自己的 PhalApi 项目了。