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

来源:https://www.cnblogs.com/wuhuacong/archive/2022/06/13/16370422.html
-Advertisement-
Play Games

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


在基於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文件上傳》

 

專註於代碼生成工具、.Net/.NetCore 框架架構及軟體開發，以及各種Vue.js的前端技術應用。著有Winform開發框架/混合式開發框架、微信開發框架、Bootstrap開發框架、ABP開發框架、SqlSugar開發框架等框架產品。
  轉載請註明出處：撰寫人：伍華聰  http://www.iqidi.com 
    
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 想學設計模式、想搞架構設計，先學學UML系統建模吧您
    UML系統建模 1 概述 1.1 課程概述 彙集UML及其相關的一些話題 回顧UML相關的符號與概念 以電商訂單相關業務為例，藉助UML完成系統建模 將UML變成提升建模效率，表達架構思想的工具 1.2 什麼是UML ​ Unified Modeling Language 統一建模語言，又稱標準建模 ...
  • 【Python】愛不釋手的彈球小游戲
    前言 周末到了，不想給大家太多的壓力，今天就給大家分享一個比較簡單的彈球小游戲吧。這無聊的周末又有事可以做了，nice… 先看一下我們的最終效果圖 我們分9步來講解如何寫這個小游戲 1.創建游戲的主界面 我們用Python的內置模塊Tkinter來完成了，它是Python的標準GUI工具包,可以非常 ...
  • 6000字|22張圖 帶你徹底弄懂Zookeeper分散式鎖
    前面我們剖析了Redisson的源碼，主要分析了Redisson實現Redis分散式鎖的15問，理清了Redisson是如何實現的分散式鎖和一些其它的特性。這篇文章就來接著剖析Zookeeper分散式鎖的實現框架Curator的源碼，看看Curator是如何實現Zookeeper分散式鎖的，以及它提 ...
  • mybatis foreach的用法簡介說明
    認識JavaWeb，衛星定位：zhanjiquan666，衛星定位：zhanjiquan666 ...
  • Java迴圈的三種方式分享
    一、說明 Fate 是一個工業級聯邦學習框架，所謂聯邦學習指的就是可以聯合多方的數據，共同構建一個模型； 與傳統數據使用方式相比，它不需要聚合各方數據搭建 數據倉庫，聯邦學習在聯合計算建模的過程中，多方機構之間的數據是不會進行共用的，實現數據的 可用不可見；本文主要分享隱私計算平臺 Fate 的相關 ...
  • HIPPO-4J 1.3.0 正式發佈：支持 Dubbo、RibbitMQ、RocketMQ 框架線程池
    文章首發在公眾號（龍台的技術筆記），之後同步到個人網站：xiaomage.info Hippo-4J 距離上一個版本 1.2.1 已經過去一個月的時間。在此期間，由 8 位貢獻者 提交了 170+ commits，正式發佈 1.3.0 版本。 註：這是一個 相容歷史版本 的重大升級。 Github： ...
  • Blazor WebAssembly + Grpc Web = 未來？
    Blazor WebAssembly是什麼 首先來說說WebAssembly是什麼，WebAssembly是一個可以使C#,Java,Golang等靜態強類型編程語言，運行在瀏覽器中的標準，瀏覽器廠商基於此標準實現執行引擎。 在實現了WebAssembly標準引擎之後，瀏覽器中可以執行由其他語言編譯 ...
  • XAML 設計器已意外退出。(退出代碼: e0434352)
    Openxml的顏色變化屬性 目前Openxml存在顏色變化屬性如下： 參數 說明 Hue 色調（色相） HueModulate 色調調製，百分比 HueOffset 色調偏移量，角度值 Saturation 飽和度 SaturationModulation 飽和度調製，百分比 Saturation ...
一周排行
    -Advertisement-
    Play Games
  • 如何基於surging跨網關跨語言進行緩存降級
    基於.NET Framework 4.8 開發的深度學習模型部署測試平臺，提供了YOLO框架的主流系列模型，包括YOLOv8~v9，以及其系列下的Det、Seg、Pose、Obb、Cls等應用場景，同時支持圖像與視頻檢測。模型部署引擎使用的是OpenVINO™、TensorRT、ONNX runti... ...
  • 十年沉澱，重啟開發之路
    十年沉澱，重啟開發之路 十年前，我沉浸在開發的海洋中，每日與代碼為伍，與演算法共舞。那時的我，滿懷激情，對技術的追求近乎狂熱。然而，隨著歲月的流逝，生活的忙碌逐漸占據了我的大部分時間，讓我無暇顧及技術的沉澱與積累。 十年間，我經歷了職業生涯的起伏和變遷。從初出茅廬的菜鳥到逐漸嶄露頭角的開發者，我見證了 ...
  • C#.NET體系圖文概述—2024最全總結
    C# 是一種簡單、現代、面向對象和類型安全的編程語言。.NET 是由 Microsoft 創建的開發平臺，平臺包含了語言規範、工具、運行，支持開發各種應用，如Web、移動、桌面等。.NET框架有多個實現，如.NET Framework、.NET Core（及後續的.NET 5+版本），以及社區版本M... ...
  • 班級擂臺（光榮）榜 - 極簡教育小工具
    前言 本文介紹瞭如何使用三菱提供的MX Component插件實現對三菱PLC軟元件數據的讀寫，記錄了使用電腦模擬，模擬PLC，直至完成測試的詳細流程，並重點介紹了在這個過程中的易錯點，供參考。 用到的軟體： 1. PLC開發編程環境GX Works2，GX Works2下載鏈接 https:// ...
  • web server apache tomcat11-31-websocket
    前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • day31-jQuery
    1、jQuery介紹 jQuery是什麼 jQuery是一個快速、簡潔的JavaScript框架，是繼Prototype之後又一個優秀的JavaScript代碼庫（或JavaScript框架）。jQuery設計的宗旨是“write Less，Do More”，即倡導寫更少的代碼，做更多的事情。它封裝 ...
  • aardio爬蟲) 實戰篇：逆向有道翻譯web介面
    前言 之前的文章把js引擎(aardio封裝庫) 微軟開源的js引擎(ChakraCore))寫好了，這篇文章整點js代碼來測一下bug。測試網站：https://fanyi.youdao.com/index.html#/ 逆向思路 逆向思路可以看有道翻譯js逆向（MD5加密，AES加密）附完整源碼 ...
  • 面試官：這就是你理解的Java多線程基礎？
    引言 現代的操作系統（Windows，Linux，Mac OS）等都可以同時打開多個軟體（任務），這些軟體在我們的感知上是同時運行的，例如我們可以一邊瀏覽網頁，一邊聽音樂。而CPU執行代碼同一時間只能執行一條，但即使我們的電腦是單核CPU也可以同時運行多個任務，如下圖所示，這是因為我們的 CPU 的 ...
  • Python文本統計與分析從基礎到進階
    掌握使用Python進行文本英文統計的基本方法，並瞭解如何進一步優化和擴展這些方法，以應對更複雜的文本分析任務。 ...
  • Redis多數據源，看這篇就夠了
    背景 Redis多數據源常見的場景： 分區數據處理：當數據量增長時，單個Redis實例可能無法處理所有的數據。通過使用多個Redis數據源，可以將數據分區存儲在不同的實例中，使得數據處理更加高效。 多租戶應用程式：對於多租戶應用程式，每個租戶可以擁有自己的Redis數據源，以確保數據隔離和安全性。 ...
所有分類