PHPは現在広く使われている言語で、海外のFacebookやTwitterから国内のタオバオ、テンセント、百度、インターネット上のあらゆる大中小のWebサイトに至るまで、様々なWebサイトで見ることができます。 PHP の成功は、そのオープンな拡張 API メカニズムと豊富な拡張コンポーネント (PHP 拡張) に大きく依存していると言えます。PHP がさまざまなデータベース操作から XML、JSON、暗号化、ファイル処理までを実行できるようにするのは、これらの拡張コンポーネントです。グラフィックス処理やSocketなどの分野で万能です。場合によっては、開発者が独自の PHP 拡張機能を開発する必要がある場合があります。PHP5 の現在の拡張機能メカニズムは、豊富なインターフェイスとマクロ定義に加えて、いくつかの実用的なツールを備えているため、PHP 拡張機能の開発はそれほど難しくありません。この記事では、PHP 拡張機能コンポーネントの開発に関する基本的な知識を紹介し、例を通じて PHP 拡張機能を開発する基本プロセスを示します。
PHP 拡張コンポーネントの開発プロセスは Unix 環境と Windows 環境では異なりますが、基本的に相互運用可能です。この記事は Unix 環境 (特に Linux を使用) に基づいて説明します。この記事を読むには、Unix 環境、PHP、および C 言語の基本的な知識を簡単に理解する必要があります。簡単に理解できる限り、オペレーティング システムと言語の特殊な機能については触れず、必要に応じて説明します。読者の読みを容易にします。
この記事の具体的な開発環境は、Ubuntu 10.04 + PHP 5.3.3です。
PHP 拡張機能を開発するには、最初のステップとして PHP ソース コードをダウンロードします。これには、拡張機能の開発に必要なツールが含まれています。私がダウンロードしたのは、tar.bz2 圧縮パッケージ形式の PHP 5.3.3 の最新バージョンです。
ダウンロードアドレスは: http://cn.php.net/get/php-5.3.3.tar.bz2/from/a/mirror
ダウンロード後、ソースコードを適切なディレクトリに移動し、それを解凍します。解凍コマンドは次のとおりです:
tar -jxvf ソースパッケージ名
tar.gz 圧縮パッケージをダウンロードする場合、解凍コマンドは
タール- zxvf ソースパッケージ名
解凍後、ソースコードディレクトリ内にextディレクトリがあり、PHP拡張機能に関連するディレクトリになります。ディレクトリに入り、ls で表示すると、多数の既存の拡張子が表示されます。下の写真は私の環境で表示した結果です:
青いのはすべて拡張パックのディレクトリで、おなじみの mysql、iconv、gd などが確認できます。 ext_skel は、Unix 環境で PHP 拡張フレームワークを自動生成するために使用されるスクリプト ツールです。 ext_skel_win32.php は、Windows での対応するスクリプトです。
次に、PHP 拡張機能 Say_hello を開発します。この拡張機能は非常に単純で、文字列パラメータを受け入れて「Hello xxx!」を出力するだけです。この例は、PHP 拡張コンポーネントの開発プロセスを紹介するだけであり、実際の機能を想定したものではありません。
PHP の拡張コンポーネント開発ディレクトリとファイルは、既存の拡張コンポーネント ディレクトリに入るだけですべてのファイルを表示できるようになっていると思います。もちろん、フレームワークを手動で構築することもできますが、何かに代わって構築してもらいたいと思うでしょう。上記の ext_skel スクリプトは、拡張機能パッケージ フレームワークを自動的に構築するために使用されるツールです。 ext_skel の完全なコマンドは次のとおりです:
ext_skel --extname=モジュール [--proto=ファイル] [--スタブ= file] [--xml[=file]] [--skel= dir] [--full-xml][--no-help]
ext_skel --extname=say_hello
次に、ls を使用してそれを表示すると、追加の「say_hello」ディレクトリがあることがわかります。このディレクトリに入ると、ext_skel がsay_hello の基本フレームワークを確立していることがわかります。 、以下に示すように:
PHP 拡張機能パッケージのディレクトリ構造全体の内容を理解するのが面倒な場合は、その中に注意する必要がある 3 つのファイルがあります:
config.m4: これUnix 環境のビルド システム構成ファイルであり、後で構成とインストールが生成されます。
php_say_hello.h: このファイルは拡張モジュールのヘッダー ファイルです。 C 言語の一貫したスタイルに従って、いくつかのカスタム構造体、グローバル変数などをこの中に配置できます。
say_hello.c: これは拡張モジュールのメイン プログラム ファイルです。拡張モジュールの各関数の最終エントリ ポイントはここにあります。もちろん、すべてのプログラム コードをその中に詰め込むこともできますし、モジュールの考え方に従って各機能モジュールを異なるファイルに入れることもできます。
以下のコンテンツは主にこれら 3 つのファイルを中心に展開します。
PHP 拡張コンポーネント開発の最初のステップは、実装コードを記述することではなく、最初にビルド システム オプションを構成することです。 Linux で開発しているため、ここでの設定は主に config.m4 に関連します。
Build System の設定に関しては、Unix システムの色々な事に関係するので、詳しく書けると、私が興味を持って書いても、皆さんは興味を持たずに読んでしまうと思いますので、ここでは省略し、重要なポイントのみに焦点を当てます。config.m4 の詳細については、ここを参照してください。
生成された config.m4 ファイルを開きます。内容はおおよそ次のとおりです。
dnl $Id$ dnl config.m4 for extension say_hello dnl Comments in this file start with the string 'dnl'. dnl Remove where necessary. This file will not work dnl without editing. dnl If your extension references something external, use with: dnl PHP_ARG_WITH(say_hello, for say_hello support, dnl Make sure that the comment is aligned: dnl [ --with-say_hello Include say_hello support]) dnl Otherwise use enable: dnl PHP_ARG_ENABLE(say_hello, whether to enable say_hello support, dnl Make sure that the comment is aligned: dnl [ --enable-say_hello Enable say_hello support]) if test "$PHP_SAY_HELLO" != "no"; then dnl Write more examples of tests here... dnl # --with-say_hello -> check with-path dnl SEARCH_PATH="/usr/local /usr" # you might want to change this dnl SEARCH_FOR="/include/say_hello.h" # you most likely want to change this dnl if test -r $PHP_SAY_HELLO/$SEARCH_FOR; then # path given as parameter dnl SAY_HELLO_DIR=$PHP_SAY_HELLO dnl else # search default path list dnl AC_MSG_CHECKING([for say_hello files in default path]) dnl for i in $SEARCH_PATH ; do dnl if test -r $i/$SEARCH_FOR; then dnl SAY_HELLO_DIR=$i dnl AC_MSG_RESULT(found in $i) dnl fi dnl done dnl fi dnl dnl if test -z "$SAY_HELLO_DIR"; then dnl AC_MSG_RESULT([not found]) dnl AC_MSG_ERROR([Please reinstall the say_hello distribution]) dnl fi dnl # --with-say_hello -> add include path dnl PHP_ADD_INCLUDE($SAY_HELLO_DIR/include) dnl # --with-say_hello -> check for lib and symbol presence dnl LIBNAME=say_hello # you may want to change this dnl LIBSYMBOL=say_hello # you most likely want to change this dnl PHP_CHECK_LIBRARY($LIBNAME,$LIBSYMBOL, dnl [ dnl PHP_ADD_LIBRARY_WITH_PATH($LIBNAME, $SAY_HELLO_DIR/lib, SAY_HELLO_SHARED_LIBADD) dnl AC_DEFINE(HAVE_SAY_HELLOLIB,1,[ ]) dnl ],[ dnl AC_MSG_ERROR([wrong say_hello lib version or lib not found]) dnl ],[ dnl -L$SAY_HELLO_DIR/lib -lm dnl ]) dnl dnl PHP_SUBST(SAY_HELLO_SHARED_LIBADD) PHP_NEW_EXTENSION(say_hello, say_hello.c, $ext_shared) fi
「dnl」で始まる部分はすべてコメントなので、あまり読まないでください。実際に働きます。ここで設定する必要があるのは次の行だけです:
dnl If your extension references something external, use with: dnl PHP_ARG_WITH(say_hello, for say_hello support, dnl Make sure that the comment is aligned: dnl [ --with-say_hello Include say_hello support]) dnl Otherwise use enable: dnl PHP_ARG_ENABLE(say_hello, whether to enable say_hello support, dnl Make sure that the comment is aligned: dnl [ --enable-say_hello Enable say_hello support])
誰でも理解できると思いますが、これは「拡張機能が外部コンポーネントを参照する場合は...を使用し、そうでない場合は...を使用します。」という意味です。 Say_hello 拡張機能は外部コンポーネントを参照しないため、「それ以外の場合は、enable を使用する」の下の 3 行の「dnl」を削除し、次のように変更します。
say_hello_module_entry は、say_hello 拡張機能に対応する C 言語の要素です。それについて タイプの定義zend_module_entry これは、PHP ソース コードの「Zend/zend_modules.h」ファイルにあります。 次のコードは、zend_module_entry の定義です。
dnl Otherwise use enable: PHP_ARG_ENABLE(say_hello, whether to enable say_hello support, Make sure that the comment is aligned: [ --enable-say_hello Enable say_hello support])
この構造は少しわかりにくいように思えるかもしれませんが、それでも必要です。内容を説明します。これは PHP Extension のプロトタイプなので、これを理解しないと PHP Extension の開発はできません。もちろん、各フィールドを 1 つずつ説明することはしません。多くのフィールドは手動で入力する必要がなく、特定の定義済みマクロを使用できるためです。
9番目から12番目のフィールドはそれぞれ4つの関数ポインタであり、これら4つの関数はそれぞれ「拡張モジュールのロード時」、「拡張モジュールのアンロード時」、「各リクエストの開始時」、および「拡張モジュールのアンロード時」に呼び出されます。 「各リクエストの終了時」。これら 4 つの機能はインターセプト メカニズムとみなすことができ、主にリソースの割り当て、解放、および対応する時間のその他の関連操作に使用されます。
13番目のフィールド「info_func」も関数ポインタであり、phpinfo()の実行時にこのポインタが指す関数が呼び出され、カスタムモジュールの情報が表示されます。
14番目のフィールド「version」はモジュールのバージョンです。
(zend_module_entry の詳細については、こちらを参照してください)
上記のフィールドを導入した後、「say_hello.c」で自動的に生成された「say_hello_module_entry」フレームワーク コードを見てみましょう。
/* {{{ say_hello_module_entry
*/
zend_module_entry say_hello_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
STANDARD_MODULE_HEADER,
#endif
"say_hello",
say_hello_functions,
PHP_MINIT(say_hello),
PHP_MSHUTDOWN(say_hello),
PHP_RINIT(say_hello), /* Replace with NULL if there's nothing to do at request start */
PHP_RSHUTDOWN(say_hello), /* Replace with NULL if there's nothing to do at request end */
PHP_MINFO(say_hello),
#if ZEND_MODULE_API_NO >= 20010901
"0.1", /* Replace with version number for your extension */
#endif
STANDARD_MODULE_PROPERTIES
};
/* }}} */首先，宏“STANDARD_MODULE_HEADER”会生成前6个字段，“STANDARD_MODULE_PROPERTIES ”会生成“version”后的字段，所以现在我们还不用操心。而我们关心的几个字段，也都填写好或由宏生成好了，并且在“say_hello.c”的相应位置也生成了几个函数的框架。这里要注意，几个宏的参数均为“say_hello”，但这并不表示几个函数的名字全为“say_hello”，C语言中也不可能存在函数名重载机制。实际上，在开发PHP Extension的过程中，几乎处处都要用到Zend里预定义的各种宏，从全局变量到函数的定义甚至返回值，都不能按照“裸写”的方式来编写C语言，这是因为PHP的运行机制可能会导致命名冲突等问题，而这些宏会将函数等元素变换成一个内部名称，但这些对程序员都是透明的（除非你去阅读那些宏的代码），我们通过各种宏进行编程，而宏则为我们处理很多内部的东西。
写到这里，我们的任务就明了了：第一，如果需要在相应时机处理一些东西，那么需要填充各个拦截函数内容；第二，编写say_hello的功能函数，并将引用添加到say_hello_functions中。
因为say_hello扩展在各个生命周期阶段并不需要做操作，所以我们只编写info_func的内容，上文说过，这个函数将在phpinfo()执行时被自动调用，用于显示扩展的信息。编写这个函数会用到四个函数：
php_info_print_table_start()——开始phpinfo表格。无参数。
php_info_print_table_header()——输出表格头。第一个参数是整形，指明头的列数，然后后面的参数是与列数等量的(char*)类型参数用于指定显示的文字。
php_info_print_table_row()——输出表格内容。第一个参数是整形，指明这一行的列数，然后后面的参数是与列数等量的(char*)类型参数用于指定显示的文字。
php_info_print_table_end()——结束phpinfo表格。无参数。
下面是“say_hello.c”中需要编写的info_func的具体代码：
/* {{{ PHP_MINFO_FUNCTION
*/
PHP_MINFO_FUNCTION(say_hello)
{
php_info_print_table_start();
php_info_print_table_header(2, "say_hello support", "enabled");
php_info_print_table_row(2, "author", "Zhang Yang"); /* Replace with your name */
php_info_print_table_end();
/* Remove comments if you have entries in php.ini
DISPLAY_INI_ENTRIES();
*/
}
/* }}} */可以看到我们编写了两行内容、组件是否可用以及作者信息。
编写核心函数，总共分为三步：1、使用宏PHP_FUNCTION定义函数体；2、使用宏ZEND_BEGIN_ARG_INFO和ZEND_END_ARG_INFO定义参数信息；3、使用宏PHP_FE将函数加入到say_hello_functions中。下面分步说明。
PHP_FUNCTION(say_hello_func)
{
char *name;
int name_len;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE)
{
return;
}
php_printf("Hello %s!", name);
RETURN_TRUE;
}上文说过，编写PHP扩展时几乎所有东西都不能裸写，而是必须使用相应的宏。从上面代码可以清楚看到这一点。总体来说，核心函数代码一般由如下几部分构成：
定义函数，这一步通过宏PHP_FUNCTION实现，函数的外部名称就是宏后面括号里面的名称。
声明并定义局部变量。
解析参数，这一步通过zend_parse_parameters函数实现，这个函数的作用是从函数用户的输入栈中读取数据，然后转换成相应的函数参数填入变量以供后面核心功能代码使用。zend_parse_parameters的第一个参数是用户传入参数的个数，可以由宏“ZEND_NUM_ARGS() TSRMLS_CC”生成；第二个参数是一个字符串，其中每个字母代表一个变量类型，我们只有一个字符串型变量，所以第二个参数是“s”；最后各个参数需要一些必要的局部变量指针用于存储数据，下表给出了不同变量类型的字母代表及其所需要的局部变量指针。
参数解析完成后就是核心功能代码，我们这里只是输出一行字符，php_printf是Zend版本的printf。
最后的返回值也是通过宏实现的。RETURN_TRUE宏是返回布尔值“true”。
参数信息是函数所必要部分，这里不做深究，直接给出相应代码：
ZEND_BEGIN_ARG_INFO(arginfo_say_hello_func, 0) ZEND_END_ARG_INFO()
如需了解具体信息请阅读相关宏定义。
最后，我们需要将刚才定义的函数和参数信息加入到say_hello_functions数组里，代码如下：
const zend_function_entry say_hello_functions[] = {
PHP_FE(say_hello_func, arginfo_say_hello_func)
{NULL, NULL, NULL}
};这一步就是通过PHP_EF宏实现，注意这个数组最后一行必须是{NULL, NULL, NULL} ，请不要删除。
下面是编写完成后的say_hello.c全部代码：
/*
+----------------------------------------------------------------------+
| PHP Version 5 |
+----------------------------------------------------------------------+
| Copyright (c) 1997-2010 The PHP Group |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
| Author: ZhangYang |
+----------------------------------------------------------------------+
*/
/* $Id: header 297205 2010-03-30 21:09:07Z johannes $ */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "php_say_hello.h"
/* If you declare any globals in php_say_hello.h uncomment this:
ZEND_DECLARE_MODULE_GLOBALS(say_hello)
*/
/* True global resources - no need for thread safety here */
static int le_say_hello;
/* {{{ PHP_FUNCTION
*/
PHP_FUNCTION(say_hello_func)
{
char *name;
int name_len;
if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &name, &name_len) == FAILURE)
{
return;
}
php_printf("Hello %s!", name);
RETURN_TRUE;
}
ZEND_BEGIN_ARG_INFO(arginfo_say_hello_func, 0)
ZEND_END_ARG_INFO()
/* }}} */
/* {{{ say_hello_functions[]
*
* Every user visible function must have an entry in say_hello_functions[].
*/
const zend_function_entry say_hello_functions[] = {
PHP_FE(say_hello_func, arginfo_say_hello_func)
{NULL, NULL, NULL} /* Must be the last line in say_hello_functions[] */
};
/* }}} */
/* {{{ say_hello_module_entry
*/
zend_module_entry say_hello_module_entry = {
#if ZEND_MODULE_API_NO >= 20010901
STANDARD_MODULE_HEADER,
#endif
"say_hello",
say_hello_functions,
NULL,
NULL,
NULL,
NULL,
PHP_MINFO(say_hello),
#if ZEND_MODULE_API_NO >= 20010901
"0.1", /* Replace with version number for your extension */
#endif
STANDARD_MODULE_PROPERTIES
};
/* }}} */
#ifdef COMPILE_DL_SAY_HELLO
ZEND_GET_MODULE(say_hello)
#endif
/* {{{ PHP_MINFO_FUNCTION
*/
PHP_MINFO_FUNCTION(say_hello)
{
php_info_print_table_start();
php_info_print_table_header(2, "say_hello support", "enabled");
php_info_print_table_row(2, "author", "Zhang Yang"); /* Replace with your name */
php_info_print_table_end();
/* Remove comments if you have entries in php.ini
DISPLAY_INI_ENTRIES();
*/
}
/* }}} */在say_hello目录下输入下面命令：
/usr/bin/phpize
./configure
make
make install
这样就完成了say_hello扩展的安装（如果没有报错的话）。
这时如果你去放置php扩展的目录下，会发现多了一个say_hello.so的文件。如下图所示：
下面就是将其加入到php.ini配置中，然后重启Apache（如果需要的话）。这些都是PHP基本配置的内容，我就不详述了。
如果上面顺利完成，这时运行phpinfo()，应该能看到如下信息：
这说明扩展已经安装成功了。然后我们编写一个测试用PHP脚本：
<?php say_hello_func('Zhang Yang'); ?>;
执行这个脚本，结果如下：
说明扩展已经正常工作了。
这篇文章主要用示例方法介绍PHP Extension的开发基础。在PHP的使用中，也许是因为需要支持新的组件（如新的数据库），又或是业务需要或性能需要，几乎都会遇到需要开发PHP扩展的地方。后续如果有机会，我会写文章介绍一些关于扩展开发较为深入的东西，如扩展模块生命周期、INI使用以及编写面向对象的扩展模块等等。
以上がPHP 拡張機能の開発についての深い理解の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。
![[Web フロントエンド] Node.js クイック スタート](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
