存储库是否应返回Task <SomeEntity> ？

Question

I'm designing a repository, but I have this doubt.

Should I design it to be blocking operations or async?

I tend to think that blocking is more elegant, since users can wrap calls to be async when needed with something like

Task.Run( () => repository.Get(...));

What do you think?

Answer 1

Since underlying data source is naturally asynchronous in most cases (web service, database, file), async API is a preferred way.

blocking is more elegant, since users can wrap calls to be async when needed

Actually, vice versa.
User ( not you !) can wrap async call into synchronous one, if needed:

Task<MyObj> DoSomethingAsync() { ... }
MyObj DoSomething()
{
     return DoSomethingAsync().Result;
}

while this:

Task.Run( () => repository.Get(...));

is called "async over sync" and must be avoided:

should we expose an asynchronous entry point for a method that's actually synchronous? The stance we've taken in .NET 4.5 with the Task-based Async Pattern is a staunch “no.”