Need help with Specification?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ardalis
461 Stars 95 Forks MIT License 250 Commits 12 Opened issues

Description

Base class with tests for adding specifications to a DDD model

Services available

!
?

Need anything else?

Contributors list

# 1,002
C#
.NET
Xamarin
asp-net...
140 commits
# 61,561
C#
.NET
guard
HTML
42 commits
# 2,301
C#
HTML
ddd-arc...
softwar...
4 commits
# 139,945
c-sharp
.NET
experim...
circuit...
4 commits
# 62,707
.NET
oauth2
C#
HTML
3 commits
# 107,745
C#
HTML
.NET
Angular
2 commits
# 279,336
C#
windows...
xamarin...
xamarin...
1 commit
# 13,990
C#
HTML
ddd-sam...
softwar...
1 commit

NuGetNuGet Actions Status Generic badge

Follow @ardalis   Follow @fiseni   Follow @nimblepros

Stars Sparkline

Specification

Base class with tests for adding specifications to a DDD model. Currently used in Microsoft reference application eShopOnWeb, which is the best place to see it in action. Check out Steve "ardalis" Smith's associated (free!) eBook, Architecting Modern Web Applications with ASP.NET Core and Azure, as well.

Read the Docs on GitHub Pages

🎥 Watch What's New in v5 of Ardalis.Specification

🎥 Watch an Overview of the Pattern and this Package

Give a Star! :star:

If you like or are using this project please give it a star. Thanks!

Sample Usage

The Specification pattern pulls query-specific logic out of other places in the application where it currently exists. For applications with minimal abstraction that use EF Core directly, the specification will eliminate

Where
,
Include
,
Select
and similar expressions from almost all places where they're being used. In applications that abstract database query logic behind a
Repository
abstraction, the specification will typically eliminate the need for many custom
Repository
implementation classes as well as custom query methods on
Repository
implementations. Instead of many different ways to filter and shape data using various methods, the same capability is achieved with few core methods.

Example implementation in your repository using specifications

public async Task> ListAsync(ISpecification specification, CancellationToken cancellationToken = default)
{
    return await ApplySpecification(specification).ToListAsync(cancellationToken);
}

private IQueryable ApplySpecification(ISpecification specification) { return SpecificationEvaluator.Default.GetQuery(dbContext.Set().AsQueryable(), specification); }

Now to use this method, the calling code simply instantiates and passes the appropriate specification.

var spec = new CustomerByNameSpec("customerName");
var customers = await _repository.ListAsync(spec, cancellationToken);

Specifications should be defined in an easily-discovered location in the application, so developers can easily reuse them. The use of this pattern helps to eliminate many commonly duplicated lambda expressions in applications, reducing bugs associated with this duplication.

We're shipping a built-in repository implementation RepositoryBase, ready to be consumed in your apps. You can use it as a reference and create your own custom repository implementation.

Running the tests

This project needs a database to test, since a lot of the tests validate that a specification is translated from LINQ to SQL by EF Core. To run the tests, we're using docker containers, including a docker-hosted SQL Server instance. You run the tests by simply running

RunTests.bat
or
RunTests.sh
.

Reference

Some free video streams in which this package has been developed and discussed on YouTube.com/ardalis.

Pluralsight resources:

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.