程式集引用不匹配問題探究

波多爾斯基發表於2020-12-20

進行外掛式程式設計的時候,經常性地彈出這麼個東西找到的程式集清單定義與程式集引用不匹配。 (異常來自 HRESULT:0x80131040),往往這種問題特別難以解決,搞定了一個還要出另外一個。得研究一下怎麼處理。

引用不匹配

這裡提示需要載入一個4.2.0.0版本的dll,我先看看資料夾下面有沒有對應的dll,檢視檔案dll的詳細資訊。

這個版本號4.6.27818.1和4.2.0.0也差的有點太遠了吧,是這個問題?其實不是的,這個地方顯示的版本和程式集的版本不是一回事。

程式集版本

.NET程式有很多版本的說法,官方對這個有解釋,通過檔案管理器獲得的版本是AssemblyFileVersion,而程式集載入器定位的版本使用的是AssemblyVersion,這兩個東西完全不是一回事。通過右鍵,我們看不到AssemblyVersion,比較簡單的方式,可以通過Powershell指令碼來檢視程式集版本。

ls *.dll -r |
    ForEach-Object {
        try {
            $_ | Add-Member NoteProperty FileVersion ($_.VersionInfo.FileVersion)
            $_ | Add-Member NoteProperty AssemblyVersion (
                [Reflection.AssemblyName]::GetAssemblyName($_.FullName).Version
            )
        } catch {}
        $_
    } |
    Select-Object Name,FileVersion,AssemblyVersion

可以看到,我這邊的程式集是4.2.0.1版本的,不是4.2.0.0版本的,因此,程式集不能正常載入。

我自己的專案是使用nuget進行包管理的,引用的包的版本號是4.5.3(又多一個版本...),程式集版本是4.2.0.1。我找遍了整個專案,都沒有找到我dll專案中關於4.2.0.0版本的引用,苦思良久,打盹的時候忽然想起來,是不是那個exe的問題?

繫結重定向

我的主exe程式是使用.NET Framework 4.6.1進行編譯,然後單獨編譯dll作為外掛放入一個資料夾,由exe程式進行載入。那有可能是exe引用了4.2.0.0這個版本,或者是其他dll外掛引用了這個版本,造成版本不相容。

這種情況可以有很多種解決方案,這篇文章寫的非常詳細,推薦讀一讀。而我這裡使用了最簡單也是作者比較推薦的辦法,程式集引用的繫結重定向。

使用這個方法有一個前提,你需要完全瞭解其他程式引用這個程式版本的時候不會出問題,一般小版本號的變動,是相對比較安全的。

一直以來,我寫.NET Framework程式貌似就很少有這種問題,是因為微軟會自動給程式設定重定向,我們可以通過在專案上右鍵,點選自動生成繫結重定向。

之後,會出現一個app.config檔案,它會在生成程式的時候,變成程式名稱.dll.config的形式,裡面大概是這個樣子的:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <runtime>
    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <dependentAssembly>
        <assemblyIdentity name="System.Threading.Tasks.Extensions" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
        <bindingRedirect oldVersion="0.0.0.0-4.2.0.1" newVersion="4.2.0.1" />
      </dependentAssembly>
    </assemblyBinding>
  </runtime>
</configuration>

可以發現,這個東西對我們引用的版本內容進行了限制,強制某個範圍內的版本重定向為一個固定的版本號。不過,雖然dll中已經有這個內容,但是exe不會理會它的,它只會看自己主程式的.exe.config檔案。所以我們需要做的,就是把這一個部分內容搬到主程式的.exe.config中。

修改後重新執行,然後有又提示找不到System.Buffers.dll了,如法炮製,問題解決。

Fusion Log

有時候,通過這個方法找下去,處理完了,也不一定能夠解決,因為這個錯誤提示的是“未能載入檔案或程式集或它的某一個依賴項。”,也可能是某個引用的依賴項出了問題,這樣就不是很好找了。

好在.NET提供了一個程式集繫結日誌的工具,可以幫助我們檢視繫結的問題。一般情況下,這個東西是關閉的,系統會提示:

警告: 程式集繫結日誌記錄被關閉。
要啟用程式集繫結失敗日誌記錄,請將登錄檔值 [HKLM\Software\Microsoft\Fusion!EnableLog] (DWORD)設定為 1。
注意: 會有一些與程式集繫結失敗日誌記錄關聯的效能損失。
要關閉此功能,請移除登錄檔值 [HKLM\Software\Microsoft\Fusion!EnableLog]。

除錯的話,可以開啟這個登錄檔鍵值。或者簡單點,直接使用Fuslogvw.exe(程式集繫結日誌檢視器),用管理員賬號啟動,在設定中設定好記錄的日誌資訊,然後就可以記錄了,詳細的使用方法,見這裡。就能看到詳細的資訊了,可以幫助我們深入分析內部繫結的問題。(用完記得關,有效能損失。)

=== 預繫結狀態資訊 ===
日誌: DisplayName = System.Threading.Tasks.Extensions, Version=4.2.0.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
 (Fully-specified)
日誌: Appbase = file:///C:/Temp/360zip$Temp/360$0/
日誌: 初始 PrivatePath = NULL
呼叫程式集: DependencyWalker, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null。
===
日誌: 此繫結從 default 載入上下文開始。
日誌: 未找到應用程式配置檔案。
日誌: 使用主機配置檔案: 
日誌: 使用 C:\Windows\Microsoft.NET\Framework\v4.0.30319\config\machine.config 的計算機配置檔案。
日誌: 策略後引用: System.Threading.Tasks.Extensions, Version=4.2.0.1, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51
日誌: 相同的繫結已出現過,因 hr = 0x80070002 而失敗。

Dependency Walker

說到dll的引用,就有必要提一提非常有名的一個工具Dependency Walker,它可以檢視PE檔案的引用情況,但是這個程式很久沒有更新了,對.NET很不友好。我找了一下,發現幾個替代:

  1. Dependencies

這個工具可以認為是Dependency Walker的升級版,可以檢視PE檔案的引用資訊,對.NET也可以支援,不過看的資訊太少了,也無法顯示缺失的情況。

  1. DependencyWalker.Net

這個工具是專門為.NET設計的,可以檢視程式集的引用情況,我刪除了我外掛的幾個dll,然後看就是這個樣子,一目瞭然,版本號也非常清楚。

通過這些工具,可以幫我們找一找到底是dll的問題,也許會對“試圖載入格式不正確的程式。”、“引用不匹配。”等引用相關問題有所幫助。

這些工具處理的大多是靜態引用,對於使用動態引用的,一般是不支援的。

總結

外掛式程式設計極大增強了程式的擴充能力,不過,在處理程式集引用的時候,需要非常小心不同外掛帶來的引用問題。程式設計的時候,可以使用不同資料夾隔離不同的外掛dll,並通過一些技巧來載入(可以檢視之前的文章)和隔離,這樣,就可以避免出現不匹配的錯誤了。

參考資料

相關文章