Chisel 项目使用教程

Chisel 项目使用教程

Chisel Remove unwanted dependencies from your dotnet projects 项目地址: https://gitcode.com/gh_mirrors/chise/Chisel

1、项目介绍

Chisel 是一个用于移除 .NET 项目中不需要的依赖项的工具。它的诞生是因为某些数据库驱动程序会不可避免地依赖于云库，例如 MongoDB 驱动程序依赖于 AWS SDK 进行身份和访问管理（IAM）认证，而 Microsoft 的 SQL Server 驱动程序依赖于 Azure SDK 进行 Microsoft 身份平台（前身为 Azure AD）认证。即使在使用本地数据库时，这些云依赖项也是不可避免的。Chisel 提供了一种方法来移除这些不必要的依赖项，从而节省宝贵的磁盘空间。

2、项目快速启动

安装 Chisel

首先，你需要将 Chisel NuGet 包添加到你的项目中。你可以使用 NuGet 包管理器或运行以下命令：

dotnet add package Chisel

配置 Chisel

在项目文件（.csproj）中，你可以通过设置 ChiselPackage 属性来指定要移除的依赖项。例如，如果你想移除 AWS SDK 的依赖项，可以添加以下配置：

<PropertyGroup>
  <ChiselPackage>AWSSDK.SecurityToken</ChiselPackage>
</PropertyGroup>

生成依赖图

Chisel 还提供了一个功能，可以生成项目依赖关系的图表。默认情况下，Chisel 会生成 Mermaid 格式的图表，并将其写入中间输出路径（即 obj 目录）。你可以通过设置 ChiselGraphName 属性来生成 Graphviz 格式的图表：

<PropertyGroup>
  <ChiselGraphName>$(MSBuildProjectName).Chisel.gv</ChiselGraphName>
</PropertyGroup>

3、应用案例和最佳实践

移除 MongoDB 驱动程序中的 AWS SDK 依赖

假设你正在使用 MongoDB 驱动程序，并且你不需要 AWS SDK 的依赖项。你可以按照以下步骤移除该依赖项：

1. 安装 Chisel NuGet 包。

2. 在项目文件中添加以下配置：

   <PropertyGroup>
     <ChiselPackage>AWSSDK.SecurityToken</ChiselPackage>
   </PropertyGroup>
   

3. 重新编译项目。Chisel 将会自动移除 AWSSDK.SecurityToken 及其所有传递依赖项。

生成项目依赖图

为了更好地理解项目的依赖关系，你可以生成依赖图。生成的图表可以帮助你识别不必要的依赖项，并优化项目的依赖结构。

4、典型生态项目

Hangfire 和 Npgsql

Chisel 可以与 Hangfire 和 Npgsql 等项目结合使用。例如，如果你在项目中使用了 Hangfire.PostgreSql 和 Npgsql.EntityFrameworkCore.PostgreSQL，Chisel 可以帮助你移除不必要的依赖项，并生成项目的依赖图。

其他数据库驱动程序

Chisel 还可以用于其他数据库驱动程序，如 Microsoft.Data.SqlClient 和 Oracle.ManagedDataAccess。通过移除不必要的依赖项，你可以减少项目的体积，并提高项目的可维护性。

---

通过以上步骤，你可以轻松地使用 Chisel 来优化你的 .NET 项目，移除不必要的依赖项，并生成项目的依赖图。

Chisel Remove unwanted dependencies from your dotnet projects 项目地址: https://gitcode.com/gh_mirrors/chise/Chisel