ImageGlider.Cli 1.2.0

ImageGlider

ImageGlider 是一个纯 C# AOT 实现的跨平台图像格式转换工具套件，使用 C# (.NET 9) 和 ImageSharp 实现。项目采用模块化架构设计，包含核心类库、命令行工具、示例程序和完整的单元测试，支持 AOT 编译以获得原生性能。

通过ImageGlider，您可以轻松进行图像格式转换，完全摆脱命令行依赖，无需 ImageMagick、Node.js 或 Python，适合在 .NET 项目中内嵌、分发或集成自动打包流程中使用。

🚀 跨平台、零依赖、极速转换，一切尽在 ImageGlider！

项目架构

• ImageGlider - 核心类库，提供图像转换和日志记录功能
• ImageGlider.Cli - 命令行工具，支持单文件和批量转换
• ImageGlider.Example - 示例程序，展示核心类库的典型用法
• ImageGlider.Tests - 单元测试项目，确保代码质量

✨ 功能特点

• 🖼️ 支持多种图像格式转换：JPEG、PNG、GIF、BMP、TIFF、WebP 等
• 🔄 单文件转换和批量转换功能
• 🚀 跨平台：基于 .NET 9 和 ImageSharp，支持 Windows、Linux、macOS 等平台
• ⚡ AOT 编译：利用 .NET 9 的 AOT 功能，提供更快的启动速度和原生性能
• 📦 零依赖：无需安装额外的图像处理工具或运行时
• 模块化设计：核心功能封装为独立类库，便于集成到其他项目中
• 命令行工具：提供功能完整的 CLI 工具，支持丰富的命令行参数
• 单文件转换：支持转换单个图像文件，可指定 JPEG 质量参数
• 批量转换：自动扫描指定目录中的文件并批量转换
• 灵活配置：支持自定义源目录、输出目录、日志目录等参数
• 详细日志：提供完整的日志记录功能，支持多种日志级别（信息、警告、错误）
• 错误处理：完善的异常处理机制，提供详细的转换结果信息

前置条件

• .NET 9 SDK
• 支持的图像格式：JPEG、PNG、GIF、BMP、TIFF、WebP 等（由 ImageSharp 提供支持）

依赖项

• SixLabors.ImageSharp (3.1.8) - 跨平台图像处理库
• xUnit - 单元测试框架（仅测试项目）

📦 安装

作为 .NET Global Tool 安装

dotnet tool install --global ImageGlider.Cli

从源码构建

git clone https://github.com/Deali-Axy/image-glider.git
cd image-glider
dotnet build -c Release

🚀 快速开始

克隆仓库

git clone git@github.com:Deali-Axy/image-glider.git
cd image-glider

恢复依赖

dotnet restore

构建项目

# 构建整个解决方案
dotnet build -c Release

# 或者构建特定项目
dotnet build src/ImageGlider.Cli -c Release

运行测试

dotnet test

使用 AOT 发布 CLI 工具

假设目标平台为 Windows x64（如需其他平台，请更改 -r 参数）：

dotnet publish src/ImageGlider.Cli -c Release -r win-x64 --self-contained true /p:PublishAot=true

发布后生成的可执行文件位于 src/ImageGlider.Cli/bin/Release/net8.0/win-x64/publish 目录中。

运行示例程序

# 运行示例程序，了解核心类库的用法
dotnet run --project src/ImageGlider.Example

使用说明

命令行工具使用方法

查看帮助信息

imageglider --help

单文件转换

# 基本用法
imageglider convert --source image.jfif --target image.jpeg

# 指定 JPEG 质量
imageglider convert -s image.jfif -t image.jpeg -q 85

批量转换

# 基本批量转换（当前目录）
imageglider batch --source-ext .jfif --target-ext .jpeg

# 完整参数示例
imageglider batch -se .jfif -te .jpeg -sd ./input -od ./output -ld ./logs -q 90

参数说明

convert 命令参数：

• --source, -s: 源文件路径（必需）
• --target, -t: 目标文件路径（必需）
• --quality, -q: JPEG 质量，范围 1-100（默认：90）

batch 命令参数：

• --source-ext, -se: 源文件扩展名（必需，如：.jfif）
• --target-ext, -te: 目标文件扩展名（必需，如：.jpeg）
• --source-dir, -sd: 源目录路径（默认：当前目录）
• --output-dir, -od: 输出目录路径（默认：./output）
• --log-dir, -ld: 日志目录路径（默认：./log）
• --quality, -q: JPEG 质量，范围 1-100（默认：90）

核心类库 (ImageGlider)

如果你想在自己的项目中使用 ImageGlider 的核心功能，可以参考以下示例：

using ImageGlider;

// 单文件转换
bool success = ImageConverter.ConvertImage("source.jfif", "target.jpeg", quality: 85);

// 批量转换
var result = ImageConverter.BatchConvert(
    sourceDirectory: "./input",
    outputDirectory: "./output",
    sourceExtension: ".jfif",
    targetExtension: ".jpeg",
    quality: 90
);

// 使用日志服务
using var logger = new LoggingService("./logs");
logger.LogInfo("转换开始");
logger.LogError("转换失败", exception);

🤝 贡献

欢迎贡献代码、提交 issue 或 pull request，共同完善这个项目。

开发和测试

项目结构

ImageGlider/
├── src/
│   ├── ImageGlider/              # 核心类库
│   │   ├── ImageConverter.cs     # 图像转换服务
│   │   └── LoggingService.cs     # 日志记录服务
│   ├── ImageGlider.Cli/          # 命令行工具
│   │   └── Program.cs            # CLI 程序入口
│   └── ImageGlider.Example/      # 示例程序
│       └── Program.cs            # 示例代码
└── tests/
    └── ImageGlider.Tests/        # 单元测试
        └── UnitTest1.cs          # 测试用例

运行开发环境

# 监视模式运行测试
dotnet watch test

# 运行特定测试
dotnet test --filter "TestMethodName"

# 生成测试覆盖率报告
dotnet test --collect:"XPlat Code Coverage"

🛠️ 开发者指南

构建项目

dotnet build

发布模式

ImageGlider 支持两种发布模式：

AOT 发布 (原生性能，无需 .NET 运行时)

dotnet publish src/ImageGlider.Cli -r win-x64 -c release /p:PublishAot=true /p:TrimMode=full /p:InvariantGlobalization=true /p:IlcGenerateStackTraceData=false /p:IlcOptimizationPreference=Size /p:IlcFoldIdenticalMethodBodies=true /p:JsonSerializerIsReflectionEnabledByDefault=true

支持的平台:

• Windows: win-x64
• macOS: osx-x64, osx-arm64
• Linux: linux-x64, linux-arm64

Framework Dependent 发布 (需要 .NET 运行时)

# 发布为 NuGet 包 (.NET Tool)
dotnet pack src/ImageGlider.Cli

# 安装本地打包的工具
dotnet tool install --global --add-source ./src/ImageGlider.Cli/nupkg ImageGlider.Cli

两种发布流程

AOT 发布流程 (独立应用)

1. 编译 AOT 版本:

dotnet publish src/ImageGlider.Cli -r win-x64 -c release /p:PublishAot=true /p:TrimMode=full /p:InvariantGlobalization=true /p:IlcGenerateStackTraceData=false /p:IlcOptimizationPreference=Size /p:IlcFoldIdenticalMethodBodies=true /p:JsonSerializerIsReflectionEnabledByDefault=true

2. 打包生成的文件:

# 进入发布目录
cd src/ImageGlider.Cli/bin/release/net9.0/win-x64/publish/
# 创建 zip 包
powershell Compress-Archive -Path * -DestinationPath imageglider-win-x64.zip

3. 将生成的 zip 文件上传到 GitHub Releases

.NET Tool 发布流程

1. 打包为 NuGet 包:

dotnet pack src/ImageGlider.Cli

2. 生成的包将位于 ./src/ImageGlider.Cli/nupkg 目录中

3. 发布到 NuGet:

dotnet nuget push ./src/ImageGlider.Cli/nupkg/ImageGlider.Cli.1.0.0.nupkg --api-key 您的API密钥 --source https://api.nuget.org/v3/index.json

本地测试

测试 .NET Tool

# 安装本地打包的工具
dotnet tool install --global --add-source ./src/ImageGlider.Cli/nupkg ImageGlider.Cli

# 卸载工具
dotnet tool uninstall --global ImageGlider.Cli

测试 AOT 发布版本

直接运行生成的可执行文件:

./src/ImageGlider.Cli/bin/release/net9.0/win-x64/publish/ImageGlider.Cli.exe

📄 许可证

MIT License

致谢

• 感谢 SixLabors ImageSharp 团队提供强大的跨平台图像处理库
• 感谢 Microsoft .NET 团队提供 .NET 9 的跨平台支持和 AOT 编译特性
• 感谢 xUnit 团队提供优秀的测试框架
• 感谢所有开源社区的贡献者们