PHP 新手入门指南 - 通过控制器类处理请求

使用基于面向对象的编程能够让人们更简单地设计并维护程序,使得程序更加便于分析、设计、理解。

面向对象程序设计(英语:Object-oriented programming,缩写:OOP)是种具有对象概念的程序编程范型,同时也是一种程序开发的抽象方针。它可能包含数据、属性、代码与方法。对象则指的是类的实例。它将对象作为程序的基本单元,将程序和数据封装其中,以提高软件的重用性、灵活性和扩展性,对象里的程序可以访问及经常修改对象相关连的数据。在面向对象程序编程里,计算机程序会被设计成彼此相关的对象

所以这部分的内容是将之前通过过程实现的控制器代码修改成通过类来处理。

小实践

业务逻辑部分

首先创建文件 controllers/PageControler.php,内容如下:

<?php

class PageController
{
    public function home()
    {
        $users = App::get('database')->selectAll('users');

        return view('index', ['users' => $users]);
    }

    public function about()
    {
        $company = 'PHP';

        return view('about', ['company' => $company]);
    }

    public function contact()
    {
        return view('contact');
    }

    public function aboutCulture()
    {
        return view('about-culture');
    }
}

这部分代码中,有一个通用函数 view 是用来加载显示视图的,它在 bootstrap.php 中定义,传递视图文件的名称和页面需要的变量信息,就能方便提供视图的渲染。

function view($name, $data = [])
{
    extract($data);

    return require "views/{$name}.view.php";
}

接下来再添加一个 controllers/UsersController.php 文件:

<?php

class UsersController
{
    public function index()
    {
        $users = App::get('database')->selectAll('users');

        return view('users', ['users' => $users]);
    }

    public function store()
    {
        App::get('database')->insert('users', [
            'name' => $_POST['name']
        ]);

        return redirect('users');
    }
}

其中 redirect 是一个新定义的函数,它帮助我们在执行完请求业务后进行页面跳转。在 bootstrap.php 中,它的定义如下:

function redirect($path)
{
    header("Location: /{$path}");
}

有个控制器,接下来我们需要重新更改路由,修改 routes.php 内容如下:

<?php

// $router->get('', 'controllers/index.php');
// $router->get('about', 'controllers/about.php');
// $router->get('about/culture', 'controllers/about-culture.php');
// $router->get('contact-our-company', 'controllers/contact.php');
// $router->post('names', 'controllers/add-name.php');

$router->get('', 'PageController@home');
$router->get('about', 'PageController@about');
$router->get('contact', 'PageController@contact');

$router->get('users', 'UsersController@index');
$router->post('users', 'UsersController@store');

我们将原先通过目录指向改为了通过控制器类和相应的方法名。

这时,我们的路由解析类 Router 也需要调整,让它能够对传入的控制器类和方法进行正确的指向,在 core/Router.php 中:

<?php 

class Router
{
    protected $routes = [
        'GET' => [],
        'POST' => []
    ];

    public static function load($file)
    {
        $router = new static;

        require $file;

        return $router;
    }

    public function get($uri, $controller)
    {
        $this->routes['GET'][$uri] = $controller;
    }

    public function post($uri, $controller)
    {
        $this->routes['POST'][$uri] = $controller;
    }

    public function direct($uri, $requestType)
    {
        if (array_key_exists($uri, $this->routes[$requestType])) {
            return $this->callAction(
                ...explode('@', $this->routes[$requestType][$uri])
            );
        }

        throw new Exception('No route defined for this URI.');
        
    }


    public function callAction($controllerName, $action)
    {
        $controller = new $controllerName;

        if (! method_exists($controller, $action)) {
            throw new Exception("{$controllerName} does not respond to the {$action}.");
        }

        return $controller->$action();
    }

}

这里我们重新修改了 direct 方法,在获取控制器名称和方法之后,调用 callAction 方法实例化相应的控制类执行对应的方法,同时会检测类和相应的方法是否存在,以及处理可能存在的异常。

这里需要注意 ... 是 PHP 的长参数语法。

PHP 在用户自定义函数中支持可变数量的参数列表。在 PHP 5.6 及以上的版本中,由 ... 语法实现;在 PHP 5.5 及更早版本中,使用函数使用函数 func_num_args()func_get_arg(),和 func_get_args()

... in PHP 5.6+ (该语法仅在 5.6 及以上版本中有效)

视图显示部分

完成了业务部分,接下来我们调整以下视图显示。

新建 views/users.view.php ,内容如下:

<?php require('partials/head.php'); ?>

<h1>All Users</h1>

<?php foreach ($users as $user) : ?>
    <li><?= $user->name; ?></li>
<?php endforeach; ?>

<h1>Submit Your Name</h1>

<form action="/users" method="POST">
    <input type="text" name="name">
    <button type="Submit">Submit</button>
</form>

<?php require('partials/footer.php'); ?>

同时,精简 views/index.view.php

<?php require('partials/head.php'); ?>

    <h1>Home Page</h1>

<?php require('partials/footer.php'); ?>

调整导航 views/nav.php

<nav>
    <ul>
        <li><a href="/">Home</a></li>
        <li><a href="/about">About Page</a></li>
        <li><a href="/users">Users</a></li>
        <li><a href="/contact">Contact Page</a></li>
    </ul>
</nav>

这样我么就完善好了我们控制器类、路由、和视图。

而之前的 controllers 目录下的那些文件 index.php, add-name.php 等文件就可以去掉了。

运行

在运行程序之前,还需要通过 Composer的自动加载来引入这些控制器类,需要执行命令:

composer dump-autoload

相关内容在之前的内容有阐述,不了解可以查阅过去的系列内容

项目目录下执行: php -S localhost:8000
通过浏览器访问:localhost:8000 查看效果

运行之后效果如初,你会发现重构成控制器类会让结构和逻辑变得清晰而且更易维护。

推荐阅读更多精彩内容