怎樣在PHP運(yùn)行時(shí)添加自定義擴(kuò)展？

準(zhǔn)備工作

依賴工具

本項(xiàng)目是在 MacOS 下開發(fā)的，涉及到的工具是平臺無關(guān)的，對于 Linux 和 Windows 桌面系統(tǒng)應(yīng)該也同樣適用。在開始本例之前請確保如下工具已經(jīng)正確的安裝，更新到最新版本，并進(jìn)行正確的配置。

• Docker
• Fun

Fun 和 Fcli 工具依賴于 docker 來模擬本地環(huán)境。
對于 MacOS 用戶可以使用 homebrew 進(jìn)行安裝：

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

安裝好后，記得先執(zhí)行 fun config 初始化一下配置。

注意, 如果你已經(jīng)安裝過了 fun，確保 fun 的版本在 3.6.1 以上。

$ fun --version
3.6.1

PHP 自定義擴(kuò)展

在函數(shù)代碼目錄創(chuàng)建一個(gè)名為 extension 的目錄，并且將擴(kuò)展對應(yīng)的 .ini 和 .so 文件放在 extension 目錄下。例如，以下為一個(gè) hello 的自定義擴(kuò)展，假設(shè)該擴(kuò)展里有一份 hello_world 函數(shù)：

.
|____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";
  }

上述方法是函數(shù)計(jì)算PHP 運(yùn)行時(shí)提供的擴(kuò)展方法。實(shí)踐過程中會碰到如下兩個(gè)問題：

1. .so 文件應(yīng)該如何構(gòu)建出來，或者去哪里下載
2. 有了 .so 文件后，本地如何調(diào)試代碼

完整示例

下面會基于借用 [PHP 訪問 MongoDB 的例子]()來介紹如何借助于 Funcraft 進(jìn)行 PHP 開發(fā)，因?yàn)?composer 依賴 mongodb/mongodb 需要安裝 extension。

初始化項(xiàng)目

# 創(chuàng)建工程目錄并進(jìn)入
$ mkdir fc-mongodb && cd fc-mongodb

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

通過 Funfile 安裝

我們在 Linux 平臺下通常會通過 pecl 工具進(jìn)行 PHP 的擴(kuò)展安裝。比如 pecl install mongodb。該命令會觸發(fā)源代碼下載、編譯并拷貝到系統(tǒng) PHP 目錄。pecl 需要執(zhí)行在 Linux 環(huán)境中才能裝linux 版本的 .so 文件。在函數(shù)計(jì)算這里可以通過 fun install 機(jī)制進(jìn)行安裝。

新建一個(gè) Funfile 文件，內(nèi)容如下：

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. 第一行先聲明是一個(gè) php7.2 版本的 Runtime，
2. 接著安裝 構(gòu)建 mongodb 所需要的依賴，這里主要是為了裝 openssl，為了能讓 mongodb 擴(kuò)展庫支持 ssl，以解決連接時(shí)的一個(gè)報(bào)錯。所有
3. 通過 pecl 下載、構(gòu)建并且安裝 mongodb 擴(kuò)展
4. 將 mongodb 擴(kuò)展拷貝到 /code/extendsion 目錄，該目錄是函數(shù)計(jì)算約定的 extension 目錄
5. 生成 mongodb.int 文件，這里文件名是隨意的，只需要 .ini 結(jié)尾就好了。

然后執(zhí)行

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

Install Success

安裝以后會多處一個(gè) extension 目錄，包含 mongodb.so 和 mongodb.ini 文件

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

安裝 mongodb 依賴

執(zhí)行下面命令通過 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

本地調(diào)試

更新 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 啟動一個(gè)臨時(shí)的 mongodb 數(shù)據(jù)庫

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_DATABASE 和 MONGO_URL 環(huán)境變量。

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 本地模擬運(yùn)行

$ 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

如果希望本地?cái)帱c(diǎn)調(diào)試可以使用 Aliyun Serverless VSCode Extension，如下圖

發(fā)布并調(diào)用

請將 template.yml 配置文件中的 MONGO_DATABASE 和 MONGO_URL 環(huán)境變量更新為您線上系統(tǒng)的相應(yīng)配置，然后發(fā)布

$ 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 命令驗(yàn)證調(diào)用結(jié)果。