ossystems/cdn

cdn

镜像概述和主要用途

本项目旨在为任何HTTP后端（如Amazon S3）提供多协议缓存层，通过本地缓存机制存储后端内容，支持HTTP和CoAP两种访问协议，实现快速内容分发并降低对原始后端服务器的请求压力。

核心功能和特性

• 多协议支持：同时提供HTTP和CoAP协议接口，满足不同设备访问需求
• 智能缓存：自动缓存后端内容，优先从本地缓存响应请求，提升访问速度
• 灵活存储配置：可自定义存储目录、最大存储容量和数据库文件路径
• 监控扩展：支持通过插件扩展监控功能，记录访问指标
• 可调节日志：支持多种日志级别（debug、info、warn等），便于问题排查

使用场景和适用范围

• 云存储加速：缓存Amazon S3等云存储服务内容，降低云服务请求次数和延迟
• IoT设备访问：通过CoAP协议为资源受限的物联网设备提供轻量级内容访问
• 静态资源缓存：加速静态网站、图片、文档等资源的分发
• 本地内容代理：作为中间层缓存远程HTTP服务内容，提升本地网络访问效率

使用方法和配置说明

命令行参数说明

基本使用示例

本地启动示例

bash
./cdn --backend http://localhost:8000 --monitor samplemonitor/samplemonitor.so

Docker部署示例

假设使用镜像 cdn:latest，典型部署命令：

bash
docker run -d \
  -p 8080:8080 \    # HTTP端口映射
  -p 5683:5683/udp \ # CoAP端口映射（UDP）
  -v $(pwd)/storage:/app/storage \ # 挂载存储目录
  -v $(pwd)/state.db:/app/state.db \ # 挂载数据库文件
  cdn:latest \
  --backend http://your-s3-bucket.s3.amazonaws.com \ # 后端S3地址
  --size 1073741824 \ # 最大存储容量1GB
  --log info \ # 日志级别设为info
  --storage /app/storage # 容器内存储目录

监控插件开发

接口定义

自定义监控插件需实现以下Go接口：

go
type Monitor interface {
    Init()  // 初始化插件
    // 记录访问指标：协议、路径、客户端地址、传输字节数、文件大小、时间戳
    RecordMetric(protocol, path, addr string, transferred, size int64, timestamp time.Time)
}

示例实现

参考 samplemonitor/monitor.go 查看完整示例实现。

编译插件

bash
cd samplemonitor
go build -buildmode=plugin  # 生成.so插件文件

客户端访问方法

支持的协议和默认地址

• HTTP：默认监听 0.0.0.0:8080
• CoAP：默认监听 0.0.0.0:5683（UDP协议）

访问流程

1. 客户端向cdn服务发送请求
2. 服务检查本地缓存中是否存在请求路径
3. 若缓存命中，直接返回缓存内容；若未命中，从后端获取内容并缓存后返回

实际访问示例

假设后端为Amazon S3存储桶 http://yourbucket.s3.amazonaws.com，其中包含文件 archive.tar.gz，启动cdn服务后可通过以下地址访问：

• HTTP方式：http://localhost:8080/archive.tar.gz
• CoAP方式：coap://localhost:5683/archive.tar.gz