WordPress源码深度解析之：`WordPress`的`HTTP API`：`wp_remote_get()`和`wp_remote_post()`的底层封装。

各位观众老爷，大家好！我是你们的老朋友，BUG终结者，今天要跟大家聊聊WordPress的HTTP API，特别是wp_remote_get()和wp_remote_post()这两个常用函数的底层封装。保证让你们听完之后，以后再也不怕跟外部API“眉来眼去”了。

一、HTTP API：WordPress的“外交官”

在WordPress的世界里，HTTP API就像一位尽职尽责的外交官，负责与其他服务器进行信息交流。比如，你想从某个第三方网站获取天气数据，或者向一个支付平台发送支付请求，都需要通过HTTP API来实现。WordPress自带了一套强大的HTTP API，而wp_remote_get()和wp_remote_post()就是其中的两位核心成员。

二、wp_remote_get()和wp_remote_post()：基本用法

先来简单回顾一下这两个函数的基本用法，毕竟基础打牢了，才能盖高楼大厦嘛。

• wp_remote_get()：获取数据

  这个函数的作用是向指定的URL发送一个GET请求，并获取服务器返回的数据。简单来说，就是“你给我网址，我帮你把东西拿回来”。

  $url = 'https://api.example.com/data'; // 替换成你要请求的URL
  $response = wp_remote_get( $url );
  
  if ( is_wp_error( $response ) ) {
      $error_message = $response->get_error_message();
      echo "Something went wrong: " . esc_html( $error_message );
  } else {
      $body = wp_remote_retrieve_body( $response );
      // 处理返回的数据
      echo "<pre>";
      print_r(json_decode($body));
      echo "</pre>";
  }

  这段代码首先定义了一个URL，然后使用wp_remote_get()发送GET请求。如果请求失败，会输出错误信息；如果请求成功，会获取响应体(body)并打印出来。

• wp_remote_post()：提交数据

  这个函数的作用是向指定的URL发送一个POST请求，并提交一些数据。你可以理解为“你给我网址和数据，我帮你把信送过去”。

  $url = 'https://api.example.com/submit'; // 替换成你要请求的URL
  $data = array(
      'name' => 'John Doe',
      'email' => '[email protected]'
  );
  
  $response = wp_remote_post( $url, array(
      'body' => $data
  ) );
  
  if ( is_wp_error( $response ) ) {
      $error_message = $response->get_error_message();
      echo "Something went wrong: " . esc_html( $error_message );
  } else {
      $body = wp_remote_retrieve_body( $response );
      // 处理返回的数据
      echo "<pre>";
      print_r(json_decode($body));
      echo "</pre>";
  }

  这段代码定义了一个URL和一个包含姓名和邮箱的数据数组。然后，使用wp_remote_post()发送POST请求，并将数据作为请求体发送。同样，如果请求失败，会输出错误信息；如果请求成功，会获取响应体并打印出来。

三、底层封装：揭秘HTTP API的“幕后英雄”

wp_remote_get()和wp_remote_post()只是WordPress HTTP API的“门面”，真正的“幕后英雄”是WP_HTTP类。这两个函数实际上是对WP_HTTP类方法的封装。

• WP_HTTP类：HTTP请求的“总指挥”

  WP_HTTP类负责处理所有的HTTP请求，包括GET、POST、PUT、DELETE等等。它会根据不同的服务器环境选择合适的HTTP传输方式，比如cURL、Streams或者Fsockopen。

  让我们来跟踪一下wp_remote_get()的源码：

  function wp_remote_get( $url, $args = array() ) {
      $http = _wp_http_get_object();
      return $http->get( $url, $args );
  }

  可以看到，wp_remote_get()首先通过_wp_http_get_object()获取一个WP_HTTP类的实例，然后调用WP_HTTP类的get()方法来处理GET请求。

  同样，wp_remote_post()的源码如下：

  function wp_remote_post( $url, $args = array() ) {
      $http = _wp_http_get_object();
      return $http->post( $url, $args );
  }

  wp_remote_post()也是先获取WP_HTTP类的实例，然后调用WP_HTTP类的post()方法来处理POST请求。

• _wp_http_get_object()：单例模式的“守护者”

  _wp_http_get_object()函数的作用是获取WP_HTTP类的单例实例。这意味着在整个WordPress运行过程中，只会存在一个WP_HTTP类的实例。这是一种常用的设计模式，可以避免重复创建对象，提高性能。

  function _wp_http_get_object() {
      static $http;
  
      if ( is_null( $http ) ) {
          $http = new WP_HTTP();
      }
  
      return $http;
  }

  这段代码首先定义一个静态变量$http。如果$http为空，则创建一个WP_HTTP类的实例并赋值给$http。否则，直接返回$http。

• WP_HTTP::request()：HTTP请求的“核心引擎”

  WP_HTTP类的get()和post()方法最终都会调用WP_HTTP::request()方法来发送HTTP请求。WP_HTTP::request()方法会根据传入的参数，选择合适的HTTP传输方式，并发送请求。

  WP_HTTP::request()方法的代码非常复杂，这里只给出简化版的伪代码：

  public function request( $url, $args = array() ) {
      // 1. 合并默认参数和传入参数
      $args = wp_parse_args( $args, $this->default_args );
  
      // 2. 根据URL判断是否支持SSL
      $ssl = ( 'https' == substr( $url, 0, 5 ) );
  
      // 3. 选择合适的HTTP传输方式
      if ( $ssl && ! $this->supports( array( 'ssl' ) ) ) {
          return new WP_Error( 'no_ssl', __( 'The server does not support SSL connections.' ) );
      } elseif ( $this->use_streams() ) {
          // 使用Streams
          $response = $this->request_by_streams( $url, $args );
      } elseif ( $this->use_curl() ) {
          // 使用cURL
          $response = $this->request_by_curl( $url, $args );
      } else {
          // 使用Fsockopen
          $response = $this->request_by_fsockopen( $url, $args );
      }
  
      // 4. 处理响应结果
      if ( is_wp_error( $response ) ) {
          return $response;
      } else {
          return new WP_HTTP_Response( $response['headers'], $response['body'], $response['response']['code'], $response['response']['message'] );
      }
  }

  这段伪代码展示了WP_HTTP::request()方法的主要流程：

  1. 合并默认参数和传入参数。
  2. 根据URL判断是否支持SSL。
  3. 选择合适的HTTP传输方式：
     • 如果支持SSL，并且服务器支持SSL连接，则选择Streams、cURL或者Fsockopen。
     • 如果不支持SSL，则返回错误。
  4. 处理响应结果：
     • 如果请求失败，则返回WP_Error对象。
     • 如果请求成功，则返回WP_HTTP_Response对象。

• HTTP传输方式的选择：Streams、cURL、Fsockopen

  WP_HTTP类支持多种HTTP传输方式，包括Streams、cURL和Fsockopen。它会根据服务器环境和配置，自动选择最佳的传输方式。

  传输方式	优点	缺点
  Streams	不需要额外的扩展，PHP自带	功能相对简单，不支持某些高级特性
  cURL	功能强大，支持各种协议和选项	需要安装cURL扩展
  Fsockopen	最原始的HTTP传输方式，几乎所有服务器都支持	功能最简单，性能也相对较差

  WP_HTTP类会优先选择Streams，如果Streams不可用，则选择cURL，如果cURL也不可用，则选择Fsockopen。

四、高级用法：自定义HTTP请求

除了基本用法之外，wp_remote_get()和wp_remote_post()还支持一些高级用法，可以让你更加灵活地控制HTTP请求。

• 自定义请求头

  你可以通过headers参数来自定义HTTP请求头。比如，你可以设置User-Agent、Content-Type等请求头。

  $url = 'https://api.example.com/data';
  $args = array(
      'headers' => array(
          'User-Agent' => 'My WordPress Plugin',
          'Content-Type' => 'application/json'
      )
  );
  
  $response = wp_remote_get( $url, $args );

• 设置超时时间

  你可以通过timeout参数来设置HTTP请求的超时时间，单位是秒。

  $url = 'https://api.example.com/data';
  $args = array(
      'timeout' => 10 // 设置超时时间为10秒
  );
  
  $response = wp_remote_get( $url, $args );

• 禁用SSL验证

  在某些情况下，你可能需要禁用SSL验证。比如，你的服务器使用了自签名证书，或者你正在测试一个未配置SSL的服务器。你可以通过sslverify参数来禁用SSL验证。

  $url = 'https://api.example.com/data';
  $args = array(
      'sslverify' => false // 禁用SSL验证
  );
  
  $response = wp_remote_get( $url, $args );

  注意： 禁用SSL验证可能会带来安全风险，请谨慎使用。

• 使用代理服务器

  如果你需要通过代理服务器来发送HTTP请求，可以使用proxy参数。

  $url = 'https://api.example.com/data';
  $args = array(
      'proxy' => 'http://proxy.example.com:8080' // 设置代理服务器
  );
  
  $response = wp_remote_get( $url, $args );

五、最佳实践：使用HTTP API的“葵花宝典”

在使用WordPress HTTP API时，有一些最佳实践可以帮助你避免一些常见的错误，并提高代码的质量。

• 错误处理：不要放过任何一个“坏蛋”

  在使用wp_remote_get()和wp_remote_post()时，一定要进行错误处理。如果请求失败，wp_remote_get()和wp_remote_post()会返回一个WP_Error对象。你需要检查返回值是否是WP_Error对象，如果是，则获取错误信息并进行处理。

  $response = wp_remote_get( $url );
  
  if ( is_wp_error( $response ) ) {
      $error_message = $response->get_error_message();
      // 记录日志
      error_log( 'HTTP request failed: ' . $error_message );
      // 显示友好的错误提示
      echo 'Oops, something went wrong. Please try again later.';
  } else {
      // 处理响应数据
  }

• 数据验证：防止“毒药”进入你的系统

  在处理HTTP响应数据时，一定要进行数据验证。不要相信任何来自外部的数据，因为它们可能是恶意的。

  $response = wp_remote_get( $url );
  
  if ( ! is_wp_error( $response ) ) {
      $body = wp_remote_retrieve_body( $response );
      $data = json_decode( $body );
  
      if ( is_object( $data ) && isset( $data->name ) && is_string( $data->name ) ) {
          // 数据验证通过，可以使用数据
          $name = sanitize_text_field( $data->name ); // 进行安全过滤
          echo 'Hello, ' . esc_html( $name ) . '!';
      } else {
          // 数据验证失败，记录日志
          error_log( 'Invalid data received from API.' );
      }
  }

• 缓存：让你的网站“飞”起来

  如果你的网站需要频繁地从同一个URL获取数据，可以考虑使用缓存来提高性能。WordPress提供了Transients API，可以方便地缓存数据。

  $transient_key = 'my_api_data';
  $data = get_transient( $transient_key );
  
  if ( false === $data ) {
      // 缓存不存在，从API获取数据
      $response = wp_remote_get( $url );
  
      if ( ! is_wp_error( $response ) ) {
          $body = wp_remote_retrieve_body( $response );
          $data = json_decode( $body );
  
          if ( is_object( $data ) ) {
              // 将数据缓存1小时
              set_transient( $transient_key, $data, 3600 );
          }
      }
  }
  
  if ( $data ) {
      // 使用缓存的数据
      echo 'Data from API: ' . $data->value;
  }

• 异步请求：让你的网站“响应如飞”

  如果你的HTTP请求需要花费很长时间，可以考虑使用异步请求来避免阻塞主线程。WordPress没有内置的异步请求功能，但你可以使用第三方插件来实现。

六、总结：HTTP API，你的“好帮手”

wp_remote_get()和wp_remote_post()是WordPress HTTP API中非常重要的两个函数。它们封装了底层的HTTP请求细节，让你能够方便地与外部服务器进行信息交流。通过理解它们的底层封装和高级用法，你可以更加灵活地控制HTTP请求，并提高代码的质量。

希望今天的讲解能够帮助大家更好地理解WordPress HTTP API。记住，HTTP API是你的“好帮手”，它可以帮助你构建更加强大和灵活的WordPress网站。

好了，今天的讲座就到这里。如果大家还有什么问题，欢迎在评论区留言。下次再见！