基於SqlSugar的開發框架循序漸進介紹（7）- 在文件上傳模組中採用選項模式【Options】處理常規上傳和FTP文件上傳

基於SqlSugar的開發框架循序漸進介紹（7）– 在文件上傳模組中採用選項模式【Options】處理常規上傳和FTP文件上傳

2022 年 6 月 13 日
筆記
SqlSugar

在基於SqlSugar的開發框架的服務層中處理文件上傳的時候，我們一般有兩種處理方式，一種是常規的把文件存儲在本地文件系統中，一種是通過FTP方式存儲到指定的FTP伺服器上。這種處理應該由程式進行配置，決定使用那種方式，那麼這裡面我們為了彈性化處理，在文件上傳模組中採用選項模式【Options】處理常規上傳和FTP文件上傳的配置參數資訊。

微軟引入選項模式,它是用於配置框架服務使用的設置. 選項模式由Microsoft.Extensions.OptionsNuGet包實現,除了ASP.NET Core應用,它還適用於任何類型的應用程式，如果需要了解，微軟的文檔詳細解釋了選項模式。

選項模式的限制之一是你只能解析(注入) IOptions <MyOptions> 並在依賴注入配置完成(即所有模組的ConfigureServices方法完成)後獲取選項值。如果你正在開發一個模組,可能需要讓開發者能夠設置一些選項,並在依賴注入註冊階段使用這些選項. 你可能需要根據選項值配置其他服務或更改依賴注入的註冊程式碼。IOptions<>是單例，因此一旦生成了，除非通過程式碼的方式更改，它的值是不會更新的。

1、文件上傳處理

在前面我們介紹過，文件上傳處理的邏輯中有兩部分，一個是本地文件處理，一個是FTP文件處理，它們選擇那種方式，依賴於配置參數的資訊，如下示意圖所示。

在本地文件處理過程中，如果是Web API方式調用服務層，那麼就在Web API所在的文件系統中，如果是Winform介面直接調用服務層，那麼就是在當前系統中處理文件，這種方式可以有效的管理我們的文件資訊。

在FTP文件處理過程中，則是根據選項參數的資訊，調用FluentFTP類庫進行文件的上傳操作。

在Winform介面中上傳文件的介面如下所示，它對於採用哪種方式是不知道的，具體由配置參數決定。

而所有的附件資訊我們存儲在資料庫裡面，文件則存放在對應的文件夾裡面，可以統一進行管理查看和管理。

2、選項模式【Options】的處理

首先根據我們的處理方式，我們定義一個對象，用於承載上傳參數的資訊，如下程式碼所示。

    /// <summary>
    /// 文件上傳處理的選項資訊
    /// </summary>
    public class UploadSettingOptions
    {
        /// <summary>
        /// 可指定的存儲物理地址，如C:\\Attachment，如果沒有配置項AttachmentBasePath，則默認一個相對目錄。
        /// </summary>
        public string AttachmentBasePath { get; set; }

        /// <summary>
        /// 指定附件上傳的方式，如ftp為FTP方式，為空則為普通方式
        /// </summary>
        public string AttachmentUploadType { get; set; }

        /// <summary>
        /// FTP服務地址
        /// </summary>
        public string FtpServer { get; set; }

        /// <summary>
        /// FTP用戶名
        /// </summary>
        public string FtpUser { get; set; }

        /// <summary>
        /// FTP密碼
        /// </summary>
        public string FtpPassword { get; set; }

        /// <summary>
        /// FTP的基礎路徑，如可以指定為IIS的路徑：//www.iqidi.com:8000 ,方便下載打開
        /// </summary>
        public string FtpBaseUrl { get; set; }
    }

然後在項目中添加Microsoft.Extensions.Options引用。

我們定義文件上傳服務類的和它的構造函數，以便於選項模式的處理。

    /// <summary>
    /// 上傳附件資訊 應用層服務介面實現
    /// </summary>
    public class FileUploadService : MyCrudService<FileUploadInfo,string, FileUploadPagedDto>, IFileUploadService
    {
        //微軟引入選項模式,它是用於配置框架服務使用的設置. 選項模式由Microsoft.Extensions.Options NuGet包實現
        //在你需要獲得一個選項值時,將 IOptions<TOption> 服務注入到你的類中,使用它的 .Value 屬性得到值.
        private readonly UploadSettingOptions _options;

        /// <summary>
        /// 參數化構造，注入上傳處理設置資訊
        /// </summary>
        /// <param name="options"></param>
        public FileUploadService(IOptions<UploadSettingOptions> options) 
        {
            _options = options.Value;
        }

我們看到這裡提供了一個注入介面的參數資訊，這樣完成參數的注入載入後，我們在該服務類調用的時候，就可以使用它的選項參數資訊了。

例如我們在其中通用的上傳處理方法上如下所示。

        /// <summary>
        /// 上傳文件（根據配置文件選擇合適的上傳方式）
        /// </summary>
        /// <param name="info">文件資訊（包含流數據）</param>
        /// <returns></returns>
        public async Task<CommonResult> Upload(FileUploadInfo info)
        {
            var uploadType = this._options.AttachmentUploadType;

            if (string.IsNullOrEmpty(uploadType))
            {
                return await this.UploadByNormal(info);
            }
            else if (uploadType.Equals("ftp", StringComparison.OrdinalIgnoreCase))
            {
                return await this.UploadByFTP(info);
            }
            else
            {
                throw new ArgumentException("AttachmentUploadType配置指定了無效的值， 請置空或者填寫ftp。");
            }
        }

我們來通過讀取選項參數的資訊，來決定採用哪種上傳文件的方式。

我們在基於.net framewrok的Winform項目App.config中指定下面的配置資訊

  <appSettings>
    <!--保存目錄及FTP配置資訊-->
    <!--可指定的存儲物理地址，如C:\\Attachment，如果沒有配置則默認相對目錄。-->
    <add key="AttachmentBasePath" value="" />
    <!--指定附件默認上傳的方式， 如為FTP方式：ftp，為空則為普通方式-->
    <add key="AttachmentUploadType" value="" />
    <!--非空的時候，讀取下面的FTP資訊-->
    <add key="FtpServer" value="114.215.106.96" />
    <add key="FtpUser" value="web2" />
    <add key="FtpPassword" value="" />
    <!--可以指定為HTTP或者FTP的路徑，供下載查看-->
    <add key="FtpBaseUrl" value="//www.iqidi.com/ftp" />
  </appSettings>

而在項目啟動的時候，我們需要注入選項參數的內容，以達到完成配置文件資訊的讀取。

        /// <summary>
        /// 應用程式的主入口點。
        /// </summary>
        [STAThread]
        static void Main()
        {
            // IServiceCollection負責註冊
            IServiceCollection services = new ServiceCollection();//添加IApiUserSession實現類
            services.AddSingleton<IApiUserSession, ApiUserPrincipal>(); //CurrentPrincipal實現方式

            //構造對應環境下的UploadSettingOptions資訊
            services.Configure<UploadSettingOptions>(option =>
            {
                SetUploadOptions(option);
            });

        /// <summary>
        /// 構造對應環境下的UploadSettingOptions資訊
        /// </summary>
        /// <returns></returns>
        private static UploadSettingOptions SetUploadOptions(UploadSettingOptions option)
        {
            var config = new AppConfig();
            option.AttachmentBasePath = config.AppConfigGet("AttachmentBasePath");
            option.AttachmentUploadType = config.AppConfigGet("AttachmentUploadType");
            option.FtpServer = config.AppConfigGet("FtpServer");
            option.FtpUser = config.AppConfigGet("FtpUser");
            option.FtpPassword = config.AppConfigGet("FtpPassword");
            option.FtpBaseUrl = config.AppConfigGet("FtpBaseUrl");

            return option;
        }

就這樣，在.net framework的WInform項目啟動的時候，我們就完成了文件上傳選項參數的讀取載入，這樣在 FileUploadService 裡面的構造函數，就可以獲得對應的選項參數資訊對象了。

對於.netcore的程式，我們知道它的配置資訊是appSettings.json,如下節點所示。

    "UploadSettingOptions": {
      "AttachmentBasePath": "", //可指定的存儲物理地址，如C:\\Attachment，如果沒有配置則默認相對目錄。
      "AttachmentUploadType": "", //ftp或空，為空則為普通方式
      "FtpServer": "114.215.106.96", //FTP伺服器地址
      "FtpUser": "web2", //FTP帳號
      "FtpPassword": "", //FTP密碼
      "FtpBaseUrl": "//www.iqidi.com/ftp"//可以指定為HTTP或者FTP的路徑，供下載查看
    }

例如對於我們在Web API的初始化選項對象資訊，具體載入的程式碼如下所示。

builder.Services.Configure<UploadSettingOptions>(builder.Configuration.GetSection("UploadSettingOptions"));

相對.net framework的處理來說，使用擴展函數來簡化了不少。

這樣，我們在文件上傳處理的服務類中就可以順利獲得對應的配置資訊了。

    /// <summary>
    /// 上傳附件資訊 應用層服務介面實現
    /// </summary>
    public class FileUploadService : MyCrudService<FileUploadInfo,string, FileUploadPagedDto>, IFileUploadService
    {
        //微軟引入選項模式,它是用於配置框架服務使用的設置. 選項模式由Microsoft.Extensions.Options NuGet包實現
        //在你需要獲得一個選項值時,將 IOptions<TOption> 服務注入到你的類中,使用它的 .Value 屬性得到值.
        private readonly UploadSettingOptions _options;

        /// <summary>
        /// 參數化構造，注入上傳處理設置資訊
        /// </summary>
        /// <param name="options"></param>
        public FileUploadService(IOptions<UploadSettingOptions> options) 
        {
            _options = options.Value;
        }

我們在使用FTP上傳文件的時候，使用了FluentFtp類庫實現FTP文件的上傳處理的，構建FTP對象的處理程式碼如下所示。

//使用FluentFTP操作FTP文件
var client = new FtpClient(this._options.FtpServer, this._options.FtpUser, this._options.FtpPassword);

//如果配置指定了埠，則使用特定埠
if (!string.IsNullOrEmpty(this._options.FtpServer) && this._options.FtpServer.Contains(":"))
{
    string port = this._options.FtpServer.Split(':')[1];
    if (!string.IsNullOrEmpty(port))
    {
        client.Port = port.ToInt32();
    }
}

上傳FTP文件的程式碼如下所示。

    //確定日期時間目錄（格式：yyyy-MM），不存在則創建
    string savePath = string.Format("/{0}-{1:D2}/{2}", DateTime.Now.Year, DateTime.Now.Month, category);
    bool isExistDir = client.DirectoryExists(savePath);
    if (!isExistDir)
    {
        client.CreateDirectory(savePath);
    }

    //使用FTP上傳文件
    //避免文件重複，使用GUID命名
    var ext = FileUtil.GetExtension(info.FileName);
    var newFileName = string.Format("{0}{1}", Guid.NewGuid().ToString(), ext);//FileUtil.GetFileName(file);

    savePath = savePath.UriCombine(newFileName);
    var uploaded = await client.UploadAsync(info.FileData, savePath, FtpRemoteExists.Overwrite, true);

    //成功後，寫入資料庫
    if (uploaded == FtpStatus.Success)
    {