XML 序列化程式產生器工具 (Sgen.exe)

  • 發行項

XML 序列化程式產生器會為指定組件中的類型建立 XML 序列化組件。 當序列化或還原序列化指定型別的物件時，序列化組件可改善 XmlSerializer 的啟動效能。

注意

此工具專屬於 .NET Framework 組件。 若要產生 .NET (Core) 組件的 XML 串序列化程式，請參閱 在 .NET Core 上使用 Microsoft XML 序列化程式產生器。

語法

從命令列執行工具。

sgen [options]

提示

若要讓 .NET Framework 工具正常運作，您必須使用 Visual Studio 開發人員命令提示字元或 Visual Studio Developer PowerShell，或正確設定 Path、Include 和 Lib 環境變數。 執行位於 <SDK>\<version>\Bin 目錄中的 SDKVars.bat，即可設定這些環境變數。

參數

選項 描述
/a[ssembly]:filename 為組件中包含的所有類型或 filename 所指定的可執行檔產生序列化程式碼。 只能提供一個檔名。 如果重複使用這個引數，則會使用最後一個檔名。
/c[ompiler]:options 指定要傳遞至 C# 編譯器的選項。 所有 csc.exe 選項都受到支援，可以傳遞至編譯器。 這個選項可以用來指定組件必須經過簽署，並指定金鑰檔。
/d[ebug] 產生可以與偵錯工具搭配使用的影像。
/f[orce] 強制覆寫現有的同名組件。 預設值為 false。
/help 或 /? 顯示工具的命令語法和選項。
/k[eep] 將產生的原始程式檔 (Source File) 和其他暫存檔案編譯成序列化組件之後，隱藏刪除這些檔案的動作。 這個選項可以用來判斷工具是否正在為特定的型別產生序列化程式碼。
/n[ologo] 隱藏顯示 Microsoft 程式啟始資訊。
/o[ut]:path 指定要在其中儲存所產生之組件的目錄。 注意：產生的組件名稱是由輸入組件的名稱加上 "xmlSerializers.dll" 所組成。
/p[roxytypes] 只為 XML Web 服務 Proxy 型別產生序列化程式碼。
/r[eference]:assemblyfiles 指定要求 XML 序列化的型別所參考的組件。 這個選項接受以逗號分隔多個組件檔案。
/s[ilent] 隱藏顯示成功訊息。
/t[ype]:type 只為指定的型別產生序列化程式碼。
/v[erbose] 顯示詳細資訊輸出以供偵錯。 此選項會列出無法使用 XmlSerializer 進行序列化之目標組件中的型別。
/? 顯示工具的命令語法和選項。

備註

如果未使用 XML 序列化程式產生器，則每當應用程式執行時，XmlSerializer 便會為每個型別產生序列化程式碼和序列化組件。 若要改善 XML 序列化啟動的效能，請先使用 Sgen.exe 工具產生這些組件。 然後，這些組件便可以與應用程式一起部署。

XML 序列化程式產生器也可以改善用戶端使用 XML Web Service Proxy 與伺服器進行通訊的效能，因為在第一次載入型別時，序列化處理序並不會影響到效能。

這些產生的組件無法在 Web 服務的伺服器端上使用。 這個工具只能在 Web 服務用戶端和手動序列化案例中使用。

注意

sgen 工具與僅供初始化的 setter 不相容。 如果目標群組件包含任何使用此功能的公用屬性，此工具將會失敗。

命名

如果含有要序列化之型別的組件名稱為 MyType.dll，關聯的序列化組件名稱就會是 MyType.XmlSerializers.dll。

範例

下列命令會建立名為 Data.XmlSerializers.dll 的組件，用以序列化 Data.dll 組件中所包含的所有型別。

sgen Data.dll

Data.XmlSerializers.dll 組件可以從程式碼參考，而該程式碼必須序列化及還原序列化 Data.dll 中的型別。

另請參閱