Meilleures pratiques Nuget C#

Par -

Votre projet étant amené a grandir et à se complexifier autant mettre en place des mesures qui supportent la mise à l'échelle.

Gestion unifiée des packages

Gestion des packages au niveau de la solution

Utilisez un fichier Directory.Build.props pour inclure des références à la majorité des packages dans les projets.

Les analyseurs de code seront systématiquement présents.

Pour les projets de test, ajoutez votre pack de packages par exemple :
  • xUnit
  • nSubstitute
  • nSubstitute.Analyzers
  • FluentAssertions
  • FluentAssertions.Analyzers
Ainsi les nouveaux projets référenceront automatiquement les packages requis.
Chaque projet pourra bien sur référencer directement des packages spécifiques.

<!--Add Test Packages in Test projects.-->
<ItemGroup Condition="$(IsTestProject) == 'true'">
<PackageReference Include="FluentAssertions" />
<!--Microsoft-->
<PackageReference Include="Microsoft.NET.Test.Sdk" />
<PackageReference Include="MSTest.TestFramework" />
<!--XUnit-->
<PackageReference Include="xunit" />
<!--XUnit.Analyzer-->
<PackageReference Include="xunit.runner.visualstudio">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

Mapping de Source de Package

Votre organisation utilise surement des packages "maison". Dans vos projets vous utilisez des package publics.
Pour faciliter les opérations, procéder à un mapping des sources packages, ainsi Visual Studio et les outils dotnet sauront ou trouver les informations complémentaires à un nuget et notamment ses informations de debugging plus facilement.

Utiliser un fichier nuget.config pour cela :

nuget.config

<?xml version="1.0" encoding="utf-8"?>
<configuration>
<!-- Define my package sources, nuget.org and contoso.com. -->
<!-- `clear` ensures no additional sources are inherited from another config file. -->
<packageSources>
<clear />
<!-- `key` can be any identifier for your source. -->
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
<add key="MyCustomFeedOrganisation" value="https://pkgs.dev.azure.com/custom/_packaging/feed/nuget/v3/index.json" />
</packageSources>

<!-- Microsoft.* packages will only come from nuget.org. -->
<!-- All other packages come from contoso.com by default. -->
<packageSourceMapping>
<packageSource key="nuget.org">
<package pattern="*" />
</packageSource>
<packageSource key="MyCustomFeedOrganisation">
<package pattern="ORG.*" />
</packageSource>
</packageSourceMapping>

</configuration>

Centralisation des version de packages

Nos projets vont donc référencer des packages de 2 manières :
  • depuis le Directory.Build.props de la solution
  • depuis le csproj du projet

Directory.packages

<Project>

<PropertyGroup>
<ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
</PropertyGroup>
<ItemGroup>

<PackageVersion Include="MediatR" Version="12.3.0" />
<PackageVersion Include="Microsoft.Azure.AppConfiguration.Functions.Worker" Version="7.3.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker" Version="1.22.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.17.4" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.OpenApi" Version="1.5.1" />

<PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="1.3.2" />

<!--Application Insights-->
<PackageVersion Include="Microsoft.ApplicationInsights.WorkerService" Version="2.22.0" />
<PackageVersion Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="1.2.0" />

<!--Code Analyzers-->
<PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
<PackageVersion Include="Microsoft.Net.Compilers.Toolset" Version="4.10.0" />
<PackageVersion Include="coverlet.collector" Version="6.0.2" />

<!--Cosmos DB-->
<PackageVersion Include="Microsoft.Azure.Cosmos" Version="3.42.0" />

<!--Fluent-->
<PackageVersion Include="FluentAssertions" Version="6.12.0" />

<!--Microsoft-->
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
<PackageVersion Include="MSTest.TestFramework" Version="3.5.0" />

<!--XUnit-->

<PackageVersion Include="xunit" Version="2.9.0" />
<PackageVersion Include="xunit.runner.visualstudio" Version="2.8.2" />
<PackageVersion Include="ORG.Candice.Domain" Version="8.0.0" />
<PackageVersion Include="ORG.Candice.Infrastructure" Version="8.0.0" />
</ItemGroup>

</Project>

Ressources
https://learn.microsoft.com/fr-fr/nuget/consume-packages/package-source-mapping

Commentaires

Enregistrer un commentaire

Posts les plus consultés de ce blog

Sécurité des Applications

Par -
Introduction à la sécurité Outils pour la sécurité Les outils pour la sécurité recouvrent des notions à peu près identiques quelque soit le domaine de l'informatique que l'on considère. Les catégories développées ici sont présentes dans les trois problématiques traités dans la suite : le code, le réseau et les applications web. Les outils de contrôle d'accès et de filtrage Notions : contrôle d'accès discrétionnaire, ressources informatiques, règles d'accès, chaînage de droits, authentification forte, les trois types d'authentifications, architectures de contrôle d'accès, filtrage des flux. Le contrôle d'accès : c'est permettre à un sujet d'accéder à un système sous certaines conditions et d'effectuer un certain nombre d'opérations sur un objet défini. Ceci doit théoriquement permettre d'envisager tous les situations d'accès possibles mais la multiplication des sujets, des objets et des règles rend une vision globale difficile. Le
Lire la suite

Principes de la Programmation Orientée Objet

Par -
Principes Généraux : Objet et Classe Un objet est un concept de programmation qui groupe des fonctionnalités dans une entité, entité qui peut ensuite être créée à la demande. Une classe est l'implémentation d'un objet, c'est-à-dire une unité de code contenant les attributs et fonctions décrivant un objet. Encapsulation L'encapsulation consiste d'une part, à regrouper au sein d'une même entité (la classe), des propriétés et méthodes (les attributs) et d'autre part à définir la visibilité de ces attribvutes (privé, protege...) de façon à présenter une interface permettant de manipuler une classe sans en connaitre le fonctionnement interne. L’encapsulation permet de faire voir l’objet à l’extérieur comme une boîte noire ayant certaines attributs (proriétés et fonctions) et ayant un comportement spécifié. La manière dont ces propriétés ont été implémentées est alors cachée aux utilisateurs de la classe. L’implémentation peut être modifiée sans changer le comport
Lire la suite

Principe de Responsabilité Unique

Par -
Qu'est-ce qu'une Responsabilité ? Dans le contexte du Principe de Responsabilité Unique (SRP), nous définissons une responsabilité comme "une raison de changement". Si vous pouvez penser à plus d'un motif de modification pour une classe, alors cette classe a plus d'une responsabilité. Développement du Principe de Responsabilité Unique Le Principe de Responsabilité Unique (SRP) est l'un des principes fondamentaux de la conception logicielle, souvent associé au paradigme de la programmation orientée objet. Il stipule qu'une classe ou un module ne devrait avoir qu'une seule raison de changer, ou en d'autres termes, il ne devrait être responsable que d'une seule tâche ou fonctionnalité. Clarification de la Responsabilité Le terme "responsabilité" dans le SRP fait référence aux raisons potentielles pour lesquelles une classe ou un module pourrait nécessiter une modification à l'avenir. Une classe ou un module est considéré comme re
Lire la suite