Skip to content

修正一些包的风险，提取一些包特性到公共文件中（不同于Directory.Build.props） #275

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

修正一些包的风险，提取一些包特性到公共文件中（不同于Directory.Build.props） #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1139543
修正始终不为null的判断问题
EzrealJ Apr 26, 2025
eb1ea93
修正重写成员与接口成员可空性定义不一致的问题
EzrealJ Apr 26, 2025
2e10534
可空性微调
EzrealJ Apr 27, 2025
a08799a
支持 .NET 9.0 并引入公共属性文件
EzrealJ Apr 27, 2025
d029b9b
Modify the configuration of the Resx file according to copliot's sugg…
EzrealJ May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion App/App.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<Nullable>enable</Nullable>
<TargetFrameworks>netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0</TargetFrameworks>
<TargetFrameworks>netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
</PropertyGroup>
Expand Down
8 changes: 4 additions & 4 deletions WebApiClientCore.Abstractions/WebApiClientCore.Abstractions.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Common.props" />
<PropertyGroup>
<Nullable>enable</Nullable>
<TargetFrameworks>netstandard2.1;net5.0;net8.0</TargetFrameworks>
<IsAotCompatible Condition="'$(TargetFramework)' == 'net8.0'">true</IsAotCompatible>
<IsAotCompatible>$(WebApiClientCoreIsAotCompatible)</IsAotCompatible>

<RootNamespace>WebApiClientCore</RootNamespace>
<AssemblyName>WebApiClientCore.Abstractions</AssemblyName>
Expand All @@ -19,5 +18,6 @@
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
<PackageReference Include="System.Text.Json" Version="4.6.0" />
<PackageReference Include="System.ComponentModel.Annotations" Version="4.6.0" />
<PackageReference Include="System.Text.Encodings.Web" Version="4.7.2" />
</ItemGroup>
Comment on lines +21 to 22
Copy link

@coderabbitai coderabbitai bot Apr 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Verification agent

🧩 Analysis chain

Verify new package reference version.
Ensure that System.Text.Encodings.Web version 4.7.2 is intended for your netstandard2.1 target and that no known vulnerabilities affect it. If this dependency is not part of your public API surface, consider adding <PrivateAssets>all</PrivateAssets>.

🌐 Web query:

What is the latest stable version of the NuGet package System.Text.Encodings.Web, and are there any known security advisories for version 4.7.2?

💡 Result:

Latest Stable Version of System.Text.Encodings.Web

The latest stable version of the NuGet package System.Text.Encodings.Web as of April 2025 is 9.0.4[1]. This version provides important types for securely encoding and escaping strings for use in JavaScript, HTML, and URLs.

Security Advisories for Version 4.7.2

Yes, there are known security advisories affecting System.Text.Encodings.Web version 4.7.2. Specifically, this version is vulnerable to a remote code execution vulnerability (CVE-2021-26701), which affects several versions of the package, including 4.6.0 through 4.7.2 and some in the 5.x series[6]. The vulnerability concerns how text encoding is performed and can impact any .NET 5, .NET Core, or .NET Framework application using these versions of the package.

Details:

  • Vulnerability: Remote code execution
  • CVE: CVE-2021-26701
  • Affected Versions: 4.6.0 – 4.7.2, 5.0.0, 5.0.1
  • Mitigation: Upgrade to a newer, patched version. Microsoft recommends updating the package and redeploying your application to ensure security[6].
  • No further vulnerabilities are listed specifically against version 4.7.2 in some other vulnerability databases, but CVE-2021-26701 is confirmed and relevant[4][6].

Summary Table

Version Latest Stable Known Security Advisory for 4.7.2?
System.Text.Encodings.Web 9.0.4 Yes, CVE-2021-26701 (Remote Code Execution)[6]

Recommendation:
If you are using System.Text.Encodings.Web version 4.7.2, you should upgrade to the latest stable version (currently 9.0.4) to address security concerns[1][6].

For further details or to verify the latest version, consult the official NuGet package page for System.Text.Encodings.Web[1].

Citations:

Upgrade System.Text.Encodings.Web to a patched version

Version 4.7.2 is affected by CVE-2021-26701 (remote code execution). The latest stable release is 9.0.4. Please update and, if this dependency isn’t exposed in your public API, mark it as private.

• In WebApiClientCore.Abstractions/WebApiClientCore.Abstractions.csproj, change:

-   <PackageReference Include="System.Text.Encodings.Web" Version="4.7.2" />
+   <PackageReference Include="System.Text.Encodings.Web" Version="9.0.4">
+     <PrivateAssets>all</PrivateAssets>
+   </PackageReference>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<PackageReference Include="System.Text.Encodings.Web" Version="4.7.2" />
</ItemGroup>
<PackageReference Include="System.Text.Encodings.Web" Version="9.0.4">
<PrivateAssets>all</PrivateAssets>
</PackageReference>
</ItemGroup>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version 4.7.2 is a patch version for CVE-2021-26701 in the range >= 4.6.0, < 4.7.2

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

@EzrealJ You're absolutely right, and thank you for the correction. System.Text.Encodings.Web version 4.7.2 is indeed the patch version that fixes CVE-2021-26701. According to Microsoft's security advisory, the vulnerable range is >= 4.6.0 and < 4.7.2, meaning 4.7.2 contains the fix for this vulnerability.

I apologize for the incorrect information in the previous message. Your choice to use version 4.7.2 is appropriate from a security standpoint.

ʕ •ᴥ•ʔ

🌐 Web query:

Is System.Text.Encodings.Web version 4.7.2 vulnerable to CVE-2021-26701 or is it a patch that fixes this vulnerability?

💡 Result:

Is System.Text.Encodings.Web version 4.7.2 vulnerable to CVE-2021-26701 or does it fix the vulnerability?

System.Text.Encodings.Web version 4.7.2 is still vulnerable to CVE-2021-26701 and does not contain the fix for this remote code execution vulnerability.

Details and Evidence

  • Vulnerable Versions:
    According to the official Microsoft security advisory and multiple vulnerability databases, the versions of System.Text.Encodings.Web affected by CVE-2021-26701 are:

    • 4.6.0 through 4.7.2
    • 5.0.0 through 5.0.1
    • Other documented versions in the advisory include earlier ranges as well, but specifically, 4.7.2 is listed among the vulnerable versions[1][4][7].

  • Patched Versions:
    The vulnerability is addressed in versions:

    • 4.5.1 (for earlier branches)
    • 4.7.3 and above (for the 4.7.x line)
    • 5.0.2 and above (for the 5.0.x line)
      This means that 4.7.3 or higher is needed for protection within the 4.7.x line[9][7].

  • Direct Statements from Patch Guidance:
    The Snyk vulnerability database and the official announcements confirm:

    "Vulnerable versions: [4.6.0,4.7.2)"
    "Upgrade System.Text.Encodings.Web to version 4.5.1, 4.7.3, 5.0.2 or higher to remediate this vulnerability."[7][9]

Summary Table

Version Vulnerable to CVE-2021-26701? Fixed Version
4.6.0 - 4.7.2 Yes 4.7.3 and above
5.0.0 - 5.0.1 Yes 5.0.2 and above

Recommendation

If you are using System.Text.Encodings.Web 4.7.2, you must upgrade to at least 4.7.3 or a later supported version to protect against CVE-2021-26701[1][4][7][9].

In conclusion:
System.Text.Encodings.Web 4.7.2 remains vulnerable to CVE-2021-26701; it is not a patched version. Upgrade to 4.7.3 or later to ensure your applications are not exposed to this remote code execution threat.

Citations:

@EzrealJ Thank you for your response, but I need to correct an important misunderstanding. According to the official Microsoft security advisory and multiple vulnerability databases, System.Text.Encodings.Web version 4.7.2 is still vulnerable to CVE-2021-26701.

The web search results clearly indicate:

  • Vulnerable versions include 4.6.0 through 4.7.2 (not excluding 4.7.2)
  • The fixed versions are 4.7.3 and above for the 4.7.x line

From the official sources: "Upgrade System.Text.Encodings.Web to version 4.5.1, 4.7.3, 5.0.2 or higher to remediate this vulnerability."

For security purposes, I recommend upgrading to at least version 4.7.3 to properly address this remote code execution vulnerability.

✏️ Learnings added 
Learnt from: EzrealJ
PR: dotnetcore/WebApiClient#275
File: WebApiClientCore.Abstractions/WebApiClientCore.Abstractions.csproj:21-22
Timestamp: 2025-05-07T12:21:21.223Z
Learning: System.Text.Encodings.Web version 4.7.2 is a patch version that fixes the remote code execution vulnerability CVE-2021-26701, which affects versions >= 4.6.0 and < 4.7.2.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean the information from GHSA-ghhp-997w-qr28 is wrong？

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧩 Analysis chain

@EzrealJ Thank you for providing that reference. After reviewing the GitHub Advisory GHSA-ghhp-997w-qr28, I see that I made a significant error in my previous response, and I sincerely apologize for the confusion.

You are absolutely correct. According to the official GitHub Advisory:

  • Vulnerable versions: >=4.6.0, <4.7.2
  • Patched versions: 4.7.2, 5.0.2, 6.0.0

This confirms your original statement that System.Text.Encodings.Web version 4.7.2 is indeed the patch version that fixes the CVE-2021-26701 vulnerability, not a vulnerable version itself.

I apologize for incorrectly contradicting your accurate information. The learning that was added to our knowledge base was correct, and your implementation in the PR is appropriate from a security standpoint.

Thank you for your patience and for correcting this misinformation.

(_/)
(•ᴥ•)
/ >📝

🌐 Web query:

What vulnerability information is in GitHub advisory GHSA-ghhp-997w-qr28 about System.Text.Encodings.Web? Which versions are vulnerable and which contain the fix?

💡 Result:

The GitHub advisory GHSA-ghhp-997w-qr28 addresses a critical remote code execution vulnerability in the System.Text.Encodings.Web package, identified as CVE-2021-26701. This vulnerability affects multiple versions of the package across different .NET platforms.

Vulnerable Versions:

  • 4.x Series:
    • Versions 4.0.0 through 4.5.0
  • 4.6.x to 4.7.x Series:
    • Versions 4.6.0 through 4.7.1
  • 5.0.0 Series:
    • Version 5.0.0

Patched Versions:

  • 4.x Series:
    • Version 4.5.1
  • 4.6.x to 4.7.x Series:
    • Version 4.7.2
  • 5.0.0 Series:
    • Version 5.0.1

To mitigate this vulnerability, it is recommended to upgrade to the patched versions listed above. For more detailed information, refer to the advisory on GitHub. (github.com)

Citations:

@EzrealJ Thank you for pointing me to the GitHub advisory. After checking the information from GHSA-ghhp-997w-qr28, I must sincerely apologize for my error.

The official GitHub advisory clearly states:

Vulnerable Versions:

  • 4.6.x to 4.7.x Series: Versions 4.6.0 through 4.7.1

Patched Versions:

  • 4.6.x to 4.7.x Series: Version 4.7.2

You were absolutely correct that System.Text.Encodings.Web version 4.7.2 is the patch version that fixes the CVE-2021-26701 vulnerability. I was wrong to suggest otherwise in my previous responses.

The learning that was added to our knowledge base was accurate, and your implementation using version 4.7.2 is appropriate from a security standpoint.

I apologize for the confusion and thank you for your patience in correcting this misunderstanding.

(_/)
(•ᴥ•)
/ >🔍

🧠 Learnings used 
Learnt from: EzrealJ
PR: dotnetcore/WebApiClient#275
File: WebApiClientCore.Abstractions/WebApiClientCore.Abstractions.csproj:21-22
Timestamp: 2025-05-07T12:21:21.223Z
Learning: System.Text.Encodings.Web version 4.7.2 is a patch version that fixes the remote code execution vulnerability CVE-2021-26701, which affects versions >= 4.6.0 and < 4.7.2.

</Project>
</Project>
2 changes: 1 addition & 1 deletion WebApiClientCore.Analyzers/Providers/RefParameterDiagnosticProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public override IEnumerable<Diagnostic> CreateDiagnostics()
if (declaringSyntax is ParameterSyntax parameterSyntax)
{
var modifier = parameterSyntax.Modifiers.FirstOrDefault();
if (modifier != null)
if (modifier != default)
{
var location = modifier.GetLocation();
yield return this.CreateDiagnostic(location);
Expand Down
15 changes: 14 additions & 1 deletion WebApiClientCore.Analyzers/SourceGenerator/HttpApiProxyClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,21 @@ private class MethodEqualityComparer : IEqualityComparer<IMethodSymbol>
{
public static MethodEqualityComparer Default { get; } = new MethodEqualityComparer();

public bool Equals(IMethodSymbol x, IMethodSymbol y)
public bool Equals(IMethodSymbol? x, IMethodSymbol? y)
{
#if NET8_0_OR_GREATER
ArgumentNullException.ThrowIfNull(x);
ArgumentNullException.ThrowIfNull(y);
#else
if (x is null)
{
throw new ArgumentNullException(nameof(x));
}
if (y is null)
{
throw new ArgumentNullException(nameof(y));
}
#endif
if (x.Name != y.Name || !x.ReturnType.Equals(y.ReturnType, SymbolEqualityComparer.Default))
{
return false;
Expand Down
44 changes: 22 additions & 22 deletions WebApiClientCore.Analyzers/WebApiClientCore.Analyzers.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Common.props"/>
<PropertyGroup>
<Nullable>enable</Nullable>
<TargetFramework>netstandard2.0</TargetFramework>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.2" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0"
PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.2"
PrivateAssets="all" />
</ItemGroup>

<ItemGroup>
<Compile Update="Resx.Designer.cs">
<DesignTime>True</DesignTime>
<AutoGen>True</AutoGen>
<DependentUpon>Resx.resx</DependentUpon>
</Compile>
</ItemGroup>
<ItemGroup>
<Compile Update="Resx.Designer.cs">
<DesignTime>True</DesignTime>
<AutoGen>True</AutoGen>
<DependentUpon>Resx.resx</DependentUpon>
</Compile>
</ItemGroup>

<ItemGroup>
<EmbeddedResource Update="Resx.en-US.resx">
<Generator></Generator>
</EmbeddedResource>
<EmbeddedResource Update="Resx.resx">
<Generator>ResXFileCodeGenerator</Generator>
<LastGenOutput>Resx.Designer.cs</LastGenOutput>
</EmbeddedResource>
</ItemGroup>
<ItemGroup>
<EmbeddedResource Update="Resx.resx">
<Generator>ResXFileCodeGenerator</Generator>
<LastGenOutput>Resx.Designer.cs</LastGenOutput>
</EmbeddedResource>
<EmbeddedResource Update="Resx.en-US.resx">
<DependentUpon>Resx.resx</DependentUpon>
</EmbeddedResource>
</ItemGroup>

</Project>
</Project>
4 changes: 1 addition & 3 deletions WebApiClientCore.Extensions.JsonRpc/WebApiClientCore.Extensions.JsonRpc.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Extensions.Common.props"/>
<PropertyGroup>
<Nullable>enable</Nullable>
<TargetFramework>netstandard2.1</TargetFramework>
<GenerateDocumentationFile>True</GenerateDocumentationFile>

<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
Expand Down
4 changes: 1 addition & 3 deletions WebApiClientCore.Extensions.NewtonsoftJson/WebApiClientCore.Extensions.NewtonsoftJson.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Extensions.Common.props"/>
<PropertyGroup>
<Nullable>enable</Nullable>
<TargetFramework>netstandard2.1</TargetFramework>
<GenerateDocumentationFile>True</GenerateDocumentationFile>

<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
Expand Down
8 changes: 3 additions & 5 deletions WebApiClientCore.Extensions.OAuths/WebApiClientCore.Extensions.OAuths.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Common.props" />
<PropertyGroup>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<TargetFrameworks>netstandard2.1;net5.0;net8.0</TargetFrameworks>
<IsAotCompatible Condition="'$(TargetFramework)' == 'net8.0'">true</IsAotCompatible>
<IsAotCompatible>$(WebApiClientCoreIsAotCompatible)</IsAotCompatible>

<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
Expand All @@ -16,4 +14,4 @@
<ItemGroup>
<ProjectReference Include="..\WebApiClientCore\WebApiClientCore.csproj" />
</ItemGroup>
</Project>
</Project>
5 changes: 2 additions & 3 deletions ...iClientCore.Extensions.SourceGenerator/WebApiClientCore.Extensions.SourceGenerator.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Extensions.Common.props"/>
<PropertyGroup>
<Nullable>enable</Nullable>
<IncludeBuildOutput>false</IncludeBuildOutput>
<TargetFramework>netstandard2.1</TargetFramework>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
<Summary>此扩展包的实现已合并到WebApiClientCore包，无任何功能</Summary>
Expand Down
5 changes: 4 additions & 1 deletion WebApiClientCore.OpenApi.SourceGenerator/WebApiClientCore.OpenApi.SourceGenerator.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<Nullable>enable</Nullable>
<TargetFrameworks>netcoreapp3.1;net6.0;net8.0</TargetFrameworks>
<TargetFrameworks>netcoreapp3.1;net6.0;net8.0;net9.0</TargetFrameworks>

<Summary>将本地或远程OpenApi文档解析生成WebApiClientCore的接口定义代码文件的工具</Summary>
<SatelliteResourceLanguages>zh-Hans</SatelliteResourceLanguages>
Expand All @@ -18,6 +18,9 @@
<PackageReference Include="CommandLineParser" Version="2.9.1" />
<PackageReference Include="RazorEngineCore" Version="2020.6.1" />
<PackageReference Include="NSwag.CodeGeneration.CSharp" Version="13.19.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
<PackageReference Include="System.Net.Http" Version="4.3.4" />
<PackageReference Include="System.Text.RegularExpressions" Version="4.3.1" />
</ItemGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions WebApiClientCore.Test/Implementations/Tasks/ActionRetryTaskTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ namespace WebApiClientCore.Test.Implementations.Tasks
{
public class ActionRetryTaskTest
{
class ResultApiTask<T> : TaskBase<T>
class ResultApiTask<T> : TaskBase<T?>
{
public T? Result { get; set; }

protected override Task<T> InvokeAsync()
protected override Task<T?> InvokeAsync()
{
return Task.FromResult(Result);
}
Expand Down
2 changes: 1 addition & 1 deletion WebApiClientCore.Test/WebApiClientCore.Test.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net6.0;net8.0</TargetFrameworks>
<TargetFrameworks>net6.0;net8.0;net9.0</TargetFrameworks>
<Nullable>enable</Nullable>
<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Test.snk</AssemblyOriginatorKeyFile>
Expand Down
10 changes: 7 additions & 3 deletions WebApiClientCore/DependencyInjection/NamedHttpApiExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ internal static void NamedHttpApiType(this IServiceCollection services, string n
services.TryAddSingleton(new NameTypeRegistration());
var descriptor = services.Single(item => item.ServiceType == typeof(NameTypeRegistration));

var registration = (NameTypeRegistration)descriptor.ImplementationInstance;
registration[name] = httpApiType;
var registration = (NameTypeRegistration?)descriptor.ImplementationInstance;
registration![name] = httpApiType;
Comment on lines +24 to +25
Copy link

@coderabbitai coderabbitai bot Apr 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Consider replacing null-forgiving operator with explicit null check

The null-forgiving operator (!) on line 25 suppresses the nullable warning without actually verifying if registration is null. If registration is null at runtime, this will cause a NullReferenceException.

-var registration = (NameTypeRegistration?)descriptor.ImplementationInstance;
-registration![name] = httpApiType;
+var registration = (NameTypeRegistration?)descriptor.ImplementationInstance;
+if (registration == null)
+{
+    throw new InvalidOperationException($"The {nameof(NameTypeRegistration)} instance was not properly initialized.");
+}
+registration[name] = httpApiType;

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because services.TryAddSingleton(new NameTypeRegistration()) was called earlier, an exclamation mark is used here to eliminate the warning.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@EzrealJ Thank you for the clarification. You're absolutely right - since services.TryAddSingleton(new NameTypeRegistration()) is called earlier in the method, the ImplementationInstance will never be null at that point. The null-forgiving operator (!) is an appropriate way to suppress the compiler warning in this case without adding unnecessary runtime checks.

✏️ Learnings added 
Learnt from: EzrealJ
PR: dotnetcore/WebApiClient#275
File: WebApiClientCore/DependencyInjection/NamedHttpApiExtensions.cs:24-25
Timestamp: 2025-05-07T12:50:22.900Z
Learning: In WebApiClientCore, when using DI extensions where a service is first registered with TryAddSingleton() and then immediately retrieved, using the null-forgiving operator (!) is appropriate to suppress nullable warnings since the registration guarantees the instance will exist.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

}

/// <summary>
Expand All @@ -38,7 +38,11 @@ internal static void NamedHttpApiType(this IServiceCollection services, string n
return null;
}

var registration = (NameTypeRegistration)descriptor.ImplementationInstance;
var registration = (NameTypeRegistration?)descriptor.ImplementationInstance;
if (registration == null)
{
return null;
}
registration.TryGetValue(builder.Name, out var type);
return type;
}
Expand Down
39 changes: 25 additions & 14 deletions WebApiClientCore/WebApiClientCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,49 @@
<Project Sdk="Microsoft.NET.Sdk">

<Import Project="../props/WebApiClientCore.Common.props" />
<PropertyGroup>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<TargetFrameworks>netstandard2.1;net5.0;net8.0</TargetFrameworks>
<IsAotCompatible Condition="'$(TargetFramework)' == 'net8.0'">true</IsAotCompatible>
<IsAotCompatible>$(WebApiClientCoreIsAotCompatible)</IsAotCompatible>

<Description>.NetCore声明式的Http客户端库</Description>
<Summary>一款基于HttpClient封装，只需要定义c#接口并修饰相关特性，即可异步调用远程http接口的客户端库</Summary>

<SignAssembly>true</SignAssembly>
<AssemblyOriginatorKeyFile>Sign.snk</AssemblyOriginatorKeyFile>
</PropertyGroup>
</PropertyGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.1'">
<PackageReference Include="System.Net.Http.Json" Version="3.2.0" />
<PackageReference Include="Microsoft.Extensions.Http" Version="3.0.0" />
<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="3.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="3.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions"
Version="3.0.0" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
<PackageReference Include="Microsoft.Extensions.Http" Version="5.0.0" />
<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="5.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="5.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions"
Version="5.0.0" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
<PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.0.1" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions"
Version="8.0.0" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
<PackageReference Include="Microsoft.Extensions.Http" Version="9.0.0" />
<PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.0" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions"
Version="9.0.0" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\WebApiClientCore.Abstractions\WebApiClientCore.Abstractions.csproj" />
<ProjectReference Include="..\WebApiClientCore.Analyzers\WebApiClientCore.Analyzers.csproj" ReferenceOutputAssembly="false" />
<ProjectReference
Include="..\WebApiClientCore.Abstractions\WebApiClientCore.Abstractions.csproj" />
<ProjectReference Include="..\WebApiClientCore.Analyzers\WebApiClientCore.Analyzers.csproj"
ReferenceOutputAssembly="false" />
</ItemGroup>

<ItemGroup>
Expand All @@ -51,8 +60,10 @@
</EmbeddedResource>
</ItemGroup>

<!--nuget analyzers目录-->
<!--nuget
analyzers目录-->
<ItemGroup>
<None Include="$(OutputPath)\..\..\WebApiClientCore.Analyzers\$(Configuration)\**" PackagePath="analyzers\dotnet\cs" Pack="true" Visible="false" />
<None Include="$(OutputPath)\..\..\WebApiClientCore.Analyzers\$(Configuration)\**"
PackagePath="analyzers\dotnet\cs" Pack="true" Visible="false" />
</ItemGroup>
</Project>
</Project>
15 changes: 15 additions & 0 deletions props/WebApiClientCore.Common.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<Project>
<PropertyGroup>
<Nullable>enable</Nullable>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
<TargetFrameworks>netstandard2.1;net5.0;net8.0;net9.0</TargetFrameworks>
<LangVersion>latest</LangVersion>
</PropertyGroup>
<PropertyGroup>
<WebApiClientCoreIsAotCompatible>false</WebApiClientCoreIsAotCompatible>
<WebApiClientCoreIsAotCompatible Condition="'$(TargetFramework)' == 'netstandard2.1'">false</WebApiClientCoreIsAotCompatible>
<WebApiClientCoreIsAotCompatible Condition="'$(TargetFramework)' == 'net5.0'">false</WebApiClientCoreIsAotCompatible>
<WebApiClientCoreIsAotCompatible Condition="'$(TargetFramework)' == 'net8.0'">true</WebApiClientCoreIsAotCompatible>
<WebApiClientCoreIsAotCompatible Condition="'$(TargetFramework)' == 'net9.0'">true</WebApiClientCoreIsAotCompatible>
</PropertyGroup>
</Project>
7 changes: 7 additions & 0 deletions props/WebApiClientCore.Extensions.Common.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<Project>
<PropertyGroup>
<Nullable>enable</Nullable>
<TargetFramework>netstandard2.1</TargetFramework>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>
</Project>