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

在基於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的路徑：http://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="http://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": "http://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)
    {

通過選項引數的方式，我們可以設定引數的IOC處理話，從而實現了引數的靈活設定和讀取操作。

在其他業務處理的服務類中，如果涉及到一些需要設定的資訊，我們都可以利用這種模式實現引數內容的設定處理。

系列文章：

《基於SqlSugar的開發框架的循序漸進介紹（1）--框架基礎類的設計和使用》

《基於SqlSugar的開發框架循序漸進介紹（2）-- 基於中間表的查詢處理》

《基於SqlSugar的開發框架循序漸進介紹（3）-- 實現程式碼生成工具Database2Sharp的整合開發》

《基於SqlSugar的開發框架循序漸進介紹（4）-- 在資料存取基礎類別中對GUID主鍵進行自動賦值處理》

《基於SqlSugar的開發框架循序漸進介紹（5）-- 在服務層使用介面注入方式實現IOC控制反轉》

《基於SqlSugar的開發框架循序漸進介紹（6）-- 在基礎類別介面中注入使用者身份資訊介面》

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