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

来源:https://www.cnblogs.com/x3d/archive/2022/12/25/php-composer-srcipts-repos-custom-for-dingtalk-php-sdk.html
-Advertisement-
Play Games

難得釘釘官方提供了完整的 api sdk,各種語言的版本的都有,而且 api 覆蓋面非常完整。但是,composer 安裝下來有大幾十兆,這個不符合個人的品味,我想要按需載入。 於是在構思了一兩次以後,今天下午開始動手實現。 首要原則,不做手工勞動,人工分包,然後提交到 packagist 倉庫,那 ...


難得釘釘官方提供了完整的 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"]
  },

再試,就可以了。

本文來源:http://www.cnblogs.com/x3d/,轉載請註明。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 近年來,有關數據泄露相關的新聞事件屢見不鮮,不斷地引發大眾的討論和擔憂。各家企業都或多或少在承受相關的數據安全風險,這種可能性會給企業運行帶來額外的風險,包括大眾的質疑以及政府的處罰等。 Facebook超5億用戶個人數據遭到泄露; Elector Software投票應用泄露超650萬以色... ...
  • 案例介紹 歡迎來到我的小院,我是霍大俠,恭喜你今天又要進步一點點了!我們來用JavaScript編程實戰案例,製作提高打字速度的小游戲-調皮的字母。點擊與屏幕上字母相對應的按鍵,若按鍵與出現的字母一致,則可以獲得相應的分數。 案例演示 根據屏幕上隨機出現的字母來點擊鍵盤上對應的按鍵,可自行調節字母下 ...
  • 案例介紹 歡迎來的我的小院,我是霍大俠,恭喜你今天又要進步一點點了!我們來用JavaScript編程實戰案例,做一個乘法積分游戲。乘法游戲主要通過用戶輸入的數值和程式計算的數值進行對比,正確積一分,錯誤扣一分。通過實戰我們將學會JSON.parse方法、JSON.stringify方法、localS ...
  • 歡迎來的我的小院,恭喜你今天又要漲知識了! 案例內容 利用JavaScript實現搜索框的移動展開。 演示 學習 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> <title>小院里的霍大俠</title> </hea ...
  • 轉義字元 一些特殊字元。 | 轉義字元 | 含義 | | : : | : : | | \n | 換行 | | \r | 回車 | | \0 | 結束字元 | | \s | 空格 | | \’ | 單引號 | | \" | 雙引號 | | \\ | 反斜杠 | 字元編碼 ASCII American ...
  • -- @param list_length 生成的數組長度 -- @param max_random_length 隨機數的最大範圍 math.generate = function (list_length, max_random_length) local random = {} local r ...
  • 本文全面介紹了 HTTP 協議相關知識,包括 HTTP 請求報文、響應報文、持久連接、緩存、Cookie 以及 HTTP 版本升級等! ...
  • 實踐環境 win10 Python 3.6.2 odoo_14.0.latest.tar.gz 下載地址: https://download.odoocdn.com/download/14/src?payload=MTY3MDg1MTM3Ni4xNC5zcmMud0tZRWZLX2I5UVF0Tm5 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...