DI Integration

The SmartSql.DIExtension package provides seamless integration with the ASP.NET Core dependency injection container. It registers SmartSqlBuilder, ISqlMapper, IDbSessionFactory, and dynamic repository proxies as singleton services, so your controllers and services can receive them through constructor injection without manual wiring.

At a Glance

Feature	Description
Package	SmartSql.DIExtension
Entry Point	services.AddSmartSql()
Instance Lookup	By Alias (default: "SmartSql")
Repository Registration	Single AddRepository<T>() or assembly scan via AddRepositoryFromAssembly()
Auto Config Resolution	Resolves SmartSqlMapConfig.xml or environment-specific variant
Required Framework	ASP.NET Core 2.0+ / Microsoft.Extensions.DependencyInjection

Registration Flow

When services.AddSmartSql() is called, the following sequence occurs:

sequenceDiagram
autonumber
    participant App as Startup.ConfigureServices
    participant DI as IServiceCollection
    participant Builder as SmartSqlBuilder
    participant Config as XML Config
    participant Container as IServiceProvider

    App->>DI: services.AddSmartSql("alias")
    DI->>DI: Register SmartSqlBuilder singleton factory
    DI->>DI: Register IDbSessionFactory singleton
    DI->>DI: Register ISqlMapper singleton
    DI->>DI: Register ITransaction singleton
    DI->>DI: Register IDbSessionStore singleton
    DI-->>App: SmartSqlDIBuilder

    App->>DI: .AddRepositoryFromAssembly(options)
    DI->>DI: Register IRepositoryBuilder singleton
    DI->>DI: Register IRepositoryFactory singleton
    DI->>DI: Scan assembly for interfaces
    loop Each repository interface
        DI->>DI: Register interface as singleton factory
    end

    Note over Container: App starts, DI resolves singletons
    Container->>Builder: Build()
    Builder->>Config: Parse SmartSqlMapConfig.xml
    Builder->>Builder: Initialize middleware pipeline
    Builder->>Builder: Register in SmartSqlContainer

Service Registration Details

The AddSmartSql() extension method registers these core services as singletons:

Service Type	Resolution
SmartSqlBuilder	Factory lambda, built once, shared
ISqlMapper	builder.SqlMapper
IDbSessionFactory	builder.DbSessionFactory
ITransaction	builder.SqlMapper (same instance)
IDbSessionStore	builder.SmartSqlConfig.SessionStore

classDiagram
    class SmartSqlDIBuilder {
        +IServiceCollection Services
    }

    class SmartSqlDIExtensions {
        <<static>>
        +AddSmartSql(services, alias) SmartSqlDIBuilder
        +AddSmartSql(services, setup) SmartSqlDIBuilder
    }

    class SmartSqlExtensions {
        <<static>>
        +GetSmartSql(sp, alias) SmartSqlBuilder
        +EnsureSmartSql(sp, alias) SmartSqlBuilder
        +GetSqlMapper(sp, alias) ISqlMapper
        +GetSessionFactory(sp, alias) IDbSessionFactory
        +GetSessionStore(sp, alias) IDbSessionStore
        +GetTransaction(sp, alias) ITransaction
    }

    class DyRepositoryExtensions {
        <<static>>
        +AddRepositoryFactory(builder, template, namingConvert) SmartSqlDIBuilder
        +AddRepository~T~(builder, alias, scope) SmartSqlDIBuilder
        +AddRepositoryFromAssembly(builder, setupOptions) SmartSqlDIBuilder
    }

    SmartSqlDIExtensions --> SmartSqlDIBuilder : creates
    DyRepositoryExtensions --> SmartSqlDIBuilder : extends
    SmartSqlExtensions --> SmartSqlBuilder : resolves

    style SmartSqlDIBuilder fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SmartSqlDIExtensions fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SmartSqlExtensions fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DyRepositoryExtensions fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Named Instance Support

SmartSql supports multiple named instances, each identified by an Alias. This is useful when your application connects to multiple databases:

// Register first instance (default alias "SmartSql")
services.AddSmartSql("MasterDb");

// Register second instance
services.AddSmartSql("SlaveDb");

// Resolve by alias
var masterMapper = sp.GetSqlMapper("MasterDb");
var slaveMapper = sp.GetSqlMapper("SlaveDb");

Repository Registration

Register a Single Repository

services.AddSmartSql("MyDb")
    .AddRepository<IUserRepository>("MyDb");

Register All Repositories from an Assembly

The AddRepositoryFromAssembly method scans assemblies for interfaces and registers them as dynamic repository singletons:

sequenceDiagram
autonumber
    participant DI as AddRepositoryFromAssembly
    participant Scanner as TypeScan
    participant Parser as ScopeTemplateParser
    participant Factory as IRepositoryFactory

    DI->>DI: Create AssemblyAutoRegisterOptions
    DI->>DI: Set Filter (type => type.IsInterface)
    DI->>Scanner: Scan(options)
    Scanner-->>DI: IEnumerable~Type~

    loop Each discovered interface
        DI->>DI: Register singleton factory lambda
        Note over DI: On first resolution:
        DI->>Factory: CreateInstance(type, sqlMapper, scope)
        Factory->>Factory: Check cache (miss)
        Factory->>Factory: repositoryBuilder.Build(type, config)
        Factory->>Factory: ObjectFactoryBuilder.CreateFactory
        Factory-->>DI: Return cached instance
    end

The AssemblyAutoRegisterOptions class controls scanning behavior:

Property	Type	Default	Description
SmartSqlAlias	string	"SmartSql"	Which SmartSql instance to bind to
ScopeTemplate	string	"I{Scope}Repository"	Template to extract scope from type name
AssemblyString	string	--	Assembly name to scan
Filter	Func<Type, bool>	type.IsInterface	Additional type filter

Auto Config Path Resolution

When no explicit configuration is provided, AddSmartSql() auto-resolves the XML config path:

flowchart TD
    subgraph ConfigPath["Config Path Resolution"]
        style ConfigPath fill:#161b22,stroke:#30363d,color:#e6edf3
        A["No ConfigBuilder set"] --> B{"ASPNETCORE_ENVIRONMENT<br>set and != Production?"}
        B -->|Yes| C["Try SmartSqlMapConfig.{env}.xml"]
        C --> D{"File exists?"}
        D -->|Yes| E["Use environment-specific config"]
        D -->|No| F["Use SmartSqlMapConfig.xml"]
        B -->|No| F
    end

    style A fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style B fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style C fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style D fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style E fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style F fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

Complete Example

From the sample ASP.NET Core application:

public class Startup
{
    public IServiceProvider ConfigureServices(IServiceCollection services)
    {
        services.AddControllers();
        services
            .AddSmartSql((sp, builder) =>
            {
                builder.UseProperties(Configuration);
            })
            .AddRepositoryFromAssembly(o =>
            {
                o.AssemblyString = "SmartSql.Sample.AspNetCore";
                o.Filter = (type) =>
                    type.Namespace == "SmartSql.Sample.AspNetCore.DyRepositories";
            });

        services.AddSingleton<UserService>();
        return services.BuildAspectInjectorProvider();
    }
}

API Reference

SmartSqlDIExtensions

Method	Return	Description
AddSmartSql(services, alias)	SmartSqlDIBuilder	Register with default config path
AddSmartSql(services, setup)	SmartSqlDIBuilder	Register with custom builder configuration
AddSmartSql(services, Func<ISP, SmartSqlBuilder>)	SmartSqlDIBuilder	Register with full factory control

DyRepositoryExtensions

Method	Return	Description
AddRepositoryFactory(builder)	SmartSqlDIBuilder	Register IRepositoryBuilder and IRepositoryFactory
AddRepository<T>(builder, alias, scope)	SmartSqlDIBuilder	Register a single repository interface
AddRepositoryFromAssembly(builder, options)	SmartSqlDIBuilder	Bulk-register repositories from assembly scan

SmartSqlExtensions

Method	Return	Description
GetSmartSql(sp, alias)	SmartSqlBuilder	Resolve by alias (nullable)
EnsureSmartSql(sp, alias)	SmartSqlBuilder	Resolve by alias (throws if missing)
GetSqlMapper(sp, alias)	ISqlMapper	Get mapper for alias
GetSessionFactory(sp, alias)	IDbSessionFactory	Get session factory for alias
GetSessionStore(sp, alias)	IDbSessionStore	Get session store for alias

Cross-References

• Dynamic Repository -- Details on how the generated proxies work internally.
• Options Pattern -- Use IOptions<SmartSqlConfigOptions> instead of XML config.
• AOP Transactions -- Add [Transaction] to service methods via AspectCore integration.
• InvokeSync -- Register message queue publishers/subscribers alongside SmartSql.

References

• SmartSqlDIExtensions.cs -- Core DI registration
• DyRepositoryExtensions.cs -- Repository DI registration
• SmartSqlDIBuilder.cs -- Fluent builder returned by AddSmartSql
• SmartSqlExtensions.cs -- Service resolution helpers
• AssemblyAutoRegisterOptions.cs -- Assembly scanning options
• SmartSqlBuilderExtensions.cs -- IConfiguration integration
• Startup.cs -- Full sample application