自動升級系統的設計與實現（原始碼）

阿新 • • 發佈：2019-01-17

　　對於PC桌面應用程式而言，自動升級功能往往是必不可少的。而自動升級可以作為一個獨立的C/S系統來開發，這樣，就可以在不同的桌面應用中進行復用。基於的檔案傳送功能，我實現了一個可直接複用的自動升級系統OAUS，現在將其分享給大家。這篇文章將著重介紹OAUS的相關背景、使用方法，至於詳細的實現細節，大家可以直接下載原始碼研究。如果瞭解了OAUS的使用，原始碼的理解就非常容易了。如果需要直接部署使用自動升級系統，那麼，可下載文末的可執行程式壓縮包。

一.OAUS的主要功能

　　目前主流的程式自動升級策略是，重新下載最新的安裝包，然後重新安裝整個客戶端。這種方式雖然簡單直觀，但是缺陷也很明顯。比如，即使整個客戶端有100M，而本次更新僅僅只是修改了一個1k大小的dll，那也意味著要重新下載100M的全部內容。這對頻寬是極大的浪費，而且延長了升級了時間，相應地也增加了客戶茫然等待的時間。

在上述的場景中，自動升級時，我們能否只更新那個被修改了的1k的dll了？當然，使用OAUS自動升級系統可以輕鬆地做到這一點。OAUS自動升級系統可以對被分發的客戶端程式中的每個檔案進行版本管理，每次升級的基礎單元不再是整個客戶端程式，而是其中的單個檔案。針對單個檔案的更新，包括三種形式：

（1）檔案被修改。

（2）檔案被刪除。

（3）新增加某個檔案。

OAUS對這三種形式的檔案更新都是支援的。每次自動升級，都可以更改N個檔案、刪除M個檔案、新增加L個檔案。

二.OAUS的使用

1.OAUS的結構

OAUS提供了可直接執行的服務端程式和客戶端程式：AutoUpdaterSystem.Server.exe 和 AutoUpdater.exe。 OAUS服務端的目錄結構如下所示：

OAUS的客戶端與伺服器之間通過TCP通訊，可以在AutoUpdaterSystem.Server.exe.config配置檔案中配置伺服器通過哪個TCP埠提供自動升級服務。

FileFolder資料夾初始是空的，其用於部署被分發的程式的各個檔案的最新版本。注意，其下的檔案結構一定要與被分發的程式正常部署後的結構完全一致 -- 即相當於在FileFolder資料夾下部署一個被分發的程式。

OAUS客戶端的目錄結構如下：

可以在AutoUpdater.exe.config配置檔案中配置OAUS伺服器的IP、埠等資訊，其內容如下所示：

<configuration>
  <appSettings>
    <!--伺服器IP -->
    <add key="ServerIP" value="127.0.0.1"/>
    <!--伺服器埠-->
    <add key="ServerPort" value="4530"/>
    <!--升級完成後，將被回撥的可執行程式的名稱-->
    <add key="CallbackExeName" value="Demo.exe"/>
    <!--主窗體的Title-->
    <add key="Title" value="檔案更新"/>
  </appSettings>
</configuration>

請注意配置的CallbackExeName，其表示當升級完成之後，將被啟動的分發程式的exe的名稱。這個CallbackExeName配置的為什麼是名稱而不是路徑了？這是因為使用和部署OAUS客戶端時是有要求的：

（1）被分發的程式的可執行檔案exe必須位於部署目錄的根目錄。

（2）OAUS的客戶端（即整個AutoUpdater資料夾)也必須位於這個根目錄。

如此，AutoUpdater就知道分發程式的exe相對自己的路徑，如此就可以確定分發程式的exe的絕對路徑，所以就可以在升級完成後啟動目標exe了。另外，根據上述的兩個約定，再結合前面講到的服務端的FileFolder資料夾的結構約定，當服務端更新一個檔案時，AutoUpdater便可以確定該檔案在客戶端機器上的絕對路徑了。

2.OAUS自動升級流程

下面我們就詳細講講如何使用OAUS來構建自動升級系統，大概的步驟如下。

（1）執行OAUS服務端。

服務端主介面將顯示所有正在自動升級的OAUS客戶端資訊。

（2）將被分發的客戶端程式的所有內容放到OAUS服務端的FileFolder資料夾下，其結構與客戶端程式正常部署後的結構要完全一致。我們以部署VideoChatSystem為例。

（3）使用OAUS服務端為被分發的客戶端程式的每個檔案生成預設版本號，並建立版本資訊配置檔案UpdateConfiguration.xml。這個配置檔案也將被客戶端使用。

點選服務端【工具】選單欄下的【版本管理】子選單，將彈出用於管理各個檔案版本的【檔案版本資訊】窗體。

雙擊列表中的任意一行，可以修改其對應檔案的版本的值（float型別的數值）。注意，此列表中的版本資訊與檔案的真實版本屬性（比如dll的版本屬性X.X.X.X）可以是沒有任何聯絡的，列表中版本的值只是用於標記檔案是否被修改，所以，檔案每被修改一次，其列表中對應的版本的值就應該有所增大。

當關閉【檔案版本資訊】窗體時，只要有某個檔案版本變化，則“最後綜合版本”的值（int型別）會遞增1。通過比較OAUS的客戶端儲存的“最後綜合版本”的值與OAUS的服務端最新的“最後綜合版本”的值，就可以快速地識別客戶端是否已經是最新版本了。

另外，初次開啟這個視窗時，將在OAUS服務端的目錄下，自動生成一個版本資訊配置檔案UpdateConfiguration.xml。而且，每當通過該窗體來設定某個檔案的新版本時，UpdateConfiguration.xml會自動同步更新。

（4）將UpdateConfiguration.xml新增到OAUS的客戶端程式（即上述的AutoUpdater的資料夾）中。

（5）在建立被分發的客戶端的安裝程式時，將OAUS的客戶端（即AutoUpdater的資料夾）也打包進去，並且像前面說的一樣，要將其直接部署在執行目錄（BaseDirectory）下（與分發的exe同一目錄）。

如此，準備工作就完成了，當客戶端通過安裝包安裝好了VideoChatSystem之後，其目錄結構像下面這樣：

（6）當我們有新的版本要釋出時，比如要更新某個檔案（因為檔案被修改），那麼可以這樣做：

　　a.將修改後的檔案拷貝到OAUS服務端的FileFolder資料夾下的正確位置（或覆蓋舊的檔案）。

　　b.在OAUS服務端開啟【檔案版本資訊】窗體，雙擊被修改檔案所對應的Row，在彈出的窗體上修改對應檔案的版本號，將版本號的數值增加。（如果是刪除舊檔案或新增新檔案，此處也可進行相應的操作）

（7）如此，當客戶端再啟動AutoUpdater.exe時，就會自動升級，更新那些發生變化的檔案。以下是AutoUpdater.exe執行起來後的截圖。

（8）當升級完成後，將啟動前述的OAUS客戶端配置檔案中配置的回撥exe。（在本例中就是VideoChatSystem.exe）

（9）OAUS客戶端會在日誌檔案UpdateLog.txt（位於AutoUpdater的資料夾下，在OAUS客戶端首次執行時自動生成該檔案）中，記錄每次自動升級的情況。

3.何時啟動自動升級客戶端？

假設某個系統是下載客戶端形式的，那麼客戶端該如何知道是否有新版本了？然後又該何時啟動AutoUpdater.exe了？

我們的經驗是這樣的：客戶端登入成功之後，從伺服器獲取“最後綜合版本”的值，然後與本地的“最後綜合版本”的值相比較，如果本地的值較小，則表示客戶端需要更新。這個過程可以這樣做到：

（1）當在OAUS服務端的FileFolder資料夾下放置了新的檔案，並通過【檔案版本資訊】窗體正確的更新了版本號，在關閉【檔案版本資訊】窗體時，“最後綜合版本”的值會自動加1。

（2）系統客戶端可以通過呼叫AutoUpdater.VersionHelper類的靜態方法HasNewVersion()來判斷是否有新版本。

（3）如果HasNewVersion方法返回true，則通常有兩種模式：由使用者選擇是否升級，或者是強制升級。

一般而言，如果最新客戶端程式與老版本相容，不升級也影響不大，則可以交由使用者決定是否升級；如果最新客戶端程式不相容老版本，或者是有重大更新，則將啟動強制升級。如果流程要進入啟動升級，那麼只要啟動AutoUpdater的資料夾下AutoUpdater.exe就可以了。要注意的是，啟動AutoUpdater.exe程序後，要退出當前的客戶端程序，否則，有些檔案會因為無法被覆蓋而導致更新失敗。程式碼大致如下所示：

if (VersionHelper.HasNewVersion(oausServerIP,oausServerPort)) 
  {      
       string updateExePath = AppDomain.CurrentDomain.BaseDirectory + "AutoUpdater\\AutoUpdater.exe";   
       System.Diagnostics.Process myProcess = System.Diagnostics.Process.Start(updateExePath);     
       ......//退出當前程序  
  }

三.相關下載

　　如果有任何建議或問題，請留言給我。

自動升級系統的設計與實現（原始碼）

一.OAUS的主要功能