首页 > 编程语言 >如何使用csproj构建C#源代码组件NuGet包？

如何使用csproj构建C#源代码组件NuGet包？

时间：2024-06-19 09:10:01浏览次数：22  
标签：文件 C# csproj AllenCai BuildingBlocks cs 源代码 targets

一般我们构建传统的NuGet包，都是打包和分发dll程序集文件。

至于打包和分发C#源代码文件的做法，比较少见。

那么这种打包源代码文件的做法，有什么优点和缺点呢？

优点：

  1. 方便阅读源代码。
  2. 方便断点调试。
  3. 减少 Assembly 程序集模块加载个数。
  4. 更利于发布期间的剪裁（PublishTrimmed 选项）。
  5. 更利于混淆和保护代码（Internal 级别的源代码）。

缺点：

  1. 容易外泄原始的源代码文件。
  2. 随着引入源代码组件越多，越容易引发命名空间和类型名称重复冲突。

经验：

  1. 不建议也不推荐分发 public 级别的源代码。
  2. 尽可能严格规范命名类型名称。
  3. 向目标项目写入源代码组件 version 和 git commit sha-1，方便出问题时排查版本问题。
  4. 每次改动源代码文件时，尽可能做到向下兼容。

正文：

接下来，我们一起看看如何制作仅打包C#源代码文件，不打包dll程序集文件的C#源代码组件NuGet包。

首先是创建 AllenCai.BuildingBlocks 项目，目录结构如下：

.
├── build
└── src
    ├── AllenCai.BuildingBlocks
    │   ├── AllenCai.BuildingBlocks.csproj
    │   ├── Properties
    │   │   ├── PackageInfo.cs
    │   ├── Assets
    │   │   ├── build
    │   │   │   └── AllenCai.BuildingBlocks.targets
    │   │   └── buildMultiTargeting
    │   │       └── AllenCai.BuildingBlocks.targets
    │   ├── Collections
    │   │   ├── ArrayBuilder.cs
    │   │   ├── other...
    │   ├── Functional
    │   │   ├── Result.cs
    │   │   ├── other...
    │   ├── ObjectPooling
    │   │   ├── DictionaryPool.cs
    │   │   ├── other...
    │   ├── Text
    │   │   ├── StringBuffer.cs
    │   │   ├── other...
    │   ├── Threading
    │   │   ├── ValueTaskEx.cs
    │   │   ├── other...
    │   ├── bin
    │   │   ├── Release
    │   │   │   └── other...
    │   │   ├── Debug
    │   │   │   └── other...
    │   └── obj
    │   │   ├── other...
    │   ├── icon.png
    │   ├── other...
    ├── AllenCai.BuildingBlocks.sln
    └── Directory.Build.targets
├── .gitattributes
├── .gitignore
├── README.md

其中 Directory.Build.targets 文件，用来生成描述源代码组件包版本信息的C#源代码文件，输出文件路径为：Properties\PackageInfo.cs。

之所以输出到 Properties 目录，是因为 PackageInfo.cs 的作用其实和以前 .NET Framework 时代每个项目都会包含的 AssemblyInfo.cs 相同。

那么，为什么需要生成这个 PackageInfo.cs 文件呢？

  1. 因为不再是编译和发布dll，而是直接打包和提供源代码文件，原本被内嵌到dll程序集的版本信息是丢失的。
  2. 懒，也不希望每次手工维护写入 Version 和 git commit sha-1。

Directory.Build.targets 文件代码如下所示：

<Project>
  <!--
    将代码版本信息输出到C#文件中，使用者在项目中引入本组件源码，能够看到版本信息。
    且在使用者项目编译为程序集文件后，也能够保留本组件版本信息。
  -->
  <Target Name="GeneratePackageInfoToFile" BeforeTargets="PreBuildEvent" Condition="'$(Configuration)' == 'Release'">
    <PropertyGroup>
      <SharedPackageInfoFile>$(ProjectDir)Properties\PackageInfo.cs</SharedPackageInfoFile>
    </PropertyGroup>
​
    <ItemGroup>
      <AssemblyAttributes Include="AssemblyMetadata">
        <_Parameter1>PackageVersion</_Parameter1>
        <_Parameter2>$(Version)</_Parameter2>
      </AssemblyAttributes>
      <AssemblyAttributes Include="AssemblyMetadata">
        <_Parameter1>PackageBuildDate</_Parameter1>
        <_Parameter2>$([System.DateTime]::Now.ToString("yyyy-MM-dd HH:mm:ss"))</_Parameter2>
      </AssemblyAttributes>
      <AssemblyAttributes Include="AssemblyMetadata" Condition="'$(SourceRevisionId)' != ''">
        <_Parameter1>PackageSourceRevisionId</_Parameter1>
        <_Parameter2>$(SourceRevisionId)</_Parameter2>
      </AssemblyAttributes>
    </ItemGroup>
​
    <MakeDir Directories="$(ProjectDir)Properties"/>
    <WriteCodeFragment Language="C#" OutputFile="$(SharedPackageInfoFile)" AssemblyAttributes="@(AssemblyAttributes)" />
    <Message Importance="high" Text="SharedPackageInfoFile --> $(SharedPackageInfoFile)" />
​
    <ItemGroup>
      <Compile Include="$(SharedPackageInfoFile)" Pack="true" BuildAction="Compile" />
    </ItemGroup>
  </Target>
</Project>

而 AllenCai.BuildingBlocks.targets 文件，将会被打包到NuGet包。

当这个包被添加引用到目标项目中，MsBuild 将会自动调用它，执行一系列由你定义的动作。

那么，又为什么需要这个 AllenCai.BuildingBlocks.targets 文件呢？

它其实是非必须的，根据项目实际情况而定，没有这个 targets 文件也是可以的。

但这样的话，可能引用这个源代码组件包的开发者会在刚引入时遇到一系列问题，导致这个源代码组件包对开发者不友好。

比如源代码文件中使用了不安全代码，而目标项目的<AllowUnsafeBlocks>属性值是 false，那么目标项目在编译时就会报错。

因此需要这个 targets 文件来检查和自动设置为 true。

如以下示例代码(build\AllenCai.BuildingBlocks.targets)：

<Project>
  <Target Name="UpdateLangVersionAndAllowUnsafeBlocks" BeforeTargets="BeforeCompile">
    <PropertyGroup>
      <OldAllowUnsafeBlocks>$(AllowUnsafeBlocks)</OldAllowUnsafeBlocks>
      <AllowUnsafeBlocks Condition=" '$(AllowUnsafeBlocks)' == '' or $([System.String]::Equals('$(AllowUnsafeBlocks)','false','StringComparison.InvariantCultureIgnoreCase')) ">True</AllowUnsafeBlocks>
    </PropertyGroup>
​
    <!--当属性项被修改时，在Build控制台输出提示-->
    <Message Importance="high" Condition=" '$(AllowUnsafeBlocks)' != '$(OldAllowUnsafeBlocks)' " Text="Update AllowUnsafeBlocks to $(AllowUnsafeBlocks)" />
  </Target>
</Project>
以及 buildMultiTargeting\AllenCai.BuildingBlocks.targets 文件代码如下所示：
<Project>
  <Import Project="..\build\AllenCai.BuildingBlocks.targets" />
</Project>

需要注意的是，这个 targets 文件需要与 ProjectName 或 PackageId 保持一致。

最后 AllenCai.BuildingBlocks.csproj 文件代码如下所示：

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFrameworks>net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
    <LangVersion>default</LangVersion>
    <Nullable>enable</Nullable>
    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
    <ImplicitUsings>disable</ImplicitUsings>
    <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
    <GenerateDocumentationFile>false</GenerateDocumentationFile>
    <Version>0.0.1</Version>
  </PropertyGroup>
​
  <!--一些与NuGet包相关的属性项-->
  <PropertyGroup>
    <Title>AllenCai BuildingBlocks</Title>
    <Description>提供一组最常用的通用软件模块,以文件链接的方式被包含到引用项目中。</Description>
    <Authors>Allen.Cai</Authors>
    <Copyright>Copyright © Allen.Cai 2015-$([System.DateTime]::Now.Year) All Rights Reserved</Copyright>
    <ContentTargetFolders>contentFiles\cs\any\AllenCai.BuildingBlocks;content\cs\any\AllenCai.BuildingBlocks</ContentTargetFolders>
    <!--该属性项声明了仅在开发期间依赖，并且不传递其自身的依赖项，这将导致目标项目需要主动引入间接依赖项-->
    <DevelopmentDependency>true</DevelopmentDependency>
    <!--打包时不包含编译输出的文件-->
    <IncludeBuildOutput>false</IncludeBuildOutput>
    <!--该属性项仅用于源生成器(SourceGenerator)项目，从 Visual Studio 2022 v16.10及以上版本开始支持-->
    <!--<IsRoslynComponent>true</IsRoslynComponent>-->
    <!--跳过包分析-->
    <NoPackageAnalysis>true</NoPackageAnalysis>
    <PackageProjectUrl>http://192.168.1.88:5555/allen/allencai.buildingblocks/</PackageProjectUrl>
    <PackageReadmeFile>README.md</PackageReadmeFile>
    <RepositoryUrl>http://192.168.1.88:5555/allen/allencai.buildingblocks.git</RepositoryUrl>
    <RepositoryType>git</RepositoryType>
    <PackageIcon>icon.png</PackageIcon>
  </PropertyGroup>
​
  <ItemGroup>
    <!-- <PackageReference Include="System.Reactive" Version="5.0.0" /> -->
    <None Include="icon.png" Pack="true" PackagePath="\" />
    <None Include="..\..\README.md" Link="README.md" Pack="true" PackagePath="\" />
    <Content Include="**\*.cs" Exclude="obj\**\*.cs" Pack="true" BuildAction="Compile" />
  </ItemGroup>
</Project>

其中三个属性比较重要，DevelopmentDependency 和 IncludeBuildOutput 以及 ContentTargetFolders。

  1. 将 DevelopmentDependency 设置为 true，表示这个 NuGet 包仅在开发期间依赖​。
  2. 将 IncludeBuildOutput 设置为 false，表示打包时不包含编译输出的 dll​ 文件。
  3. 重写 ContentTargetFolders，将会改变这些源代码文件在目标项目中的虚拟​文件系统布局。

如有不明白，欢迎留言，互相探讨。

截止本文，我刚搜到有 MVP大佬-吕毅 也写了类似教程，​大家也可以参考：从零开始制作 NuGet 源代码包（全面支持 .NET Core / .NET Framework / WPF 项目） - walterlv

标签：文件,C#,csproj,AllenCai,BuildingBlocks,cs,源代码,targets
From： https://www.cnblogs.com/VAllen/p/18255504/how-to-use-csproj-to-build-the-csharp-source-cod

相关文章

  • OmniGraffle for mac(思维导图软件)v7.23中文正式版
    OmniGraffle是一款专业的图形设计工具，主要用于创建流程图、组织结构图、网络图、原型设计等。它具有丰富的模板和符号库，用户可以根据需要自定义符号和模板，方便快捷地创建各种类型的图形设计。OmniGraffle还支持多种导出格式，包括PDF、PNG、JPG、SVG等，并且可以与其他软件进行无缝......
  • FxFactory 8 Pro for Mac(视觉特效处理包)v8.0.16版
    FxFactory8proforMac是一个mac上的全新的视觉特效软件包——强大的插件包合集，包含视觉效果工具箱与无与伦比的功能。支持FinalCutPro,Motion,AfterEffects和PremierePro。FxFactory8ProforMac(视觉特效处理包)软件地址fxfactory功能亮点1、FxFactorymac提......
  • python模块之codecs
    python模块codecspython对多国语言的处理是支持的很好的，它可以处理现在任意编码的字符，这里深入的研究一下python对多种不同语言的处理。有一点需要清楚的是，当python要做编码转换的时候，会借助于内部的编码，转换过程是这样的：原有编码->内部编码->目的编码python的内部......
  • Vue 3中的reactive：响应式对象和数组
    ......
  • 【国赛赛题详解】2024年数学建模国赛ABCDEF题（点个关注，后续会更新）
     您的点赞收藏是我继续更新的最大动力！一定要点击如下的蓝色字体链接，那是获取资料的入口!点击链接加入群聊【2024国赛资料合集】：http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=eQt5WRIvc5-fogZRrrahAhbqDa2nKfW8&authKey=%2BqQfThTxNnhw5LGJFRIcneF8JXBj1ufd2K01UpKPrpcgkKDskF......
  • acwing246 区间最大公约数
    给定长度为N的数列A，以及M条指令，每条指令可能是以下两种之一：Clrd，表示把A[l],A[l+1],...A[r]都加上d。Qlr，表示查询A[l],A[l+1],...A[r]的最大公约数。对于每个询问，输出一个整数表示答案。分析：利用差分数组，将区间修改转换成两次单点修改。再用差分数组构造出原数组区间的......
  • C++数据格式化3 - 格式化时间区间(使用时长)
    1.关键词2.strfmt.h3.strfmt.cpp4.测试代码5.运行结果6.源码地址1.关键词关键字：C++数据格式化字符串处理std::string时间区间跨平台应用场景：想对一个时间区间(如用时：2000s)进行格式化，转化成人类易读的时分秒的格式。2.strfmt.h#pragmaonce#include......
  • C++数据格式化4 - 格式化时间戳
    1.关键词2.strfmt.h3.strfmt.cpp4.测试代码5.运行结果6.源码地址1.关键词C++数据格式化字符串处理std::string时间戳跨平台2.strfmt.h#pragmaonce#include<string>#include<cstdint>#include<sstream>#include<iomanip>#include"timeutil.h&quo......
  • 点云分割网络PointConv
    PDF：《PointConv:DeepConvolutionalNetworkson3DPointClouds》CODE:https://github.com/DylanWusee/pointconv一、大体内容PointConv是一种在非均匀采样下对3D点云进行卷积的运算，可以用来构建深度卷积网络，其将卷积核视为由权重函数和密度函数组成的三维点的局部坐标的非......
  • python:create file
     #os.mkdir(path)filename='1.py'try:ifnotos.path.exists("Common"):os.mkdir("Common")else:ifos.path.exists("Common/"+filename):print(fi......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99