使用 Traefik 进行 HTTP 路由

简介

在本地开发过程中，通常需要运行多个 HTTP 服务。你可能同时拥有 API 和前端应用、用于模拟数据端点的 WireMock 服务，或者数据库可视化工具（如 phpMyAdmin 或 pgAdmin）。在许多开发设置中，这些服务暴露在不同的端口上，这不仅要求你记住哪个服务对应哪个端口，还可能引入其他问题（例如 CORS）。

反向代理可以极大地简化这种设置，它作为单一的暴露服务，然后根据请求 URL（通过路径或主机名）将请求路由到相应的服务。Traefik 是一个现代的、云原生的反向代理和负载均衡器，使多服务应用的开发和部署变得更加容易。本指南将展示如何将 Traefik 与 Docker 结合使用，以增强你的开发环境。

在本指南中，你将学习如何：

1. 使用 Docker 启动 Traefik
2. 配置路由规则以在两个容器之间拆分流量
3. 在容器化开发环境中使用 Traefik
4. 使用 Traefik 将请求发送到非容器化工作负载

先决条件

要跟随本操作指南学习，需要满足以下先决条件：

• Docker Desktop
• Node.js 和 yarn
• Docker 基础知识

在 Docker 中使用 Traefik

Traefik 的一个独特功能是它可以通过多种方式进行配置。当使用 Docker 提供程序时，Traefik 会从其他正在运行的容器中使用 labels 获取配置。Traefik 将监视引擎事件（容器启动和停止），提取标签并更新其配置。

虽然有 许多 Traefik 监视的标签，但最常见的两个是：

• traefik.http.routers.<service-name>.rule - 用于指示路由规则（在此处查看所有可用规则）
• traefik.http.services.<service-name>.loadbalancer.server.port - 指示 Traefik 应将请求转发到的端口。请注意，此容器端口不需要在主机上暴露（在此处阅读有关端口检测的信息）

让我们快速演示一下如何启动 Traefik，然后配置两个额外的容器以使用不同的主机名进行访问。

1. 为了使两个容器能够相互通信，它们需要位于同一个网络上。使用 docker network create 命令创建一个名为 traefik-demo 的网络：

   $ docker network create traefik-demo
   

2. 使用以下命令启动 Traefik 容器。该命令将 Traefik 暴露在端口 80 上，挂载 Docker 套接字（用于监视容器以更新配置），并传递 --providers.docker 参数来配置 Traefik 使用 Docker 提供程序。

   $ docker run -d --network=traefik-demo -p 80:80 -v /var/run/docker.sock:/var/run/docker.sock traefik:v3.6.2 --providers.docker
   

3. 现在，启动一个简单的 Nginx 容器，并定义 Traefik 用于配置 HTTP 路由的标签。请注意，Nginx 容器没有暴露任何端口。

   $ docker run -d --network=traefik-demo --label 'traefik.http.routers.nginx.rule=Host(`nginx.localhost`)' nginx
   

   容器启动后，在浏览器中打开 http://nginx.localhost 以查看应用（所有基于 Chromium 的浏览器都会在本地路由 *.localhost 请求，无需额外设置）。

4. 启动第二个将使用不同主机名的应用。

   $ docker run -d --network=traefik-demo --label 'traefik.http.routers.welcome.rule=Host(`welcome.localhost`)' docker/welcome-to-docker
   

   容器启动后，在浏览器中打开 http://welcome.localhost。你应该会看到一个“Welcome to Docker”网站。

在开发中使用 Traefik

现在你已经体验了 Traefik，是时候尝试在开发环境中使用它了。在这个例子中，你将使用一个具有拆分前端和后端的示例应用。此应用堆栈具有以下配置：

1. 所有到 /api 的请求都转到 API 服务
2. 所有其他到 localhost 的请求都转到前端客户端
3. 由于应用使用 MySQL，db.localhost 应提供 phpMyAdmin 以便在开发期间轻松访问数据库

该应用可在 GitHub 上访问：dockersamples/easy-http-routing-with-traefik。

1. 在 compose.yaml 文件中，Traefik 使用以下配置：

   services:
     proxy:
       image: traefik:v3.6.2
       command: --providers.docker
       ports:
         - 80:80
       volumes:
         - /var/run/docker.sock:/var/run/docker.sock

   请注意，这与之前使用的配置基本相同，但现在使用的是 Compose 语法。

2. 客户端服务具有以下配置，它将启动容器并为其提供标签以在 localhost 接收请求。

   services:
     # …
     client:
       image: nginx:alpine
       volumes:
         - "./client:/usr/share/nginx/html"
       labels:
         traefik.http.routers.client.rule: "Host(`localhost`)"

3. API 服务具有类似的配置，但你会注意到路由规则有两个条件 - 主机必须是 “localhost” 并且 URL 路径必须具有 “/api” 前缀。由于此规则更具体，Traefik 将首先评估它，而不是客户端规则。

   services:
     # …
     api:
       build: ./dev/api
       volumes:
         - "./api:/var/www/html/api"
       labels:
         traefik.http.routers.api.rule: "Host(`localhost`) && PathPrefix(`/api`)"

4. 最后，phpmyadmin 服务配置为接收主机名 “db.localhost” 的请求。该服务还定义了环境变量以自动登录，使其更容易进入应用。

   services:
     # …
     phpmyadmin:
       image: phpmyadmin:5.2.1
       labels:
         traefik.http.routers.db.rule: "Host(`db.localhost`)"
       environment:
         PMA_USER: root
         PMA_PASSWORD: password

5. 在启动堆栈之前，如果 Nginx 容器仍在运行，请停止它。

就是这样。现在，你只需要使用 docker compose up 启动 Compose 堆栈，所有服务和应用都将准备好进行开发。

将流量发送到非容器化工作负载

在某些情况下，你可能希望将请求转发到未在容器中运行的应用程序。在下面的架构图中，使用了与之前相同的应用程序，但 API 和 React 应用现在在主机上原生运行。

为了实现这一点，Traefik 需要使用另一种方法来配置自身。文件提供程序 允许你在 YAML 文档中定义路由规则。这是一个示例文件：

http:
  routers:
    native-api:
      rule: "Host(`localhost`) && PathPrefix(`/api`)"
      service: native-api
    native-client:
      rule: "Host(`localhost`)"
      service: native-client

  services:
    native-api:
      loadBalancer:
        servers:
          - url: "http://host.docker.internal:3000/"
    native-client:
      loadBalancer:
        servers:
          - url: "http://host.docker.internal:5173/"

此配置表明，对 localhost/api 的请求将被转发到名为 native-api 的服务，然后该服务将请求转发到 http://host.docker.internal:3000。主机名 host.docker.internal 是 Docker Desktop 提供的一个名称，用于向主机发送请求。

有了这个文件，唯一的变化是 Traefik 的 Compose 配置。具体来说，有两件事发生了变化：

1. 配置文件被挂载到 Traefik 容器中（确切的目标路径由你决定）
2. command 已更新以添加文件提供程序并指向配置文件的位置

services:
  proxy:
    image: traefik:v3.6.2
    command: --providers.docker --providers.file.filename=/config/traefik-config.yaml --api.insecure
    ports:
      - 80:80
      - 8080:8080
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./dev/traefik-config.yaml:/config/traefik-config.yaml

启动示例应用

要运行将请求从 Traefik 转发到原生运行的应用的示例应用，请使用以下步骤：

1. 如果 Compose 堆栈仍在运行，请使用以下命令停止它：

   $ docker compose down
   

2. 使用提供的 compose-native.yaml 文件启动应用：

   $ docker compose -f compose-native.yaml up
   

   打开 http://localhost 将返回 502 Bad Gateway，因为其他应用尚未运行。

3. 通过运行以下步骤启动 API：

   cd api
   yarn install
   yarn dev
   

4. 在新终端中（从项目根目录开始）运行以下步骤以启动前端：

   cd client
   yarn install
   yarn dev
   

5. 在 http://localhost 打开应用。你应该会看到一个从 http://localhost/api/messages 获取消息的应用。你还可以打开 http://db.localhost 以直接从 Mongo 数据库查看或调整可用消息。Traefik 将确保请求被正确路由到正确的容器或应用。

6. 完成后，运行 docker compose down 停止容器，并通过按 ctrl+c 停止 Yarn 应用。

总结

运行多个服务不必需要复杂的端口配置和良好的记忆力。借助 Traefik 等工具，可以轻松启动所需的服务并轻松访问它们 - 无论它们是用于应用本身（如前端和后端）还是用于额外的开发工具（如 phpMyAdmin）。