Net4x.DapperLibrary.Extensions.DependencyInjection 1.9.9.26263

DapperLibrary.Extensions.DependencyInjection

Dependency injection helpers and extensions for wiring up Dapper-based IDapperContext instances and the IDapperContextFactory in an application's DI container.

This small library provides extension methods to register Dapper context services and to load connection string settings from application configuration.

Features

• Registers the IDapperContextFactory as a singleton (uses DapperContextFactory.Instance).
• Registers an IDapperContext as a scoped service created via the factory.
• Reads connection strings from configuration sections:
  • ConnectionStrings � simple name ? connection string
  • ConnectionStringsWithProvider � each child can contain ConnectionString and ProviderName
• Supports controlling when connections are closed via the CloseConnection parameter.

Supported targets

This project is intended to be multi-targeted for older .NET Framework versions and modern .NET (the code contains compilation conditionals). Use the version appropriate for your application framework.

Installation

Add a project reference to DapperLibrary.Extensions.DependencyInjection or install the package (if published) into your project.

Usage

In .NET 8+ hosted apps

If you are using the new host builder (.NET 8+), call the host builder convenience method:

// Program.cs (top-level)
var builder = Host.CreateApplicationBuilder(args);

// registers DI and reads configuration
builder.UseDapperContext();

var app = builder.Build();

You can also pass a CloseConnection value to control how connections are closed:

builder.UseDapperContext(CloseConnection.WhenDataReaderCloses);

In other apps (IServiceCollection)

Call the extension on IServiceCollection and pass your application's IConfiguration (or ConfigurationManager where supported):

public void ConfigureServices(IServiceCollection services)
{
    services.UseDapperContext(Configuration);
}

Or with an explicit CloseConnection value:

services.UseDapperContext(Configuration, CloseConnection.WhenCommandCompletes);

Configuration

The extension loads connection strings from configuration. Two patterns are supported.

1. Simple connection strings (standard pattern):

"ConnectionStrings": {
  "DefaultConnection": "Server=.;Database=MyDb;Trusted_Connection=True;",
  "ReadOnly": "Server=.;Database=MyDb_Read;Trusted_Connection=True;"
}

2. Complex connection strings with provider name:

"ConnectionStringsWithProvider": {
  "OracleConn": {
    "ConnectionString": "Data Source=...;User Id=...;Password=...;",
    "ProviderName": "Oracle.ManagedDataAccess.Client"
  }
}

The library will enumerate both sections and build DapperConnectionStringSettings entries for each child.

API reference (key entry points)

• DapperContextExtension.UseDapperContext(this IServiceCollection services, IConfiguration configuration, CloseConnection closeConnection = CloseConnection.WhenDataReaderCloses)
• DapperContextExtension.UseDapperContext(this IHostApplicationBuilder builder, CloseConnection closeConnection = CloseConnection.WhenDataReaderCloses) (available on .NET 8+ builds)

These methods register:

• IDapperContextFactory as a singleton (backed by DapperContextFactory.Instance).
• IDapperContext as scoped, created via the factory and configured with the closeConnection behavior.

Notes

• The project relies on other library types such as DapperConnectionStringSettings, DapperConfigurationManager, IDapperContext, IDapperContextFactory and DapperContextFactory. Ensure those assemblies are available in the consuming solution.
• Conditional compilation in the source supports multiple target frameworks; the visible extension overloads vary depending on the target framework.

Contributing

Contributions are welcome via pull requests. Keep changes small and add tests where appropriate.

License

See the repository license file.