routing system luôn là 1 phần quan trọng của hệ thống code website. Bài này sẽ hướng dẫn bạn tạo router riêng để không phụ thuộc framework.

tạo router đơn giản trong php giống với framework

2021-01-06 4070 lượt xem

Trong khi xây dựng backend cho 1 ứng dụng web, routing system luôn là 1 phần quan trọng của hệ thống code website. Tất cả các request khi qua Route đều được kiểm tra và xử lý. Sử dụng hệ thống định tuyến cho phép chúng ta cấu trúc ứng dụng của mình theo cách tốt hơn thay vì chỉ định mỗi yêu cầu vào một file hay folder như code core.

Bên cạnh đó đôi lúc chúng ta lại không cần 1 framework vì chúng quá nặng nề. Bài viết dưới đây mô tả cái nhìn tổng quan cũng như cách tạo ra 1 router nhanh mà không sử dụng framework hay package composer. 

Yêu cầu

  • Bạn cần chạy phiên bản PHP 5 trở lên trên máy phát triển của mình.
  • Kiến thức PHP cơ bản và hiểu 1 chút về lập trình hướng đối tượng. 

Bạn làm được gì thông qua bài này

đây là bài demo nên Router chỉ xử lý GET, POST. nếu bạn muốn nhiều hơn thì mình có comment code tiếng việt có dâu, bạn cứ xem và xử lý thêm

vì nó rất đơn giản nên bạn sử dụng nó để lấy kiến thức nền xây dựng 1 framewok php cho riêng mình. 

bạn có thể sử dụng nó để làm máy chủ sản xuất nhưng hãy custom thêm nha. để nguyên như vậy là không ổn tí nào. mình muốn viết đơn giản để tất cả mọi ng đều hiểu được. 

Bắt đầu thôi !!! 

Dựng index file - đăng ký các router

tạo cấu trúc thư mục

Cấu trúc thư mục tạo Router như sau 

giải thích: 

  • index.php nên để trong folder public để tăng tính bảo mật giống như hầu hết các framework php khác.  
  • .htaccess nếu bạn có sử dụng apache thì bạn cũng từng phải bảo mật với file .htaccess. file này khi người dùng gõ vào folder trong public thì sẽ ngăn không cho hiện full các file tĩnh
  • Folder core rất quan trọng: 
  1. Request.php để xây dựng đối tượng request, mỗi 1 lần người dùng truy cập vào website sẽ tương ứng 1 request. và request đó sẽ mang param tương ứng. ta nên xây dựng 1 đối tượng request riêng. 
  2. Router.php là file định nghĩa cách thức hoạt động của Router, nhờ có file Router và sự kết hợp của requets chúng ta có thể tìm đúng Action tương ứng để chạy 

khiến cho mọi request đều có chung 1 dạng định nghĩa

điều quan trọng nhất mà các framework làm là biến các code của website đều có cùng 1 dạng  từ domain.xyz/[thành-phần-sau-url] domain.xyz/index.php/[thành-phần-sau-url]. 

làm như vậy để làm gì? tất cả các code của 1 web php đều có chung 1 điểm bắt đầu và sẽ dễ xử lý hơn. 

nếu bạn sử dụng apache làm server dĩ nhiên bạn cần file .htaccess để chuyển hướng tất cả url về dạng bạn muốn. Đây là file .htaccess(cái này của laravel mình copy thôi): 

<IfModule mod_rewrite.c>
    <IfModule mod_negotiation.c>
        Options -MultiViews -Indexes
    </IfModule>

    RewriteEngine On

    # Handle Authorization Header
    RewriteCond %{HTTP:Authorization} .
    RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

    # Redirect Trailing Slashes If Not A Folder...
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_URI} (.+)/$
    RewriteRule ^ %1 [L,R=301]

    # Send Requests To Front Controller...
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^ index.php [L]
</IfModule>

nếu bạn sử dụng nginx để làm server thì bạn không cần file này, thay vào đó bạn chỉ cần nhớ config root trỏ vào:

[Folder-code]/public

ví dụ nginx: 

server {

    listen       80;
    server_name  domain-cua-ban.com;
    root /var/www/SITE-PHP-ROUTER;

    location / {
        
        index  index.html index.htm;
    }
}

Khi mọi code đều chạy vào file index.php đầu tiên thì chúng ta tha hồ "Khoe Cá Tính". 

load tất cả các class từ folder core vào index.php

 để load tất cả các code vào ta dùng function load như sau : 

function coreAutoload($class)
{
    $root = '../core/';
    $prefix = 'Core\\';
    // remove prefix

    $classWithoutPrefix = preg_replace('/^' . preg_quote($prefix) . '/', '', $class);
    // Thay thế \ thành /
    $file = str_replace('\\', DIRECTORY_SEPARATOR, $classWithoutPrefix) . '.php';

    $path = $root . $file;
    if (file_exists($path)) {
        require_once $path;
    }
}
spl_autoload_register('coreAutoload');

Nếu bạn thấy ngứa mắt vì load bằng code như này bạn có thể thay bằng load composer.

Khởi tạo và đăng ký router trong index.php

 

use Core\Request;
use Core\Router;
/// khởi tạo đối tượng router
$router = new Router(new Request);
// chú ý: trong đối tượng router hoàn toàn không có method get, post, put gì cả
/// nhưng ở đây mình vẫn gọi 1 method get => trong php nó sẽ chạy vào hàm __call 
$router->get('/', function () {
    return "Hello world";
});
/// tương tự khi gọi method post mà router không có method post nên sẽ chạy vào hàm __call
$router->post('/data', function ($request) {
    return json_encode($request->getBody());
});

Bạn đã khởi tạo và đăng ký router xong và hết ( không làm gì nữa, thì php cũng sẽ tự đóng đối tượng lại bằng hàm __destruct.

Vậy mình sẽ lợi dụng việc đóng đối tượng để viết 1 hàm trong Router, khi Đối tượng Router bị hủy nó sẽ chạy hàm __destruct trong class Router mình sẽ trình bày sau. Trước hết toàn bộ code file index.php sẽ như sau: 

<?php
function coreAutoload($class)
{
    $root = '../core/';
    $prefix = 'Core\\';

    // remove prefix
    $classWithoutPrefix = preg_replace('/^' . preg_quote($prefix) . '/', '', $class);
    // Thay thế \ thành /
    $file = str_replace('\\', DIRECTORY_SEPARATOR, $classWithoutPrefix) . '.php';

    $path = $root . $file;
    if (file_exists($path)) {
        require_once $path;
    }
}
spl_autoload_register('coreAutoload');

use Core\Request;
use Core\Router;

/// khởi tạo đối tượng router
$router = new Router(new Request);

// chú ý: trong đối tượng router hoàn toàn không có method get, post, put gì cả
/// nhưng ở đây mình vẫn gọi 1 method get => trong php nó sẽ chạy vào hàm __call 
$router->get('/', function () {
    return "Hello world";
});

/// tương tự khi gọi method post mà router không có method post nên sẽ chạy vào hàm __call
$router->post('/data', function ($request) {

    return json_encode($request->getBody());
});

/// tương tự __call
$router->get('/profile/hung', function ($request) {
    
    return "profile profile";
});

//// kết thúc hoàn toàn quá trình
/// tại đây hàm __destruct được gọi, vì hàm hủy được chạy khi hệ thống chương trình hủy 1 đối tượng
/// lúc này là lúc ta thực thi code cần thiết theo từng router

DựngRequest và Router Core

Dựng Request

<?php
namespace Core;

class Request
{
    const GET_METHOD  = "GET";
    const POST_METHOD = "POST";

    function __construct()
    {
        $this->bootstrapSelf();
    }
    
    /**
     * bootstrapSelf là hàm lấy tất cả param của $_SERVER đổ vào cho đối tượng gốc.
     * sau này việc sử dụng 1 router sẽ không cần sử dụng biến global của PHP
     * thay vào đó chúng ta sẽ truyền đối tượng request vào
     * các key của biến $_SERVER sẽ được format theo dạng CamelCase 
     * đây là cú pháp lạc đà
     *
     * @return void
     */
    private function bootstrapSelf()
    {
        foreach ($_SERVER as $key => $value) {

            $this->{$this->toCamelCase($key)} = $value;
        }
    }
    
    /**
     * toCamelCase hàm này để format string bình thường thành cấu trúc lạc đà
     *
     * @param  mixed $string type dạng lạc đà 
     * @return void
     */
    private function toCamelCase($string)
    {
        $result = strtolower($string);

        preg_match_all('/_[a-z]/', $result, $matches);

        foreach ($matches[0] as $match) {

            $c      = str_replace('_', '', strtoupper($match));
            $result = str_replace($match, $c, $result);
        }

        return $result;
    }
    
    /**
     * getBody 
     * hàm này không có giá trị trả ra khi phương thức là GET
     * Bạn có thể handle thêm ở đây khi bạn cần các phương thức khác như PUT, PATCH, DELETE,...
     *
     * @return void $body được trả ra để trong Closure function handle chính sẽ gọi đến
     */
    public function getBody()
    {
        if ($this->requestMethod === Request::GET_METHOD ) {
            return;
        }

        if ($this->requestMethod == Request::POST_METHOD ) {

            $body = array();
            foreach ($_POST as $key => $value) {

                $body[$key] = filter_input(INPUT_POST, $key, FILTER_SANITIZE_SPECIAL_CHARS);
            }

            return $body;
        }
    }
}

Dựng Router

<?php
namespace Core;

class Router
{

    private $request;
    private $supportedHttpMethods = array(
        
        Request::GET_METHOD,
        Request::POST_METHOD
    );

    function __construct(Request $request)
    {
        $this->request = $request;
    }

    function __call($name, $args)
    {
        list($route, $method) = $args;

        /// kiểm tra phương thức có được support không ? 
        /// hiện tại chỉ có GET và POST
        if (!in_array(strtoupper($name), $this->supportedHttpMethods)) {

            /// nếu phương thức chưa được hộ trợ thì return 405 header
            $this->invalidMethodHandler();
        }

        //// nạp Closure function vào router
        /// get:array(1)
        /// "/" : Closure
        $this->{strtolower($name)}[$this->formatRoute($route)] = $method;
    }

    /**
     * Removes trailing forward slashes from the right of the route.
     * @param route (string)
     */
    private function formatRoute($route)
    {
        $result = rtrim($route, '/');
        if ($result === '') {
            return '/';
        }
        return $result;
    }

    private function invalidMethodHandler()
    {
        header("{$this->request->serverProtocol} 405 Method Not Allowed");
    }

    private function defaultRequestHandler()
    {
        header("{$this->request->serverProtocol} 404 Not Found");
    }

    /**
     * Resolves a route
     * là hàm xử lý chính cho router trước khi hàm __destruct success
     * hàm này sẽ gọi function được declare trong file router để chạy nội dung
     */
    function resolve()
    {
        $methodDictionary = $this->{strtolower($this->request->requestMethod)};
        $formatedRoute    = $this->formatRoute($this->request->requestUri);
        $method           = isset($methodDictionary[$formatedRoute])? $methodDictionary[$formatedRoute] : null;

        if (is_null($method)) {

            /// nếu không tìm thấy route nào phù hợp thì sẽ trả ra header 404
            $this->defaultRequestHandler();
            return;
        }
        
        /// hàm thần thánh để thực thi code của function Closure trong file index.php
        echo call_user_func_array($method, array($this->request));
    }

    function __destruct()
    {
        $this->resolve();
    }
}

Trong file Router này bạn chú ý hàm __destruct sẽ được chạy sau khi toàn bộ chương trình không còn gì để chạy => sẽ gọi hàm resolve lúc này chúng ta sẽ lấy method chính là function Closure trong file index.php mình đã define. và để chạy function method chúng ta sử dụng hàm call_user_func_array 

Tổng Kết

Chạy và kiểm tra ứng dụng. khi gõ vào trình duyệt là domain.xyz/ sẽ thấy kết quả helloworld như sau 

nhớ giả lập domain chứ đừng gõ localhost/[folder]/public nha, nó không ra vì file .htaccess đang redirect sai đó 

đây là code github của mình. bạn có thể tham khảo full source ở đây 

https://github.com/ThanhHungDev/site

những tag