PHP Composer 虛擬依賴包 - 實現按需載入釘釘對應功能模塊的 php sdk

難得釘釘官方提供了完整的 api sdk,各種語言的版本的都有,而且 api 覆蓋面非常完整。但是,composer 安裝下來有大幾十兆,這個不符合個人的品味,我想要按需加載。

於是在構思了一兩次以後,今天下午開始動手實現。

首要原則,不做手工勞動,人工分包,然後提交到 packagist 倉庫,那樣後續會有巨大的維護工作量。

基本思路:

  • 按固定規則在 package.json 中指定所需依賴的釘釘 sdk 的功能模塊名稱和版本名稱,當然,它們在 packagist 倉庫中肯定是不存在的;
  • 然後利用 composer 包管理工具的 hook 機制,在恰當的時機比如 install 或 update 實現攔截,匹配這種命名規則的包名,動態虛構相應的自定義“倉庫”完成下載動作。

實現以後,可以用來解決很多類似場景的問題。

比如,虛構的依賴包名是這樣的:

  "require-dev": {
    "x3d/dingtalk-contact": "1.0"
  },

x3d/dingtalk- 是前綴標識;contact 是釘釘的 api sdk 模塊名;1.0 是這個模塊的版本號。

這裏涉及幾個知識點:

1、釘釘sdk中的模塊命名規則;
2、composer 的 hook 機制;
3、找到能從 github git 倉庫中按目錄檢出代碼的方式
4、虛構 composer 能支持的“倉庫”類型

釘釘的 sdk 在 https://github.com/alibabacloud-sdk-php/dingtalk/tree/master/src 這個目錄下,按功能模塊+相應接口的版本號拼接的目錄,目標是每次只按需下載某個模塊的代碼,並能在項目本地 被 composer 正常管理。

composer 的 hook 機制,在 官網 找到了簡單的說明,但是具體是什麼效果不清楚,整個下午花時間最多的就是在一個個的 hook 試,找感覺,看哪些能滿足此次的需求。同時,要通過代碼熟悉相應的知識點,文檔是指望不上的。

最後確定了兩種事件是可以的,pre-install-cmd、pre-update-cmd,其它細節可能要跟進使用情況進一步挖掘。

實現的代碼比較簡單,分兩步,先分析出來 require 的虛構包列表,然後爲他們添加虛構的代碼倉庫。

$devReqs = $this->composer->getPackage()->getDevRequires();
        foreach ($devReqs as $pkgName => $devReq) {
            if (substr($pkgName, 0, strlen($this->id)) != $this->id) {
                continue;
            }
            $dtk_mods[$pkgName] = $devReq->getPrettyConstraint();
        }
       $packages = [];
        foreach ($dtk_mods as $module => $version) {
            $packages[] = $this->configByModule($module, $version);
        }

        $sdkMirror = [
            "type" => "package",
            "package" => $packages,
        ];

        $repoName = $this->repoName;
        $this->composer->getConfig()->merge([
            'repositories' => [
                $repoName => $sdkMirror,
            ],
        ]);

        $repoMgr = $this->composer->getRepositoryManager();
        $mirrorRepo = $repoMgr->createRepository('package', $sdkMirror, $repoName);
        $repoMgr->addRepository($mirrorRepo);
    

    /**
     * @param  string  $module 格式 x3d/dingtalk-service_group
     * @param  string  $version 格式 1.0
     * @return array
     */
    protected function configByModule(string $module, string $version)
    {
        // 下載對應的 dingtalk 結構代碼,放到對應結構;
        $mod = substr($module, strlen($this->id) + 1);
        $dir = "{$mod}_" . str_replace('.', '_', $version);
        $package = [
            "name"=> $module,
            "version" => $version,
            "source" => [
                "url" => $this->mirrorUrl,
                "type" => "svn",
                "reference" => "trunk/src/$dir/"
            ],
            // "target-dir" => "src/",
            "autoload" => [
                "psr-4" => [
                    $this->nsPrefix . ucfirst($dir) . '\\' => "src/"
                ]
            ]
        ];

        return $package;
    }

由於國內 Gitee 的努力,很早就支持 svn 協議的兼容方案,而我們這種古早程序員從 cvs 和 svn 時代過來的,自然就聯想到 轉成 svn 就可以滿足需求;因此,在Gitee 上建立一個 鏡像倉庫就,啓用 svn 即可。

出現以下下面提示。其中第一個認證領域是用戶的密碼,這個可以留空。而用戶名是用戶在 Gitee 登陸時使用郵箱地址。密碼則是用戶登陸 Gitee 所使用的密碼。

一般而言,svn 會加密緩存用戶的用戶名密碼,所以,對倉庫的操作只需要第一次輸入用戶郵箱和密碼。

然後是看 composer 如何支持這種非標準的沒有 package.json composer 協議配置文件的倉庫,所幸,確實是支持的。

它支持一種 type 爲 package 的倉庫形式,裏面指定協議爲 svn 就可以進一步指定代碼目錄,這正是我們需要的。

{
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "smarty/smarty",
                "version": "3.1.7",
                "dist": {
                    "url": "https://www.smarty.net/files/Smarty-3.1.7.zip",
                    "type": "zip"
                },
                "source": {
                    "url": "http://smarty-php.googlecode.com/svn/",
                    "type": "svn",
                    "reference": "tags/Smarty_3_1_7/distribution/"
                },
                "autoload": {
                    "classmap": ["libs/"]
                }
            }
        }
    ],
    "require": {
        "smarty/smarty": "3.1.*"
    }
}

最後,在實操觸發 svn 檢出時,發現 svn 會報錯,

could not be downloaded, Your configuration does not allow connections to svn://gitee.com/web3d/dingtalk-sdk-php/trunk/src/contact_1_0/. 

See (https://getcomposer.org/doc/06-config.md#secure-svn-domains) for details. 

乖乖的去這個頁面上去找,果然有答案。

Defaults to [].

Lists domains which should be trusted/marked as using a secure Subversion/SVN transport.

By default svn:// protocol is seen as insecure and will throw, but you can set this config option to ["example.org"] to allow using svn URLs on that hostname.

This is a better/safer alternative to disabling secure-http altogether.

在 package.json 中加一條規則:


  "config": {
    "secure-svn-domains": ["gitee.com"]
  },

再試,就可以了。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章