lostphp

just do it

基于PHP7的PHP扩展开发之十一(对象方式使用lib库)

目的:使用对象的方式调用lib库。
在扩展中实现hello类。hello类中将依赖lib库。调用代码如下:

1
2
3
4
5
<?php
$hello = new hello();
$result = $hello->get();
var_dump($result);
?>

基础代码
这个扩展,我们将在myecho扩展上增加相关代码

建立lib库

增加hello.h文件。代码如下:

1
2
3
4
5
6
7
8
9
#ifndef TEST_HEADER_FILE
#define TEST_HEADER_FILE
 
#include <stdlib.h>
#include <string.h>
 
char * show_site(); 
 
#endif

增加hello.c文件。代码如下:

1
2
3
4
5
6
7
8
#include "hello.h"
 
char * show_site()
{
    char *site = malloc(15 * sizeof(char));
    strcpy(site, "www.lostphp.com");
    return site;
}

然后使用以下命令生成lib库(动态库)文件:

1
$ gcc -g -O0 -fPIC -shared -o hello.so ./hello.c

这样在当前目录下就会生成一个hello.so的动态库文件。不同操作系统动态库的扩展名可能不一样。如 windows下是dll,mac下是 dylib,linux下是so。
然后把hello.so拷贝到/usr/local/lib/目录下,命名为hello.so 把hello.h拷贝到/usr/local/include/目录下。
修改config.m4文件
增加扩展对动态库的依赖。主要增加以下几行代码:

1
2
PHP_ADD_LIBRARY_WITH_PATH(hello, /usr/local/lib/, MYECHO_SHARED_LIBADD)
PHP_SUBST(MYECHO_SHARED_LIBADD)

编写扩展代码

修改myecho.c文件 增加hello.h的引用。

1
2
3
4
#include "php_myecho.h"
#include <stdio.h>
//下面这行是增加的
#include "hello.h"

声明一个指针变量,用于存储类的地址。 在static int le_myecho;行下面增加如下代码:

1
zend_class_entry *hello_ce;

声明一个变量,用于存储类的处理函数。增加如下代码:

1
zend_object_handlers hello_object_handlers;

定义一个结构体类型,用于存储类的一些信息。如lib库信息。

1
2
3
4
typedef struct _hello_object {
    char * hello_ptr;
    zend_object std;
} hello_object;

注意,zend_object std一定要放在最后一行。

定义一个函数,用于从标准的zend_object转换获取hello_object地址。

1
2
3
static inline hello_object *hello_fetch_object(zend_object *obj) /* {{{ */ {
        return (hello_object *)((char*)(obj) - XtOffsetOf(hello_object, std));
}

定义一个函数,用户创建类对象。代码如下:

1
2
3
4
5
6
7
8
static zend_object * hello_object_create(zend_class_entry *type TSRMLS_DC)
{
    hello_object *obj = (hello_object *)ecalloc(1, sizeof(hello_object) + zend_object_properties_size(type));
    zend_object_std_init(&obj->std, type);
    object_properties_init(&obj->std, type);
    obj->std.handlers = &hello_object_handlers;
    return &obj->std;
}

定义函数,用户销毁类对象。代码如下:

1
2
3
4
5
void hello_object_free_storage(zend_object *object)
{
    hello_object *intern = hello_fetch_object(object);
    zend_object_std_dtor(&intern->std);
}

声明类都有哪些方法。增加如下代码:

1
2
3
4
5
6
7
8
9
PHP_METHOD(hello, __construct);
PHP_METHOD(hello, __destruct);
PHP_METHOD(hello, get);
const zend_function_entry hello_methods[] = {
            PHP_ME(hello, __construct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
            PHP_ME(hello, __destruct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
            PHP_ME(hello, get, NULL, ZEND_ACC_PUBLIC)
            {NULL, NULL, NULL}    /* Must be the last line in hello_methods[] */
};

把上面声明和定义的函数结合起来。 在PHP_MINIT_FUNCTION方法中增加如下代码:

1
2
3
4
5
6
7
8
zend_class_entry ce;
INIT_CLASS_ENTRY(ce, "hello", hello_methods);
hello_ce = zend_register_internal_class(&ce);
hello_ce->create_object = hello_object_create;
memcpy(&hello_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
hello_object_handlers.clone_obj = NULL;
hello_object_handlers.offset = XtOffsetOf(hello_object, std);
hello_object_handlers.free_obj = hello_object_free_storage;

实现在hello_methods中指定的类的方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
PHP_METHOD(hello, __construct)
{
    zval  *self = getThis();
    hello_object *obj = hello_fetch_object(Z_OBJ_P((self)));
    obj->hello_ptr = show_site();
    RETURN_TRUE;
}
 
PHP_METHOD(hello, __destruct)
{
    zval  *self = getThis();
    hello_object *obj = hello_fetch_object(Z_OBJ_P((self)));
    free(obj->hello_ptr);
    RETURN_TRUE;
}
 
PHP_METHOD(hello, get)
{
    zval  *self = getThis();
    hello_object *obj = hello_fetch_object(Z_OBJ_P((self)));
    RETURN_STRING(obj->hello_ptr);
}

php调用结果

执行结果

$php ./test.php
string(15) "www.lostphp.com"

代码解读

类的创建,之前有一篇文章专门讲述过流程。调用lib创建对象和普通创建对象不同之处:

需要一个结构体来保存对象与lib库资源之间的关系。如上面的hello_object。
需要定义一些方法。如创建对象,消耗对象,对象转换的方法。
需要在PHP_MINIT_FUNCTION中把定义的方法和类绑定起来。

点赞