Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pimbrouwers/lunchpail
.NET Standard Unit of Work implementation for ADO.NET
https://github.com/pimbrouwers/lunchpail
ado ado-net ioc-container repository-pattern unit-of-work
Last synced: 2 months ago
JSON representation
.NET Standard Unit of Work implementation for ADO.NET
- Host: GitHub
- URL: https://github.com/pimbrouwers/lunchpail
- Owner: pimbrouwers
- License: gpl-3.0
- Created: 2018-07-26T19:13:27.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-15T23:54:16.000Z (about 2 years ago)
- Last Synced: 2024-10-07T07:48:18.191Z (3 months ago)
- Topics: ado, ado-net, ioc-container, repository-pattern, unit-of-work
- Language: C#
- Homepage:
- Size: 43.9 KB
- Stars: 36
- Watchers: 5
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LunchPail
[LunchPail](https://github.com/pimbrouwers/LunchPail) is a .NET Standard compliant Unit of Work implementation for ADO.NET. The UoW is the workhorse of the data context, so the project was dubbed "lunch pail" as a reference to blue collar athletes.
[](https://www.nuget.org/packages/LunchPail)
[](https://travis-ci.org/pimbrouwers/LunchPail)
## Getting Started
1. Register the context within your IoC container (.NET Core shown below using SQL Server):
```c#
//startup.cs
public void ConfigureServices(IServiceCollection services)
{
//rest of code...
//context
services.AddTransient(options =>
{
var builder = new SqlConnectionStringBuilder(Configuration.GetConnectionString("DefaultConnection"));
return new DbConnectionFactory(() =>
{
var conn = new SqlConnection(builder.ConnectionString);
conn.Open();
return conn;
});
});
services.AddScoped();
//repositories (we'll add this later)
}
```
2. Create a domain class to represents your database object.
```c#
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
}
```
3. Create a repository with a dependency on `IDbContext`
```c#
public interface IProductRepository
{
Task Read (int id);
}
public class ProductRepository : DbRepository
{
public ProductRepository(IDbContext dbContext) : base(dbContext) { }
public Product Read(int id)
{
return Connection.QuerySingleOrDefault("select * from dbo.Product where Id = @id", new { id }, transaction: Transaction);
}
}
```
4. Register the repository with your IoC container (.NET Core shown below):
```c#
//startup.cs
public void ConfigureServices(IServiceCollection services)
{
//repositories
services.AddScoped();
}
```
5. With the context and repository registered, you're free to inject this into your controller or service layer.
> Note the invocation of `dbContext.Commit()` which _must_ occur after every interaction is complete to ensure proper disposal of the connection. This is true whether the interaction is a read or write.
```c#
public class ProductService
{
private readonly IDbContext dbContext;
private readonly IProductRepository productRepository;
public ProductService (
IDbContext dbContext,
IProductRepository productRepository)
{
this.dbContext = dbContext;
this.productRepository = productRepository;
}
public Product Read(int id)
{
var product = productRepository.Read(id);
dbContext.Commit(); // You MUST call commit after all interactions
return product;
}
}
```
Built with ♥ by [Pim Brouwers](https://github.com/pimbrouwers) in Toronto, ON.