开源项目 Microsoft Reverse Proxy 使用教程

开源项目 Microsoft Reverse Proxy 使用教程

reverse-proxyA toolkit for developing high-performance HTTP reverse proxy applications.项目地址:https://gitcode.com/gh_mirrors/re/reverse-proxy

1. 项目的目录结构及介绍

Microsoft Reverse Proxy 项目的目录结构如下：

reverse-proxy/
├── src/
│   ├── Yarp.ReverseProxy/
│   ├── Yarp.ReverseProxy.Configuration/
│   ├── Yarp.ReverseProxy.Management/
│   ├── Yarp.ReverseProxy.Telemetry/
│   ├── Yarp.ReverseProxy.Transforms/
│   ├── Yarp.ReverseProxy.Service/
│   ├── Yarp.ReverseProxy.Tests/
│   └── Yarp.ReverseProxy.FunctionalTests/
├── samples/
│   ├── SampleReverseProxy/
│   └── SampleReverseProxy.Config/
├── docs/
│   ├── images/
│   └── README.md
├── .gitignore
├── LICENSE
├── README.md
└── global.json

目录结构介绍

• src/: 包含项目的源代码。
  • Yarp.ReverseProxy/: 核心反向代理库。
  • Yarp.ReverseProxy.Configuration/: 配置相关的库。
  • Yarp.ReverseProxy.Management/: 管理相关的库。
  • Yarp.ReverseProxy.Telemetry/: 遥测相关的库。
  • Yarp.ReverseProxy.Transforms/: 转换相关的库。
  • Yarp.ReverseProxy.Service/: 服务相关的库。
  • Yarp.ReverseProxy.Tests/: 单元测试。
  • Yarp.ReverseProxy.FunctionalTests/: 功能测试。
• samples/: 包含示例项目。
  • SampleReverseProxy/: 示例反向代理项目。
  • SampleReverseProxy.Config/: 示例配置项目。
• docs/: 包含文档和图片。
  • images/: 文档中的图片。
  • README.md: 项目文档。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍。
• global.json: 全局配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/Yarp.ReverseProxy/Program.cs 和 src/Yarp.ReverseProxy/Startup.cs。

Program.cs

Program.cs 文件包含了应用程序的入口点，主要负责配置和启动 Web 主机。

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

Startup.cs

Startup.cs 文件包含了应用程序的配置，主要负责配置服务和中间件。

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddReverseProxy()
            .LoadFromConfig(Configuration.GetSection("ReverseProxy"));
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }

        app.UseRouting();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapReverseProxy();
        });
    }
}

3. 项目的配置文件介绍

项目的配置文件通常位于 appsettings.json 或 appsettings.Development.json。

appsettings.json

appsettings.json 文件包含了应用程序的配置信息，特别是反向代理的配置。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ReverseProxy": {
    "Routes": [
      {
        "RouteId": "route1",
        "ClusterId": "cluster1",
        "Match": {
          "Path": "{**catch-all}"
        }
      }
    ],

reverse-proxyA toolkit for developing high-performance HTTP reverse proxy applications.项目地址:https://gitcode.com/gh_mirrors/re/reverse-proxy