Traefik 技能扩展实战：如何高效添加自定义中间件

共计 2036 个字符，预计需要花费 6 分钟才能阅读完成。

为什么需要扩展 Traefik？

在实际开发中，我们经常会遇到一些通用的功能需求，比如请求头改写、JWT 验证、IP 白名单等。虽然 Traefik 提供了一些内置的中间件，但在某些场景下，这些内置功能可能无法满足我们的需求。这时候，自定义中间件就显得尤为重要。

1. 请求头改写 ：比如在微服务架构中，我们需要在网关层统一添加某些请求头，以便后续服务识别请求来源。
2. JWT 验证 ：在 API 网关层统一验证 JWT 令牌，避免每个服务重复实现相同的逻辑。

原生 Middleware vs 自定义开发

Traefik 的原生中间件非常方便，开箱即用，但它们的功能相对固定，无法满足高度定制化的需求。而自定义中间件则提供了更大的灵活性，允许开发者根据业务需求实现特定的逻辑。

• 原生 Middleware：适合简单的、通用的功能，如重定向、压缩等。
• 自定义开发 ：适合复杂的、业务相关的功能，如自定义认证、请求日志等。

开发环境搭建

1. 安装 Docker：确保你的开发环境已经安装了 Docker，因为 Traefik 通常运行在容器中。
2. 安装 Go：自定义中间件是用 Go 编写的，因此需要安装 Go 1.20+ 版本。
3. 配置开发环境 ：创建一个新的 Go 模块，并添加 Traefik 的依赖。

实现一个基础中间件

以下是一个简单的中间件示例，用于记录请求日志：

package main

import (
    "log"
    "net/http"
)

// LoggingMiddleware 是一个简单的日志中间件
type LoggingMiddleware struct {next http.Handler}

// NewLoggingMiddleware 创建一个新的日志中间件
func NewLoggingMiddleware(next http.Handler) *LoggingMiddleware {return &LoggingMiddleware{next: next}
}

// ServeHTTP 实现 http.Handler 接口
func (m *LoggingMiddleware) ServeHTTP(rw http.ResponseWriter, req *http.Request) {log.Printf("Received request: %s %s", req.Method, req.URL.Path)
    m.next.ServeHTTP(rw, req)
}

编译打包为插件

1. 编写 Dockerfile：使用多阶段构建来编译和打包插件。
2. 构建镜像 ：使用 docker build 命令构建插件镜像。
3. 推送镜像 ：将构建好的镜像推送到 Docker Hub 或其他镜像仓库。

通过静态 / 动态配置加载

在 traefik.yml 中配置自定义中间件：

http:
  middlewares:
    my-logging:
      plugin:
        my-logging:
          # 这里可以添加中间件的配置参数 

生产级代码示例

middleware.go

package main

import (
    "log"
    "net/http"
)

// LoggingMiddleware 是一个简单的日志中间件
type LoggingMiddleware struct {next http.Handler}

// NewLoggingMiddleware 创建一个新的日志中间件
func NewLoggingMiddleware(next http.Handler) *LoggingMiddleware {return &LoggingMiddleware{next: next}
}

// ServeHTTP 实现 http.Handler 接口
func (m *LoggingMiddleware) ServeHTTP(rw http.ResponseWriter, req *http.Request) {log.Printf("Received request: %s %s", req.Method, req.URL.Path)
    m.next.ServeHTTP(rw, req)
}

docker-compose.yml

version: '3'

services:
  traefik:
    image: traefik:v2.10
    ports:
      - "80:80"
      - "8080:8080"
    volumes:
      - ./traefik.yml:/etc/traefik/traefik.yml

traefik.yml

http:
  middlewares:
    my-logging:
      plugin:
        my-logging:
          # 这里可以添加中间件的配置参数 

性能优化

1. 基准测试 ：使用 wrk 或 ab 工具对中间件进行性能测试。
2. 内存泄漏排查 ：使用 pprof 工具监控内存使用情况，及时发现并修复内存泄漏问题。

生产环境避坑指南

1. 热加载失效 ：确保 Traefik 的配置文件和插件镜像路径正确，避免热加载失效。
2. 插件版本兼容性 ：在升级 Traefik 时，注意检查插件是否兼容新版本。
3. 日志管理 ：合理配置日志级别，避免日志过多影响性能。

结尾思考

如何实现中间件级联？在 Traefik 中，可以通过配置多个中间件并按顺序执行来实现级联效果。你有什么更好的实现方式吗？