开发函数计算的正确姿势———为 PHP 运行时添加自定义扩展

发布于 2月26日  约 22 分钟

PHP 语言提供了一种扩展机制(Extension),通过 PHP 扩展可以增强语法、调用 C/C++ 实现的库函数以及优化执行性能。PHP 扩展是与平台相关的动态链接库,在 Linux 和 Mac 平台是 .so 文件,在 Windows 平台是 .dll 文件。由于函数计算的开发通常在 Mac 和 Windows 平台,而运行时是 Linux(Debain)环境,所以为函数计算 PHP 运行时添加扩展会遇到由于动态链接库平台相关而导致要么本地无法调试,要么远端无法运行的问题。本文介绍借助 Funcraft 工具提供的模拟环境进行 PHP 扩展的安装、本地运行调试以及构建发布。

准备工作

依赖工具

本项目是在 MacOS 下开发的,涉及到的工具是平台无关的,对于 Linux 和 Windows 桌面系统应该也同样适用。在开始本例之前请确保如下工具已经正确的安装,更新到最新版本,并进行正确的配置。

Fun 和 Fcli 工具依赖于 docker 来模拟本地环境。
对于 MacOS 用户可以使用 homebrew 进行安装:

brew cask install docker
brew tap vangie/formula
brew install fun
brew install fcli

Windows 和 Linux 用户安装请参考:

  1. https://github.com/aliyun/fun/blob/master/docs/usage/installation.md
  2. https://github.com/aliyun/fcli/releases

安装好后,记得先执行 fun config 初始化一下配置。

注意, 如果你已经安装过了 fun,确保 fun 的版本在 3.6.1 以上。

$ fun --version
3.6.1

PHP 自定义扩展

在函数代码目录创建一个名为 extension 的目录,并且将扩展对应的 .ini 和 .so 文件放在 extension 目录下。例如,以下为一个 hello 的自定义扩展,假设该扩展里有一份 hello_world 函数:

.
|____extension
| |____hello.ini
| |____hello.so
|____main.php

hello.ini

extension=/code/extension/hello.so

main.php

 <?php
  function handler($event, $context) {
      var_dump(extension_loaded('hello'));
      hello_world();
      return "ok";
  }

上述方法是函数计算PHP 运行时提供的扩展方法。实践过程中会碰到如下两个问题:

  1. .so 文件应该如何构建出来,或者去哪里下载
  2. 有了 .so 文件后,本地如何调试代码

完整示例

下面会基于借用 [PHP 访问 MongoDB 的例子]()来介绍如何借助于 Funcraft 进行 PHP 开发,因为 composer 依赖 mongodb/mongodb 需要安装 extension。

初始化项目

# 创建工程目录并进入
$ mkdir fc-mongodb && cd fc-mongodb

# 初始化
$ fun init event-php7.2

通过 Funfile 安装

我们在 Linux 平台下通常会通过 pecl 工具进行 PHP 的扩展安装。比如 pecl install mongodb。该命令会触发源代码下载、编译并拷贝到系统 PHP 目录。pecl 需要执行在 Linux 环境中才能装linux 版本的 .so 文件。在函数计算这里可以通过 fun install 机制进行安装。

新建一个 Funfile 文件,内容如下:

RUNTIME php7.2
RUN apt-get update && apt-get install -y libcurl4-openssl-dev pkg-config libssl-dev
RUN pecl install mongodb
RUN mkdir -p /code/extension && mv /usr/local/lib/php/extensions/*/mongodb.so /code/extension
RUN echo "extension=/code/extension/mongodb.so" > /code/extension/mongodb.ini

逐行解释一下上面五行指令

  1. 第一行先声明是一个 php7.2 版本的 Runtime,
  2. 接着安装 构建 mongodb 所需要的依赖,这里主要是为了装 openssl,为了能让 mongodb 扩展库支持 ssl,以解决连接时的一个报错。所有
  3. 通过 pecl 下载、构建并且安装 mongodb 扩展
  4. 将 mongodb 扩展拷贝到 /code/extendsion 目录,该目录是函数计算约定的 extension 目录
  5. 生成 mongodb.int 文件,这里文件名是随意的,只需要 .ini 结尾就好了。

然后执行

fun install -f php
using template: template.yml
...

Install Success

安装以后会多处一个 extension 目录,包含 mongodb.so 和 mongodb.ini 文件

╰─➜  tree
.
├── Funfile
├── extension
│   ├── mongodb.ini
│   └── mongodb.so
├── index.php
└── template.yml

安装 mongodb 依赖

执行下面命令通过 composer 安装依赖 'mongodb/mongodb'

$ fun install sbox -f fc-mongodb -c "composer require mongodb/mongodb"
using template: template.yml
skip pulling image aliyunfc/runtime-php7.2:build-1.9.0...
Using version ^1.6 for mongodb/mongodb
./composer.json has been created
Loading composer repositories with package information
Updating dependencies (including require-dev)
Package operations: 1 install, 0 updates, 0 removals
  - Installing mongodb/mongodb (1.6.0): Downloading (100%)         
Writing lock file
Generating autoload files

安装成功后会在代码目录多处 composer.json 文件、composer.lock 文件和 vendor 目录

╰─➜  tree -L 2
.
├── Funfile
├── composer.json
├── composer.lock
├── extension
│   ├── mongodb.ini
│   └── mongodb.so
├── index.php
├── template.yml
└── vendor
    ├── autoload.php
    ├── composer
    └── mongodb

本地调试

更新 index.php 文件

<?php

require 'vendor/autoload.php';
function handler($event, $context)
{

    $db_name = $_ENV['MONGO_DATABASE'];
    $uri = $_ENV['MONGO_URL'];
    $client = new MongoDB\Client($uri);
    $collection = $client->$db_name->fc_col;
    $result = $collection->insertOne(['DEMO' => 'FC', 'MSG' => 'Hello FunctionCompute For MongoDB']);
    echo "Inserted with Object ID '{$result->getInsertedId()}'", "\n";
    $cursor = $collection->find(['DEMO' => 'FC']);
    $result = '';
    foreach ($cursor as $entry) {
        echo json_encode($entry->getArrayCopy()), "\n";
        $result = $result . json_encode($entry->getArrayCopy()) . "\n";
    }
    return $result;
}

借助 docker 启动一个临时的 mongodb 数据库

docker run --rm --name mongo_for_fc \
    -e MONGO_INITDB_ROOT_USERNAME=mongoadmin \
    -e MONGO_INITDB_ROOT_PASSWORD=secret \
    -p 27017:27017 \
    mongo

更新 template.yml 文件,添加 MONGO_DATABASEMONGO_URL 环境变量。

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  fc-mongodb:
    Type: 'Aliyun::Serverless::Service'
    Properties:
      Description: 'helloworld'
    fc-mongodb:
      Type: 'Aliyun::Serverless::Function'
      Properties:
        Handler: index.handler
        Runtime: php7.2
        CodeUri: './'
        EnvironmentVariables:
          MONGO_DATABASE: admin
          MONGO_URL: mongodb://mongoadmin:secret@host.docker.internal:27017/admin

使用 fun local 本地模拟运行

$ fun local invoke
using template: template.yml

Missing invokeName argument, Fun will use the first function fc-mongodb/fc-mongodb as invokeName

skip pulling image aliyunfc/runtime-php7.2:1.9.2...
FunctionCompute php7.2 runtime inited.
FC Invoke Start RequestId: b1764771-896b-4c27-9ad8-6c325cc3d749
Inserted with Object ID '5e539d08c42dc23cf23863e2'
{"_id":{"$oid":"5e539d08c42dc23cf23863e2"},"DEMO":"FC","MSG":"Hello FunctionCompute For MongoDB"}
FC Invoke End RequestId: b1764771-896b-4c27-9ad8-6c325cc3d749
{"_id":{"$oid":"5e539d08c42dc23cf23863e2"},"DEMO":"FC","MSG":"Hello FunctionCompute For MongoDB"}


RequestId: b1764771-896b-4c27-9ad8-6c325cc3d749          Billed Duration: 214 ms         Memory Size: 1989 MB    Max Memory Used: 27 MB

如果希望本地断点调试可以使用 Aliyun Serverless VSCode Extension,如下图

发布并调用

请将 template.yml 配置文件中的 MONGO_DATABASEMONGO_URL 环境变量更新为您线上系统的相应配置,然后发布

$ fun deploy
using template: template.yml
using region: cn-shanghai
using accountId: ***********4733
using accessKeyId: ***********EUz3
using timeout: 60

Collecting your services information, in order to caculate devlopment changes...

Resources Changes(Beta version! Only FC resources changes will be displayed):

┌────────────┬──────────────────────────────┬────────┬──────────────────────┐
│ Resource   │ ResourceType                 │ Action │ Property             │
├────────────┼──────────────────────────────┼────────┼──────────────────────┤
│ fc-mongodb │ Aliyun::Serverless::Service  │ Modify │ Description          │
├────────────┼──────────────────────────────┼────────┼──────────────────────┤
│            │                              │        │ Handler              │
│            │                              │        ├──────────────────────┤
│            │                              │        │ Runtime              │
│ fc-mongodb │ Aliyun::Serverless::Function │ Modify ├──────────────────────┤
│            │                              │        │ CodeUri              │
│            │                              │        ├──────────────────────┤
│            │                              │        │ EnvironmentVariables │
└────────────┴──────────────────────────────┴────────┴──────────────────────┘

? Please confirm to continue. Yes
Waiting for service fc-mongodb to be deployed...
        Waiting for function fc-mongodb to be deployed...
                Waiting for packaging function fc-mongodb code...
                The function fc-mongodb has been packaged. A total of 761 files files were compressed and the final size was 2.81 MB
        function fc-mongodb deploy success
service fc-mongodb deploy success

最使用 fun invoke 命令验证调用结果。

小结

本文主要介绍如何结合 fun install 和 fun local invoke 进行附带 extension 的 PHP 项目开发和调试。Funfile 文件可以描述 extension 的安装命令,如果您有 Dockerfile 的使用经验,那你会发现两者使用体验非常类似。虽然这里只举了一个 mongodb 的示例,但是这个示例是比较完整的,对于其他类似需要安装 PHP extension 的场景也同样适用。

参考阅读

  1. Funcraft
  2. fc-db 开源项目
  3. Funfile 功能介绍
  4. 函数计算- PHP 运行环境- 自定义扩展

加入我们

团队介绍

阿里云函数服务是一个全新的,支持事件驱动编程模式的计算服务。 他帮助用户聚焦自身业务逻辑,以 Serverless的方式构建应用,快速的实现低成本,可扩展,高可用的系统,而无需考虑服务器等底层基础设施的管理。 用户能够快速的创建原型,同样的架构能随业务规模平滑伸缩。让计算变得更高效,更经济,更弹性,更可靠。无论小型创业公司,还是大型企业,都受益其中。我们的团队正在迅速扩张,求贤若渴。我们想寻找这样的队友:
基本功扎实。既能阅读论文追踪业界趋势,又能快速编码解决实际问题。
严谨的,系统化的思维能力。既能整体考虑业务机会,系统架构,运维成本等诸多因素,又能掌控设计/开发/测试/发布的完整流程,预判并控制风险。
好奇心和使命感驱动。乐于探索未知领域,不仅是梦想家,也是践行者。
坚韧、乐观、自信。能在压力和困难中看到机会,让工作充满乐趣!
如果您对云计算充满热情,想要构建一个有影响力计算平台和生态体系,请加入我们,和我们一起实现梦想!

职位描述

构建新一代 Serverless 计算平台,包括:

  1. 设计和实现完整可扩展的前端系统,包括身份验证/权限管理,元数据管理,流量控制,计量计费,日志监控等等
  2. 设计和实现弹性可靠的后端系统,包括资源调度,负载均衡,容错处理等等
  3. 丰富易用的 SDK/Tools/CLI/控制台
  4. 用户需求驱动,追踪业界趋势,利用技术推动业务的成长

职位要求

  1. 算法/数据结构/操作系统等基础知识扎实,优秀的逻辑思维能力。
  2. 至少掌握一门编程语言。例如 Java/Go/C/C#/C++。
  3. 有大规模、高可用分布式系统开发经验者优先。
  4. 有 Web/Mobile Backends/Microservice 开发经验者优先。
  5. 良好的沟通能力和团队合作精神,有一定的组织协调能力。
  6. 本科及以上学历
  7. 3 年以上工作经验,通过“阿里巴巴编码规范” 认证的同学优先录取,认证地址:https://edu.aliyun.com/certif...

简历提交

yixian.dw AT alibaba-inc.com

阿里巴巴云原生技术圈关注微服务、Serverless、容器、Service Mesh 等技术领域、聚焦云原生流行技术趋势、云原生大规模的落地实践,做最懂云原生开发者的技术圈。”
阅读 108发布于 2月26日

推荐阅读
阿里巴巴云原生
用户专栏

关注云原生技术趋势,输出最优质云原生内容

22 人关注
258 篇文章
专栏主页
目录