详解 WordPress `wp_rest_server_class` 过滤器源码：如何替换默认的 REST API 服务器类。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷，晚上好！今天咱们来聊聊 WordPress REST API 的一个隐藏技能：替换默认的 REST API 服务器类。这玩意儿听起来很高大上，实际上就是允许你接管 WordPress REST API 的核心处理逻辑，实现一些骚操作。咱们先来了解下背景，然后深入源码，最后手把手教你如何替换它。

一、REST API 服务器类：幕后英雄

WordPress REST API 默认使用 WP_REST_Server 类来处理所有的 API 请求。这个类负责解析请求、路由请求到相应的处理器、验证权限、格式化响应等等。可以说，它是整个 REST API 的大脑。

那么，为什么要替换它呢？理由有很多：

定制化权限验证： 默认的权限验证可能无法满足你的需求，比如你想根据用户角色、自定义元数据等进行更复杂的权限控制。
修改请求解析逻辑： 你可能想支持新的请求头、请求体格式，或者修改现有的解析方式。
优化性能： WP_REST_Server 类可能存在性能瓶颈，你可以通过自定义类来优化处理流程。
扩展功能： 你可以添加新的 API 功能，比如日志记录、监控等。
代码复用: 如果你已经在其他项目中实现了类似的 REST API 处理逻辑，可以通过替换 WP_REST_Server 类来复用代码。

二、wp_rest_server_class 过滤器：入口

要替换 WP_REST_Server 类，我们就要用到 wp_rest_server_class 过滤器。这个过滤器允许你指定一个不同的类名，WordPress 就会使用你指定的类来创建 REST API 服务器实例。

这个过滤器在 WordPress 的 wp-includes/rest-api.php 文件中被定义，具体位置如下：

/**
 * Filters the REST API server class name.
 *
 * @since 4.4.0
 *
 * @param string $class_name The REST API server class name.
 */
$wp_rest_server_class = apply_filters( 'wp_rest_server_class', 'WP_REST_Server' );

$wp_rest = new $wp_rest_server_class;

可以看到，apply_filters() 函数接收两个参数：

'wp_rest_server_class'：过滤器的名称。
'WP_REST_Server'：默认的类名。

这意味着，如果你不添加任何过滤器，WordPress 就会使用 WP_REST_Server 类。但如果你添加了过滤器，就可以修改 $class_name 的值，从而替换默认的类。

三、源码剖析：WP_REST_Server 类

在深入替换方法之前，我们先来简单了解一下 WP_REST_Server 类的主要组成部分。

这个类包含以下几个重要的属性和方法：

$request： WP_REST_Request 类的实例，表示当前的 API 请求。
$response： WP_REST_Response 类的实例，表示 API 的响应。
serve_request()： 处理 API 请求的主方法。它负责解析请求、路由请求到相应的处理器、验证权限、格式化响应等等。
get_routes()： 获取所有已注册的 API 路由。
dispatch()： 将请求分发到相应的处理器。
error_to_response()： 将错误信息转换为 WP_Error 对象。
respond_to_request()： 根据请求的格式，生成相应的响应。

了解这些属性和方法，可以帮助你更好地理解 WP_REST_Server 类的工作原理，从而更容易地替换它。

四、实战演练：替换 REST API 服务器类

现在，我们来手把手教你如何替换 WP_REST_Server 类。

步骤 1：创建自定义类

首先，我们需要创建一个自定义类，这个类必须继承 WP_REST_Server 类，或者实现 WP_REST_Server 接口（如果存在）。

例如，我们可以创建一个名为 My_REST_Server 的类：

<?php
/**
 * 自定义 REST API 服务器类.
 */
class My_REST_Server extends WP_REST_Server {

    /**
     * 构造函数.
     */
    public function __construct() {
        parent::__construct(); // 调用父类的构造函数，确保初始化
    }

    /**
     * 重写 serve_request() 方法，添加自定义逻辑.
     *
     * @param string $path 请求路径.
     * @return void
     */
    public function serve_request( $path ) {
        // 在处理请求之前，添加自定义逻辑
        error_log('My_REST_Server: 开始处理请求 - ' . $path);

        // 调用父类的 serve_request() 方法，继续处理请求
        parent::serve_request( $path );

        // 在处理请求之后，添加自定义逻辑
        error_log('My_REST_Server: 请求处理完毕 - ' . $path);
    }

    /**
     * 重写 respond_to_request() 方法，修改响应格式.
     *
     * @param WP_REST_Response $response  响应对象.
     * @param WP_REST_Request  $request   请求对象.
     * @param array            $route     路由信息.
     * @param bool             $blocking  是否阻塞.
     * @return WP_HTTP_Response HTTP 响应对象.
     */
    protected function respond_to_request( $response, $request, $route = array(), $blocking = false ) {
        // 修改响应头
        header('X-Custom-Header: Hello World!');

        // 调用父类的 respond_to_request() 方法，生成响应
        return parent::respond_to_request( $response, $request, $route, $blocking );
    }
}

在这个例子中，我们重写了 serve_request() 和 respond_to_request() 方法，添加了一些自定义逻辑。

serve_request() 方法会在处理请求之前和之后记录日志。
respond_to_request() 方法会添加一个自定义的响应头。

步骤 2：使用 wp_rest_server_class 过滤器

接下来，我们需要使用 wp_rest_server_class 过滤器来指定我们自定义的类。你可以在你的主题的 functions.php 文件或者一个自定义插件中添加以下代码：

<?php
/**
 * 替换 REST API 服务器类.
 */
add_filter( 'wp_rest_server_class', 'my_custom_rest_server_class' );

/**
 * 返回自定义 REST API 服务器类名.
 *
 * @return string
 */
function my_custom_rest_server_class() {
    return 'My_REST_Server';
}

这段代码会将 WP_REST_Server 类替换为 My_REST_Server 类。

步骤 3：测试

现在，你可以测试你的 REST API 是否正常工作。你可以发送一个 API 请求，然后查看服务器的日志，看看是否输出了我们自定义的日志信息。你也可以查看响应头，看看是否包含了我们添加的自定义头。

五、高级用法：更复杂的定制

除了重写 serve_request() 和 respond_to_request() 方法之外，你还可以重写其他方法，或者添加新的方法和属性，来实现更复杂的定制。

例如，你可以重写 dispatch() 方法，来实现自定义的路由逻辑。你也可以添加新的属性，来存储自定义的配置信息。

举例1：自定义权限验证

假设你想根据用户的自定义元数据来验证权限，你可以重写 permission_check() 方法：

<?php
/**
 * 自定义 REST API 服务器类.
 */
class My_REST_Server extends WP_REST_Server {

    /**
     * 重写 permission_check() 方法，添加自定义权限验证逻辑.
     *
     * @param WP_REST_Request $request 请求对象.
     * @return WP_Error|bool
     */
    public function permission_check( $request ) {
        // 获取当前用户
        $user = wp_get_current_user();

        // 检查用户是否登录
        if ( ! $user->exists() ) {
            return new WP_Error( 'rest_not_logged_in', '你需要登录才能访问这个 API。', array( 'status' => 401 ) );
        }

        // 获取自定义元数据
        $custom_meta = get_user_meta( $user->ID, 'my_custom_meta', true );

        // 检查自定义元数据的值
        if ( $custom_meta !== 'allowed' ) {
            return new WP_Error( 'rest_forbidden', '你没有权限访问这个 API。', array( 'status' => 403 ) );
        }

        // 允许访问
        return true;
    }
}

举例2：添加自定义 API 功能

假设你想添加一个自定义的 API 功能，比如记录 API 请求的日志，你可以重写 serve_request() 方法：

<?php
/**
 * 自定义 REST API 服务器类.
 */
class My_REST_Server extends WP_REST_Server {

    /**
     * 重写 serve_request() 方法，添加自定义日志记录功能.
     *
     * @param string $path 请求路径.
     * @return void
     */
    public function serve_request( $path ) {
        // 记录日志
        $this->log_request( $path );

        // 调用父类的 serve_request() 方法，继续处理请求
        parent::serve_request( $path );
    }

    /**
     * 记录 API 请求日志.
     *
     * @param string $path 请求路径.
     * @return void
     */
    protected function log_request( $path ) {
        // 获取当前时间
        $time = date( 'Y-m-d H:i:s' );

        // 获取客户端 IP 地址
        $ip = $_SERVER['REMOTE_ADDR'];

        // 记录日志
        error_log( "{$time} - {$ip} - {$path}" );
    }
}

六、注意事项

谨慎修改核心逻辑： 替换 WP_REST_Server 类会影响整个 REST API 的行为，因此在修改核心逻辑之前，一定要仔细考虑清楚，并进行充分的测试。
保持兼容性： 尽量保持与 WP_REST_Server 类的兼容性，避免破坏现有的 API 功能。
代码质量： 确保你的自定义类的代码质量高，避免出现安全漏洞或者性能问题。
错误处理： 添加完善的错误处理机制，以便在出现问题时能够及时发现并解决。
文档： 编写清晰的文档，说明你的自定义类的功能和用法，方便其他人使用和维护。

七、总结

替换 WordPress REST API 服务器类是一个强大的技术，可以让你完全掌控 REST API 的核心处理逻辑，实现各种定制化的需求。但是，它也是一项复杂的任务，需要你对 WordPress REST API 的工作原理有深入的了解。希望今天的讲座能够帮助你更好地理解这项技术，并在实际项目中灵活运用。

最后，给大家留个思考题：如何通过替换 WP_REST_Server 类，来实现 API 请求的缓存？欢迎大家在评论区留言讨论。

感谢各位的观看！祝大家编程愉快！

发表回复 取消回复

发表回复取消回复