c# .Net Core靜態檔案伺服器學習總結

MrITzhongzi發表於2018-06-28

概要:本文通過示例,講解了 NET Core2.0 靜態檔案目錄的相關知識,並附帶解析,適合新手,並附帶了完整的專案程式碼。(專案通過 vs2017 初始化的 ASP.NET Core 應用程式,之後選擇***空專案***)

示例程式碼

  • 專案結構

    這裡寫圖片描述

  • program.cs檔案

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

namespace StaticFileServer
{
    public class Program
    {
        public static void Main(string[] args)
        {
            BuildWebHost(args).Run();
        }

        public static IWebHost BuildWebHost(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseKestrel()
                .UseContentRoot(Directory.GetCurrentDirectory())  // 設定當前目錄的內容
                .UseIISIntegration()
                .UseUrls("http://*:5000") // 使 專案在 5000埠被訪問
                .UseStartup<Startup>()
                .Build();
    }
}

複製程式碼
  • Startup.cs 檔案
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.StaticFiles;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.FileProviders;

namespace StaticFileServer
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
          
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            app.UseStaticFiles(); // 使用預設資料夾 wwwroot 僅僅shi wwwroot對外可見
          
            app.Run(async (context) => 
            {
                await context.Response.WriteAsync("hello jesus");
            });
        }
    }
}
複製程式碼
  • 執行效果:
    這裡寫圖片描述
    解析: 這是一個基本的靜態檔案伺服器, app.UseStaticFiles() 函式使當前內容目錄下預設的 wwwroot中的檔案可以被訪問

那麼問題來了,若想訪問其他目錄下的靜態檔案,該怎麼辦?

  • 設定任意目錄下的靜態檔案可以訪問程式碼:
  // 設定 指定目錄的檔案 可以被訪問 start
            var staticfile = new StaticFileOptions();
            staticfile.FileProvider = new PhysicalFileProvider(@"C:\"); // 指定目錄,這裡指的是C盤,也可以指定其他目錄
            app.UseStaticFiles(staticfile); 
複製程式碼

我們吧startup.cs的***Configure*** 函式程式碼改為如下程式碼(增加了c盤檔案可以訪問):

 // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            var staticfile = new StaticFileOptions();
            staticfile.FileProvider = new PhysicalFileProvider(@"C:\"); // 指定目錄,這裡指的是C盤,也可以指定其他目錄
            app.UseStaticFiles(staticfile);  // 使用預設資料夾 wwwroot 僅僅shi wwwroot對外可見
          
            app.Run(async (context) => 
            {
                await context.Response.WriteAsync("hello jesus");
            });
        }
複製程式碼
  • c盤檔案展示
    這裡寫圖片描述
  • 執行效果
    這裡寫圖片描述

這樣我們就可以訪問任意目錄下的檔案了,那麼問題來了,c盤中有個 叫 456.log 的檔案,我們訪問不了,原因是:伺服器不能識別,怎麼辦?如何讓伺服器識別 所有型別的檔案呢? 我們以 .log 為字尾的檔案為例

  • 我們將***Configure*** 改為一下內容:
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            var staticfile = new StaticFileOptions();
            staticfile.FileProvider = new PhysicalFileProvider(@"C:\"); // 指定目錄,這裡指的是C盤,也可以指定其他目錄

                // 設定 對應的檔案型別(防止Mime type沒事別出來,打不開或出現404錯誤)
                staticfile.ServeUnknownFileTypes = true;
                staticfile.DefaultContentType = "application/x-msdownload";// 設定預設 MIME TYPE
                var provider = new FileExtensionContentTypeProvider();
                provider.Mappings.Add(".log", "text/plain"); // 手動設定對應的 MIME TYPE
                staticfile.ContentTypeProvider = provider;

            app.UseStaticFiles(staticfile); // 使用預設資料夾 wwwroot 僅僅shi wwwroot對外可見
            // 設定 指定目錄的檔案 可以被訪問 end

            app.Run(async (context) =>
            {
                await context.Response.WriteAsync("hello jesus");
            });
        }
複製程式碼

我們將不能識別的檔案型別預設為 : "application/x-msdownload",即遇到我們沒處理的,不能識別的型別統統下載下來。 provider.Mappings.Add(".log", "text/plain"); // 手動設定對應的 MIME TYPE 。我們手動增加了 對字尾為.log的檔案型別的處理,當成文字檔案處理,即txt處理。

  • 執行效果
    • 未知的檔案 (我們訪問789.ggg檔案,此檔案型別我們未處理過)
      這裡寫圖片描述
    • 已處理的檔案型別
      這裡寫圖片描述

這樣,我們就可以訪問任意型別的靜態檔案了,那麼問題又來了, 我想訪問一個目錄下所有的檔案,即訪問某個目錄怎麼辦?

在 NET Core 中訪問目錄的功能預設是禁止的,需要手動開啟。 步驟:

  1. 在 ConfigureServices 函式中增加 目錄訪問服務,
 public void ConfigureServices(IServiceCollection services)
        {
            services.AddDirectoryBrowser(); // 使目錄可以被瀏覽 (瀏覽所有的檔案以及資料夾)
        }
複製程式碼
  1. 在Configure 函式中增加 中間鍵 和 具體的目錄,在這裡我們讓 c盤下的所有目錄可以被訪問
 // 設定 目錄可瀏覽  start
            var dir = new DirectoryBrowserOptions();
            dir.FileProvider = new PhysicalFileProvider(@"C:\");
            app.UseDirectoryBrowser(dir);
            // 設定 目錄可瀏覽  end
複製程式碼
  • 這樣我們就可以訪問c盤中的任意目錄了,效果如下:

    這裡寫圖片描述

  • Startup.cs 檔案最終程式碼如下:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.StaticFiles;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.FileProviders;

namespace StaticFileServer
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddDirectoryBrowser(); // 使目錄可以被瀏覽 (瀏覽所有的檔案以及資料夾)
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            // 設定 目錄可瀏覽  start
            var dir = new DirectoryBrowserOptions();
            dir.FileProvider = new PhysicalFileProvider(@"C:\");
            app.UseDirectoryBrowser(dir);
            // 設定 目錄可瀏覽  end

            // 設定 指定目錄的檔案 可以被訪問 start
            var staticfile = new StaticFileOptions();
            staticfile.FileProvider = new PhysicalFileProvider(@"C:\"); // 指定目錄,這裡指的是C盤,也可以指定其他目錄

                // 設定 對應的檔案型別(防止Mime type沒事別出來,打不開或出現404錯誤)
                staticfile.ServeUnknownFileTypes = true;
                staticfile.DefaultContentType = "application/x-msdownload";// 設定預設 MIME TYPE
                var provider = new FileExtensionContentTypeProvider();
                provider.Mappings.Add(".log", "text/plain"); // 手動設定對應的 MIME TYPE
                staticfile.ContentTypeProvider = provider;

            app.UseStaticFiles(staticfile); // 使用預設資料夾 wwwroot 僅僅shi wwwroot對外可見
            // 設定 指定目錄的檔案 可以被訪問 end

            app.Run(async (context) => 
            {
                await context.Response.WriteAsync("hello jesus");
            });
        }
    }
}

複製程式碼

相關文章