了解 Windows PowerShell 模組

  • 發行項

模組 是一組相關的 Windows PowerShell 功能，群組在一起成為方便的單位 (通常會儲存在單一目錄) 中。 藉由將一組相關的腳本檔案、元件和相關資源定義為模組，您可以更輕鬆地參考、載入、保存和共用您的程式碼。

模組的主要用途是允許模組化 (ie、重複使用和抽象) Windows PowerShell 程式碼。 例如，建立模組最基本的方法就是只將 Windows PowerShell 腳本儲存為 .psm1 檔。 這樣做可讓您控制 (的 ie，讓公用或私用) 腳本中包含的函式和變數。 將腳本儲存為 .psm1 檔案也可讓您控制特定變數的範圍。 最後，您也可以使用 Cmdlet （如 Install 模組 ）來組織、安裝和使用您的腳本，以作為較大型解決方案的建立區塊。

模組元件和類型

模組由四個基本元件組成：

  1. 程式碼檔案，通常是 PowerShell 腳本或 managed Cmdlet 元件。

  2. 上述程式碼檔案可能需要的任何其他元件，例如其他元件、說明檔或腳本。

  3. 描述上述檔案的資訊清單檔案，以及儲存中繼資料，例如作者和版本設定資訊。

  4. 包含上述所有內容的目錄，而且位於 PowerShell 可合理找到它的位置。

    注意

    這些元件本身都不是必要的。 例如，模組在技術上可以只是儲存在 .psm1 檔案中的腳本。 您也可以擁有不是任何專案的模組，而是資訊清單檔，其主要用於組織用途。 您也可以撰寫可動態建立模組的腳本，因此實際上不需要目錄來儲存任何事物。 下列各節說明您可以藉由混用和比對模組的不同可能元件來取得的模組類型。

指令碼模組

顧名思義，腳本模組 是一個檔案 (.psm1) ，其中包含任何有效的 Windows PowerShell 程式碼。 腳本開發人員和系統管理員可以使用這種類型的模組來建立其成員包含函式、變數等的模組。 簡單來說，腳本模組只是具有不同副檔名的 Windows PowerShell 腳本，可讓系統管理員在其上使用匯入、匯出和管理功能。

此外，您還可以使用資訊清單檔，在模組中包含其他資源，例如資料檔案、其他相依模組或執行時間腳本。 資訊清單檔也適用于追蹤中繼資料，例如撰寫和版本設定資訊。

最後，腳本模組（例如任何其他未動態建立的模組）都必須儲存在 PowerShell 可合理探索的資料夾中。 通常，這是在 PowerShell 模組路徑上;但如有必要，您可以明確描述模組的安裝位置。 如需詳細資訊，請參閱 如何撰寫 PowerShell 腳本模組。

二進位模組

二進位模組 是 .dll 包含已編譯器代碼（例如 c #）的 .NET Framework 元件 () 。 Cmdlet 開發人員可以使用這種類型的模組來共用 Cmdlet、提供者等。 (現有的嵌入式管理單元也可以當做二進位模組使用。 ) 相較于腳本模組，二進位模組可讓您建立更快速或使用功能的 Cmdlet (例如多執行緒) ，並不容易在 Windows PowerShell 腳本中撰寫程式碼。

如同腳本模組，您可以包含資訊清單檔案來描述模組所使用的其他資源，以及追蹤模組的相關中繼資料。 同樣地，您可能應該將二進位模組安裝在 PowerShell 模組路徑的某個資料夾中。 如需詳細資訊，請參閱如何 撰寫 PowerShell 二進位模組。

資訊清單模組

資訊清單模組 是使用資訊清單檔案來描述其所有元件的模組，但沒有任何類型的核心元件或腳本。 (正式運作，資訊清單模組 ModuleToProcess 會將 RootModule 資訊清單的或元素保留空白。 ) 不過，您仍然可以使用模組的其他功能，例如載入相依元件或自動執行某些前置處理腳本的能力。 您也可以使用資訊清單模組，將其他模組將會使用的資源（例如，嵌套模組、元件、類型或格式）封裝成方便的方式。 如需詳細資訊，請參閱 如何撰寫 PowerShell 模組資訊清單。

動態模組

動態模組 是指不會從檔案載入或儲存至檔案的模組。 相反地，腳本會使用 新的模組 Cmdlet，以動態方式建立它們。 這種類型的模組可讓腳本建立隨選模組，而不需要將它載入或儲存至持續性儲存體。 就本質而言，動態模組的存留期很短，因此 Cmdlet 無法存取 Get-Module 。 同樣地，它們通常不需要模組資訊清單，也可能需要永久資料夾來儲存其相關元件。

模組資訊清單

模組資訊清單 是 .psd1 包含雜湊表的檔案。 雜湊表中的索引鍵和值會執行下列動作：

  • 描述模組的內容和屬性。

  • 定義必要條件。

  • 決定元件的處理方式。

    資訊清單對於模組並非必要。 模組可以參考腳本檔 (.ps1) 、腳本模組檔案 (.psm1) 、資訊清單檔 (.psd1) 、格式化和類型檔案 () 、 .ps1xml Cmdlet 和提供者元件 () .dll 、資源檔、說明檔、當地語系化檔案，或任何其他類型的檔案或資源（隨附于模組的一部分）。 針對國際化腳本，模組資料夾也包含一組訊息類別目錄檔案。 如果您將資訊清單檔新增至模組資料夾，您可以參考資訊清單，以單一單位參考多個檔案。

    資訊清單本身會說明下列類別的資訊：

  • 有關模組的中繼資料，例如模組版本號碼、作者和描述。

  • 匯入模組所需的必要條件，例如 Windows PowerShell 版本、common language runtime (CLR) 版本，以及所需的模組。

  • 處理指示詞，例如要處理的腳本、格式和類型。

  • 要匯出的模組成員的限制，例如要匯出的別名、函式、變數和 Cmdlet。

    如需詳細資訊，請參閱 如何撰寫 PowerShell 模組資訊清單。

儲存和安裝模組

一旦您建立了腳本、二進位或資訊清單模組之後，就可以將工作儲存在其他人可以存取的位置。 例如，您的模組可以儲存在安裝 Windows PowerShell 的系統資料夾中，也可以儲存在使用者資料夾中。

一般來說，您可以使用儲存在變數中的其中一個路徑來判斷您應該安裝模組的位置 $ENV:PSModulePath 。 使用其中一個路徑，表示當使用者在其程式碼中進行呼叫時，PowerShell 可以自動尋找並載入您的模組。 如果您將模組儲存在其他位置，您可以明確地讓 PowerShell 知道，方法是在呼叫時，將模組的位置傳遞為參數 Install-Module 。

無論是哪種情況，資料夾的路徑都稱為模組的 基底 (ModuleBase) ，而腳本、二進位檔或資訊清單模組檔案的名稱應該與模組資料夾名稱相同，但有下列例外狀況：

  • 您 New-Module 可以使用 Cmdlet 的參數來命名 Cmdlet 所建立的動態模組 Name 。

  • 命令從元件物件匯入的模組 Import-Module -Assembly 會根據下列語法來命名： "dynamic_code_module_" + assembly.GetName() 。

    如需詳細資訊，請參閱 安裝 PowerShell 模組 和 about_PSModulePath。

模組 Cmdlet 和變數

下列 Cmdlet 和變數是由 Windows PowerShell 提供來建立和管理模組。

New-Module Cmdlet：此 Cmdlet 會建立只存在於記憶體中的新動態模組。 系統會從腳本區塊建立模組，而且其匯出的成員（例如其函式和變數）可立即在會話中使用，而且在會話關閉之前仍可使用。

ModuleManifest Cmdlet：此 Cmdlet 會建立新的模組資訊清單 (. .psd1) 檔案、填入其值，並將資訊清單檔案儲存至指定的路徑。 此 Cmdlet 也可用來建立可手動填入的模組資訊清單範本。

Import-module Cmdlet： 此 Cmdlet 會將一或多個模組新增到目前的會話。

Module Cmdlet：此 Cmdlet 會取得已或可匯入目前會話之模組的相關資訊。

Export-modulemember Cmdlet：此 Cmdlet 會指定模組成員 (例如 Cmdlet、函式、變數和別名) 從腳本模組匯出 (. .psm1) 檔，或從使用 Cmdlet 建立的動態模組。 New-Module

Remove-Module Cmdlet 此 Cmdlet 會從目前的會話移除模組。

ModuleManifest Cmdlet：此 Cmdlet 會驗證模組資訊清單是否已正確地描述模組的元件，方法是確認模組指令 ( 清單檔中所列的檔案確實存在於指定的路徑中。 .psd1) 。

$PSScriptRoot 此變數包含執行腳本模組的目錄。 它可讓腳本使用模組路徑來存取其他資源。

$env:P smodulepath 此環境變數包含儲存 Windows PowerShell 模組的目錄清單。 當自動匯入模組並更新模組的說明主題時，Windows PowerShell 會使用這個變數的值。

另請參閱

撰寫 Windows PowerShell 模組