一个简单的框架

在 PHP 中，构建一个能够将 HTTP 请求映射到类的方法的框架，通常涉及到路由（Routing）、控制器（Controller）和请求处理等核心组件。本文将介绍如何创建一个简单的 PHP 框架，实现将不同的 HTTP 请求路径映射到相应的类方法中。

目录

1. 框架概述

2. 目录结构

3. 实现步骤

   • 1. 前端控制器（index.php）

   • 2. 路由器类（Router.php）

   • 3. 控制器基类（Controller.php）

   • 4. 示例控制器（HomeController.php）

4. 添加新路由和控制器

5. 完整代码示例

6. 总结

---

框架概述

一个基本的 PHP 框架通常包含以下几个部分：

• 前端控制器（Front Controller）：处理所有的 HTTP 请求，统一入口。

• 路由器（Router）：解析请求的 URI，并将其映射到相应的控制器和方法。

• 控制器（Controller）：处理具体的业务逻辑。

• 视图（View）：负责展示数据（本示例主要关注控制器部分）。

通过这种结构，框架能够有效地组织代码，提高可维护性和扩展性。

目录结构

假设我们的项目目录结构如下：

my_framework/
├── index.php
├── Router.php
├── Controller.php
└── controllers/
    └── HomeController.php

• index.php：前端控制器，所有请求都通过它入口。

• Router.php：路由器类，负责解析 URI 并调用相应的控制器方法。

• Controller.php：控制器基类，其他控制器可以继承它。

• controllers/：存放具体的控制器类文件。

实现步骤

1. 前端控制器（index.php）

前端控制器是框架的入口文件，负责接收所有的 HTTP 请求，并将其传递给路由器处理。

<?php
// index.php

// 启用错误报告（开发阶段使用，生产环境请关闭）
ini_set('display_errors', 1);
error_reporting(E_ALL);

// 自动加载类文件
spl_autoload_register(function ($class) {
    if (file_exists($class . '.php')) {
        require_once $class . '.php';
    } elseif (file_exists('controllers/' . $class . '.php')) {
        require_once 'controllers/' . $class . '.php';
    }
});

// 获取请求的 URI 和方法
$requestUri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$requestMethod = $_SERVER['REQUEST_METHOD'];

// 实例化路由器并添加路由
$router = new Router();

// 定义路由规则
$router->add('GET', '/', 'HomeController@index');
$router->add('GET', '/about', 'HomeController@about');
$router->add('POST', '/submit', 'HomeController@submit');

// 处理请求
$router->dispatch($requestMethod, $requestUri);
?>

说明：

• 错误报告：在开发阶段启用错误报告，便于调试。

• 自动加载：使用 spl_autoload_register 自动加载类文件，简化类的引入。

• 获取请求信息：通过 $_SERVER 全局变量获取请求的 URI 和 HTTP 方法。

• 路由定义：使用 $router->add 方法添加路由规则，格式为 HTTP_METHOD, URI, Controller@method。

• 请求分发：调用 $router->dispatch 方法，根据请求信息分发到相应的控制器方法。

2. 路由器类（Router.php）

路由器类负责解析请求的 URI，并调用相应的控制器和方法。

<?php
// Router.php

class Router
{
    private $routes = [];

    /**
     * 添加路由规则
     *
     * @param string $method HTTP 方法（GET, POST, etc.）
     * @param string $uri 请求的 URI
     * @param string $action 控制器和方法，例如 'HomeController@index'
     */
    public function add($method, $uri, $action)
    {
        $this->routes[] = [
            'method'  => strtoupper($method),
            'uri'     => $uri,
            'action'  => $action
        ];
    }

    /**
     * 分发请求到相应的控制器方法
     *
     * @param string $requestMethod HTTP 方法
     * @param string $requestUri 请求的 URI
     */
    public function dispatch($requestMethod, $requestUri)
    {
        foreach ($this->routes as $route) {
            if ($route['method'] === strtoupper($requestMethod) && $route['uri'] === $requestUri) {
                $this->executeAction($route['action']);
                return;
            }
        }
        // 如果没有匹配的路由，返回 404
        $this->sendNotFound();
    }

    /**
     * 执行控制器的方法
     *
     * @param string $action 控制器和方法，例如 'HomeController@index'
     */
    private function executeAction($action)
    {
        list($controllerName, $method) = explode('@', $action);
        if (class_exists($controllerName)) {
            $controller = new $controllerName();
            if (method_exists($controller, $method)) {
                call_user_func([$controller, $method]);
                return;
            }
        }
        // 如果控制器或方法不存在，返回 404
        $this->sendNotFound();
    }

    /**
     * 发送 404 响应
     */
    private function sendNotFound()
    {
        header("HTTP/1.0 404 Not Found");
        echo "404 Not Found";
    }
}
?>

说明：

• 添加路由：add 方法用于添加新的路由规则。

• 分发请求：dispatch 方法遍历所有路由规则，找到匹配的规则后调用相应的控制器方法。

• 执行动作：executeAction 方法解析控制器和方法名称，并调用相应的方法。

• 404 处理：如果没有匹配的路由或控制器方法不存在，返回 404 响应。

3. 控制器基类（Controller.php）

控制器基类可以包含一些公共的方法或属性，供具体的控制器继承和使用。在这个简单的示例中，我们暂时不添加任何内容，但在实际项目中，您可以根据需要扩展它。

<?php
// Controller.php

class Controller
{
    // 在这里可以添加公共的方法或属性
}
?>

4. 示例控制器（HomeController.php）

这是一个示例控制器，包含几个方法来处理不同的请求。

<?php
// controllers/HomeController.php

class HomeController extends Controller
{
    /**
     * 主页方法
     */
    public function index()
    {
        echo "<h1>欢迎来到主页！</h1>";
    }

    /**
     * 关于页面方法
     */
    public function about()
    {
        echo "<h1>关于我们</h1><p>这是关于页面。</p>";
    }

    /**
     * 处理表单提交的方法
     */
    public function submit()
    {
        // 假设有一个表单提交到 /submit
        // 处理 POST 数据
        $data = $_POST;
        echo "<h1>表单已提交</h1>";
        echo "<pre>";
        print_r($data);
        echo "</pre>";
    }
}
?>

说明：

• index 方法：处理主页请求，输出欢迎信息。

• about 方法：处理关于页面请求，输出关于信息。

• submit 方法：处理表单提交的 POST 请求，输出提交的数据。

添加新路由和控制器

假设添加一个新的路由 /contact，并将其映射到 HomeController 的 contact 方法，可以按照以下步骤进行：

1. 在 Router.php 中添加路由规则

   // index.php 中的路由定义部分
   $router->add('GET', '/contact', 'HomeController@contact');
   

2. 在 HomeController.php 中添加 contact 方法

   // controllers/HomeController.php
   
   class HomeController extends Controller
   {
       // 现有方法...
   
       /**
        * 联系我们页面方法
        */
       public function contact()
       {
           echo "<h1>联系我们</h1><p>这是联系我们页面。</p>";
       }
   }
   

现在，当用户访问 http://yourdomain.com/contact 时，HomeController 的 contact 方法将被调用，输出相应的内容。

完整代码示例

以下是所有文件的完整代码。

1. index.php

<?php
// index.php

// 启用错误报告（开发阶段使用，生产环境请关闭）
ini_set('display_errors', 1);
error_reporting(E_ALL);

// 自动加载类文件
spl_autoload_register(function ($class) {
    if (file_exists($class . '.php')) {
        require_once $class . '.php';
    } elseif (file_exists('controllers/' . $class . '.php')) {
        require_once 'controllers/' . $class . '.php';
    }
});

// 获取请求的 URI 和方法
$requestUri = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$requestMethod = $_SERVER['REQUEST_METHOD'];

// 实例化路由器并添加路由
$router = new Router();

// 定义路由规则
$router->add('GET', '/', 'HomeController@index');
$router->add('GET', '/about', 'HomeController@about');
$router->add('GET', '/contact', 'HomeController@contact'); // 新增联系页面
$router->add('POST', '/submit', 'HomeController@submit');

// 处理请求
$router->dispatch($requestMethod, $requestUri);
?>

2. Router.php

<?php
// Router.php

class Router
{
    private $routes = [];

    /**
     * 添加路由规则
     *
     * @param string $method HTTP 方法（GET, POST, etc.）
     * @param string $uri 请求的 URI
     * @param string $action 控制器和方法，例如 'HomeController@index'
     */
    public function add($method, $uri, $action)
    {
        $this->routes[] = [
            'method'  => strtoupper($method),
            'uri'     => $uri,
            'action'  => $action
        ];
    }

    /**
     * 分发请求到相应的控制器方法
     *
     * @param string $requestMethod HTTP 方法
     * @param string $requestUri 请求的 URI
     */
    public function dispatch($requestMethod, $requestUri)
    {
        foreach ($this->routes as $route) {
            if ($route['method'] === strtoupper($requestMethod) && $route['uri'] === $requestUri) {
                $this->executeAction($route['action']);
                return;
            }
        }
        // 如果没有匹配的路由，返回 404
        $this->sendNotFound();
    }

    /**
     * 执行控制器的方法
     *
     * @param string $action 控制器和方法，例如 'HomeController@index'
     */
    private function executeAction($action)
    {
        list($controllerName, $method) = explode('@', $action);
        if (class_exists($controllerName)) {
            $controller = new $controllerName();
            if (method_exists($controller, $method)) {
                call_user_func([$controller, $method]);
                return;
            }
        }
        // 如果控制器或方法不存在，返回 404
        $this->sendNotFound();
    }

    /**
     * 发送 404 响应
     */
    private function sendNotFound()
    {
        header("HTTP/1.0 404 Not Found");
        echo "404 Not Found";
    }
}
?>

3. Controller.php

<?php
// Controller.php

class Controller
{
    // 在这里可以添加公共的方法或属性
}
?>

4. controllers/HomeController.php

<?php
// controllers/HomeController.php

class HomeController extends Controller
{
    /**
     * 主页方法
     */
    public function index()
    {
        echo "<h1>欢迎来到主页！</h1>";
    }

    /**
     * 关于页面方法
     */
    public function about()
    {
        echo "<h1>关于我们</h1><p>这是关于页面。</p>";
    }

    /**
     * 联系我们页面方法
     */
    public function contact()
    {
        echo "<h1>联系我们</h1><p>这是联系我们页面。</p>";
    }

    /**
     * 处理表单提交的方法
     */
    public function submit()
    {
        // 假设有一个表单提交到 /submit
        // 处理 POST 数据
        $data = $_POST;
        echo "<h1>表单已提交</h1>";
        echo "<pre>";
        print_r($data);
        echo "</pre>";
    }
}
?>

测试框架

1. 启动本地服务器

   使用 PHP 内置服务器进行测试。在项目根目录下运行以下命令：

   php -S localhost:8000
   

2. 访问不同的路由

   • 主页: http://localhost:8000/

   • 关于页面: http://localhost:8000/about

   • 联系我们页面: http://localhost:8000/contact

3. 测试表单提交

   创建一个简单的 HTML 表单，提交到 /submit。

   <!-- save as form.html in project root -->
   <!DOCTYPE html>
   <html lang="en">
   <head>
       <meta charset="UTF-8">
       <title>表单提交</title>
   </head>
   <body>
       <h1>提交表单</h1>
       <form action="/submit" method="POST">
           <label for="name">姓名:</label>
           <input type="text" id="name" name="name" required><br><br>
           <label for="email">邮箱:</label>
           <input type="email" id="email" name="email" required><br><br>
           <button type="submit">提交</button>
       </form>
   </body>
   </html>
   

   然后访问 http://localhost:8000/form.html，填写表单并提交，将看到提交的数据被输出。

总结

本文介绍了如何构建一个简单的 PHP 框架，实现将 HTTP 请求映射到类的方法中。通过定义路由规则、创建路由器类和控制器类，可以轻松地管理不同的请求路径和对应的业务逻辑。

关键步骤包括：

1. 前端控制器：作为所有请求的统一入口，负责初始化路由器并分发请求。

2. 路由器类：负责解析请求的 URI 和方法，并调用相应的控制器方法。

3. 控制器类：包含具体的业务逻辑，处理不同的请求。

扩展建议：

• 动态路由：支持带参数的动态路由，例如 /user/{id}。

• 中间件：实现中间件机制，处理认证、日志记录等功能。

• 视图模板：集成模板引擎（如 Twig）以分离视图和逻辑。

• 错误处理：增强错误处理机制，提供更友好的错误页面。

• 命名空间：使用命名空间组织代码，提高代码的可维护性。