NanUI

本地文件资源

概述

本地文件资源是指在本地文件系统中的文件资源。您可以为本地文件资源控制器指定一个本地文件系统中的文件夹,然后在您的应用中使用该控制器来访问该文件夹中的文件。

注册本地文件资源控制器

您可以在 WinFormium 应用程序创建阶段使用 AppBuilder 来注本地文件资源控制器,也可以在 WinFormium 应用程序配置阶段使用 WinFormiumStartup 类的 ConfigureServices 以配置服务的方式来注册本地文件资源控制器。

注册示例

AppBuilder

class Program
{
    [STAThread]
    static void Main(){
        var builder = WinFormiumApp.CreateBuilder();

        var app = builder
        //...
        .UseLocalFileResource(new LocalFileResourceOptions
        {
            Scheme = "http",
            DomainName = "files.app.local",
            PhysicalFilePath = Path.Combine(AppContext.BaseDirectory, "wwwroot")
        })
        .build();

        app.Run();

    }
}

使用 AppBuilder 的扩展方法 UseLocalFileResource 来注册本地文件资源控制器,该方法接受一个 LocalFileResourceOptions 类型的参数,您可以通过该参数来指定本地文件资源控制器的 Url 地址、资源所在的文件夹路径等。

WinFormiumStartup

class MyApp : WinFormiumStartup
{
    //...

    public override void ConfigureServices(IServiceCollection services)
    {
        //...
        services.AddLocalFileResource(new LocalFileResourceOptions
        {
            Scheme = "http",
            DomainName = "files.app.local",
            PhysicalFilePath = Path.Combine(AppContext.BaseDirectory, "wwwroot")
        });
        //...
    }

}

使用 WinFormiumStartup 的扩展方法 AddLocalFileResource 来注册本地文件资源控制器,该方法接受一个 LocalFileResourceOptions 类型的参数,您可以通过该参数来指定本地文件资源控制器的 Url 地址、资源所在的文件夹路径等。

LocalFileResourceOptions

LocalFileResourceOptions 类型的参数用于指定本地文件资源控制器的 Url 地址、资源所在的文件夹路径等。它包含以下属性:

属性名称 类型 描述
Scheme string 嵌入式文件资源控制器的 Url 协议名称,例如 httphttpsfile 等。
DomainName string 嵌入式文件资源控制器的 Url 域名,例如 embedded.app.local
PhysicalFilePath string 资源所在的文件夹的绝对路径。

使用本地文件资源

在上一节的示例中,我们注册了一个本地文件资源控制器(以两种不同方式),这个资源控制器的 Url 地址为 http://files.app.local,它的资源文件来源于本地的 wwwroot 文件夹,那么您就可以在 WinFormium 应用程序中使用 http://files.app.local 来访问指定文件夹中的资源了。

另请参阅