[英]c# async await strange warning CS1998: This async method lacks 'await' operators
[英]Suppress warning CS1998: This async method lacks 'await'
我有一个接口,其中包含一些返回Task
函数。 一些实现接口的类没有任何等待,而其他类可能只是抛出 - 所以警告是虚假和烦人的。
是否可以抑制这些警告? 例如:
public async Task<object> test()
{
throw new NotImplementedException();
}
产量:
警告 CS1998:此异步方法缺少“await”运算符,将同步运行。 考虑使用 'await' 运算符来等待非阻塞 API 调用,或使用 'await Task.Run(...)' 在后台线程上执行 CPU 密集型工作。
我有一个带有一些异步功能的接口。
我相信返回Task
方法。 async
是一个实现细节,因此它不能应用于接口方法。
一些实现该接口的类没有任何等待,有些可能只是抛出。
在这些情况下,您可以利用async
是一个实现细节这一事实。
如果你没有什么可await
,那么你可以只返回Task.FromResult
:
public Task<int> Success() // note: no "async"
{
... // non-awaiting code
int result = ...;
return Task.FromResult(result);
}
在抛出NotImplementedException
的情况下,过程有点冗长:
public Task<int> Fail() // note: no "async"
{
var tcs = new TaskCompletionSource<int>();
tcs.SetException(new NotImplementedException());
return tcs.Task;
}
如果您有很多方法抛出NotImplementedException
(这本身可能表明一些设计级重构会很好),那么您可以将冗长的内容包装到一个辅助类中:
public static class TaskConstants<TResult>
{
static TaskConstants()
{
var tcs = new TaskCompletionSource<TResult>();
tcs.SetException(new NotImplementedException());
NotImplemented = tcs.Task;
}
public static Task<TResult> NotImplemented { get; private set; }
}
public Task<int> Fail() // note: no "async"
{
return TaskConstants<int>.NotImplemented;
}
helper 类还减少了 GC 否则必须收集的垃圾,因为具有相同返回类型的每个方法都可以共享其Task
和NotImplementedException
对象。
我的 AsyncEx 库中有其他几个“任务常量”类型示例。
另一种选择,如果您想保持函数体简单而不编写代码来支持它,只需使用 #pragma 抑制警告:
#pragma warning disable 1998
public async Task<object> Test()
{
throw new NotImplementedException();
}
#pragma warning restore 1998
如果这足够常见,您可以将禁用语句放在文件顶部并省略还原。
http://msdn.microsoft.com/en-us/library/441722ys(v=vs.110).aspx
保留 async 关键字(以防您想保留它)的另一种方法是使用:
public async Task StartAsync()
{
await Task.Yield();
}
填充该方法后,您可以简单地删除该语句。 我经常使用它,特别是当一个方法可能等待某些东西但不是每个实现实际上都这样做时。
解决方案之间存在差异,严格来说您应该知道调用者将如何调用异步方法,但默认使用模式假设方法结果为“ .Wait ()”——“ return Task.CompletedTask ”是最好的解决方案。
BenchmarkDotNet=v0.10.11, OS=Windows 10 Redstone 3 [1709, Fall Creators Update] (10.0.16299.192)
Processor=Intel Core i5-2500K CPU 3.30GHz (Sandy Bridge), ProcessorCount=4
Frequency=3233537 Hz, Resolution=309.2589 ns, Timer=TSC
.NET Core SDK=2.1.2
[Host] : .NET Core 2.0.3 (Framework 4.6.25815.02), 64bit RyuJIT
Clr : .NET Framework 4.7 (CLR 4.0.30319.42000), 64bit RyuJIT-v4.7.2600.0
Core : .NET Core 2.0.3 (Framework 4.6.25815.02), 64bit RyuJIT
Method | Job | Runtime | Mean | Error | StdDev | Median | Min | Max | Rank | Gen 0 | Gen 1 | Gen 2 | Allocated |
--------------- |----- |-------- |-------------:|------------:|------------:|-------------:|-------------:|-------------:|-----:|-------:|-------:|-------:|----------:|
CompletedAwait | Clr | Clr | 95.253 ns | 0.7491 ns | 0.6641 ns | 95.100 ns | 94.461 ns | 96.557 ns | 7 | 0.0075 | - | - | 24 B |
Completed | Clr | Clr | 12.036 ns | 0.0659 ns | 0.0617 ns | 12.026 ns | 11.931 ns | 12.154 ns | 2 | 0.0076 | - | - | 24 B |
Pragma | Clr | Clr | 87.868 ns | 0.3923 ns | 0.3670 ns | 87.789 ns | 87.336 ns | 88.683 ns | 6 | 0.0075 | - | - | 24 B |
FromResult | Clr | Clr | 107.009 ns | 0.6671 ns | 0.6240 ns | 107.009 ns | 106.204 ns | 108.247 ns | 8 | 0.0584 | - | - | 184 B |
Yield | Clr | Clr | 1,766.843 ns | 26.5216 ns | 24.8083 ns | 1,770.383 ns | 1,705.386 ns | 1,800.653 ns | 9 | 0.0877 | 0.0038 | 0.0019 | 320 B |
CompletedAwait | Core | Core | 37.201 ns | 0.1961 ns | 0.1739 ns | 37.227 ns | 36.970 ns | 37.559 ns | 4 | 0.0076 | - | - | 24 B |
Completed | Core | Core | 9.017 ns | 0.0690 ns | 0.0577 ns | 9.010 ns | 8.925 ns | 9.128 ns | 1 | 0.0076 | - | - | 24 B |
Pragma | Core | Core | 34.118 ns | 0.4576 ns | 0.4281 ns | 34.259 ns | 33.437 ns | 34.792 ns | 3 | 0.0076 | - | - | 24 B |
FromResult | Core | Core | 46.953 ns | 1.2728 ns | 1.1905 ns | 46.467 ns | 45.674 ns | 49.868 ns | 5 | 0.0533 | - | - | 168 B |
Yield | Core | Core | 2,480.980 ns | 199.4416 ns | 575.4347 ns | 2,291.978 ns | 1,810.644 ns | 4,085.196 ns | 10 | 0.0916 | - | - | 296 B |
注意:不能直接比较FromResult
。
测试代码:
[RankColumn, MinColumn, MaxColumn, StdDevColumn, MedianColumn]
[ClrJob, CoreJob]
[HtmlExporter, MarkdownExporter]
[MemoryDiagnoser]
public class BenchmarkAsyncNotAwaitInterface
{
string context = "text context";
[Benchmark]
public int CompletedAwait()
{
var t = new CompletedAwaitTest();
var a = t.DoAsync(context);
a.Wait();
return t.Length;
}
[Benchmark]
public int Completed()
{
var t = new CompletedTest();
var a = t.DoAsync(context);
a.Wait();
return t.Length;
}
[Benchmark]
public int Pragma()
{
var t = new PragmaTest();
var a = t.DoAsync(context);
a.Wait();
return t.Length;
}
[Benchmark]
public int Yield()
{
var t = new YieldTest();
var a = t.DoAsync(context);
a.Wait();
return t.Length;
}
[Benchmark]
public int FromResult()
{
var t = new FromResultTest();
var t2 = t.DoAsync(context);
return t2.Result;
}
public interface ITestInterface
{
int Length { get; }
Task DoAsync(string context);
}
class CompletedAwaitTest : ITestInterface
{
public int Length { get; private set; }
public async Task DoAsync(string context)
{
Length = context.Length;
await Task.CompletedTask;
}
}
class CompletedTest : ITestInterface
{
public int Length { get; private set; }
public Task DoAsync(string context)
{
Length = context.Length;
return Task.CompletedTask;
}
}
class PragmaTest : ITestInterface
{
public int Length { get; private set; }
#pragma warning disable 1998
public async Task DoAsync(string context)
{
Length = context.Length;
return;
}
#pragma warning restore 1998
}
class YieldTest : ITestInterface
{
public int Length { get; private set; }
public async Task DoAsync(string context)
{
Length = context.Length;
await Task.Yield();
}
}
public interface ITestInterface2
{
Task<int> DoAsync(string context);
}
class FromResultTest : ITestInterface2
{
public async Task<int> DoAsync(string context)
{
var i = context.Length;
return await Task.FromResult(i);
}
}
}
我知道这是一个旧线程,也许这不会对所有用法都产生正确的效果,但是以下内容与在我尚未实现方法时能够简单地抛出 NotImplementedException 一样接近,不改变方法签名。 如果它有问题,我很高兴知道它,但它对我来说几乎不重要:无论如何我只在开发时使用它,所以它的性能并不那么重要。 不过,我很高兴听到为什么这是一个坏主意,如果是的话。
public async Task<object> test()
{
throw await new AwaitableNotImplementedException<object>();
}
这是我添加的类型以使其成为可能。
public class AwaitableNotImplementedException<TResult> : NotImplementedException
{
public AwaitableNotImplementedException() { }
public AwaitableNotImplementedException(string message) : base(message) { }
// This method makes the constructor awaitable.
public TaskAwaiter<AwaitableNotImplementedException<TResult>> GetAwaiter()
{
throw this;
}
}
正如 Stephen's Answer 的更新一样,您不再需要编写TaskConstants
类,因为有一个新的帮助方法:
public Task ThrowException()
{
try
{
throw new NotImplementedException();
}
catch (Exception e)
{
return Task.FromException(e);
}
}
你可以试试这个:
public async Task<object> test()
{
await Task.CompletedTask;
}
如果您已经链接到 Reactive Extension,您还可以执行以下操作:
public async Task<object> NotImplemented()
{
await Observable.Throw(new NotImplementedException(), null as object).ToTask();
}
public async Task<object> SimpleResult()
{
await Observable.Return(myvalue).ToTask();
}
Reactive 和 async/await 本身和本身都很棒,但它们也能很好地协同工作。
需要的包括:
using System.Reactive.Linq;
using System.Reactive.Threading.Tasks;
下面的 cs1998 可能会发生这种情况。
public async Task<object> Foo()
{
return object;
}
那么你可以在下面进行改造。
public async Task<object> Foo()
{
var result = await Task.Run(() =>
{
return object;
});
return result;
}
试试这个:
[System.Diagnostics.CodeAnalysis.SuppressMessage("Await.Warning", "CS1998:Await.Warning")]
请参阅: https : //docs.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.suppressmessageattribute?view=netframework-4.7.2
如果您没有任何等待,则返回 Task.FromResult
public Task<int> Success() // note: no "async"
{
... // Do not have await code
var result = ...;
return Task.FromResult(result);
}
根据您的方法签名,这里有一些替代方案。
public async Task Test1()
{
await Task.CompletedTask;
}
public async Task<object> Test2()
{
return await Task.FromResult<object>(null);
}
public async Task<object> Test3()
{
return await Task.FromException<object>(new NotImplementedException());
}
首先,我找到了一个技巧来绕过此警告:
public async Task<object> test()
{
//a pseudo code just to disable the warning about lack of await in async code!
var xyz = true ? 0 : await Task.FromResult(0); //use a var name that's not used later
//... your code statements as normal, eg:
//throw new NotImplementedException();
}
这是一个伪代码,用于禁用asycn方法中有关缺少await
的警告! 该await关键字的存在会欺骗编译器不发出警告,即使我们知道它永远不会被调用! 由于条件为true
因此它总是返回三进制条件(?:)的第一部分,并且由于此var是不使用的var,因此在Release版本中将其省略。 我不确定这种方法是否有副作用。
另外,我发现在asp.net核心(TagHelper.cs)的源代码中使用了此简单方法,但是需要从方法签名行中删除async
关键字:
return Task.CompletedTask;
这是更完整的代码:
public abstract class TagHelper : ITagHelper, ITagHelperComponent
{
public virtual void Process(TagHelperContext context, TagHelperOutput output)
{
}
public virtual Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
{
Process(context, output);
return Task.CompletedTask; // *** this will avoid the lacks await warning!
}
}
全局配置/抑制它:
在 .editorconfig 中
# CS1998: Async method lacks 'await' operators and will run synchronously
dotnet_diagnostic.CS1998.severity = suggestion
在一个普通的、非高性能的应用程序中,不必要的异步的开销可以忽略不计,而对常规编码人员来说,全脑异步的好处更为重要。 (+ 额外的编译器检查等)
// This is to get rid of warning CS1998, please remove when implementing this method.
await new Task(() => { }).ConfigureAwait(false);
throw new NotImplementedException();
您可以从方法中删除 async 关键字并让它返回 Task;
public async Task DoTask()
{
State = TaskStates.InProgress;
await RunTimer();
}
public Task RunTimer()
{
return new Task(new Action(() =>
{
using (var t = new time.Timer(RequiredTime.Milliseconds))
{
t.Elapsed += ((x, y) => State = TaskStates.Completed);
t.Start();
}
}));
}
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.