WebApi:使用IoC的每个动作请求DbSession,如何?

时间:2017-07-31 02:11:22

标签: c# asp.net-web-api inversion-of-control autofac structuremap

我们现有的数据库部署只有一个“主”和一个只读副本。使用ASP.NET的Web API2和IoC容器我想创建控制器操作,其属性(或缺少)指示将对该请求使用哪个数据库连接(请参阅下面的控制器和服务用法)...

public MyController :  ApiController
{
    public MyController(IService1 service1, IService2 service2) { ... }

    // this action just needs the read only connection
    // so no special attribute is present
    public Foo GetFoo(int id)
    {
        var foo = this.service1.GetFoo(id);
        this.service2.GetSubFoo(foo);
        return foo;
    }

    // This attribute indicates a readwrite db connection is needed
    [ReadWrteNeeded]
    public Foo PostFoo(Foo foo)
    {
        var newFoo = this.service1.CreateFoo(foo);
        return newFoo;
    }
}

public Service1 : IService1
{
    // The dbSession instance injected here will be
    // based off of the action invoked for this request
    public Service1(IDbSession dbSession) { ... }

    public Foo GetFoo(int id) 
    { 
        return this.dbSession.Query<Foo>(...);
    }

    public Foo CreateFoo(Foo newFoo)
    {
        this.dbSession.Insert<Foo>(newFoo);
        return newFoo;
    }
}

我知道如何设置我的IoC(结构图或Autofac)来处理每个请求的IDbSession实例。

但是,我不确定如何为匹配控制器操作的关键指标属性(或缺少指针属性)生成IDbSession实例的类型。我假设我需要创建一个ActionFilter来查找指示器属性,并使用该信息识别或创建正确类型的IDbSession(只读或读写)。但是,如何确保创建的IDbSession的生命周期由容器管理?您不会在运行时将实例注入容器,这将是愚蠢的。我知道过滤器在启动时创建一次(使它们成为单例),所以我不能将值注入Filter的ctor。

我考虑创建一个具有'CreateReadOnlyDbSession'和'CreateReadWriteDbSession'接口的IDbSessionFactory,但是我不需要IoC容器(及其框架)来创建实例,否则它无法管理其生命周期(call dispose)当http请求完成时。)

思考?

PS在开发过程中,我一直在为每个动作创建一个ReadWrite连接,但我真的想避免这个长期。我也可以将Services方法拆分为单独的只读和读写类,但我想避免这种情况,并将GetFoo和WriteFoo放在两个不同的Service实现中似乎有点不稳定。

更新

我开始使用Steven提出的制作DbSessionProxy的建议。这很有用,但我真的在寻找一个纯粹的IoC解决方案。必须使用HttpContext和/或(在我的情况下)Request.Properties对我来说感觉有点脏。所以,如果我不得不弄脏,我也可以一直走,对吗?

对于IoC,我使用了Structuremap和WebApi.Structuremap。后一个包为每个Http Request设置一个嵌套容器,它允许你注入当前的HttpRequestMessage到服务中(这很重要)。这就是我做的......

IoC Container Setup:

For<IDbSession>().Use(() => DbSession.ReadOnly()).Named("ReadOnly");
For<IDbSession>().Use(() => DbSession.ReadWrite()).Named("ReadWrite");
For<ISampleService>().Use<SampleService>();

DbAccessAttribute(ActionFilter):

public class DbAccessAttribute : ActionFilterAttribute
{
    private readonly DbSessionType dbType;

    public DbAccessAttribute(DbSessionType dbType)
    {
        this.dbType = dbType;
    }

    public override bool AllowMultiple => false;

    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        var container = (IContainer)actionContext.GetService<IContainer>();
        var dbSession = this.dbType == DbSessionType.ReadOnly ?
                container.GetInstance<IDbSession>("ReadOnly") :
                container.GetInstance<IDbSession>("ReadWrite");

        // if this is a ReadWrite HttpRequest start an Request long
        // database transaction
        if (this.dbType == DbSessionType.ReadWrite)
        {
            dbSession.Begin();
        }

        actionContext.Request.Properties["DbSession"] = dbSession;
    }

    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        var dbSession = (IDbSession)actionExecutedContext.Request.Properties["DbSession"];
        if (this.dbType == DbSessionType.ReadWrite)
        {
            // if we are responding with 'success' commit otherwise rollback
            if (actionExecutedContext.Response != null &&
                actionExecutedContext.Response.IsSuccessStatusCode &&
                actionExecutedContext.Exception == null)
            {
                dbSession.Commit();                    
            }
            else
            {
                dbSession.Rollback();
            }
        }
    }
}

更新了Service1:

public class Service1: IService1
{
    private readonly HttpRequestMessage request;
    private IDbSession dbSession;

    public SampleService(HttpRequestMessage request)
    {
        // WARNING: Never attempt to access request.Properties[Constants.RequestProperty.DbSession]
        // in the ctor, it won't be set yet.
        this.request = request;
    }

    private IDbSession Db => (IDbSession)request.Properties["DbSession"];

    public Foo GetFoo(int id) 
    { 
        return this.Db.Query<Foo>(...);
    }

    public Foo CreateFoo(Foo newFoo)
    {
        this.Db.Insert<Foo>(newFoo);
        return newFoo;
    }
}

1 个答案:

答案 0 :(得分:1)

  

我假设我需要创建一个ActionFilter来查找指示器属性,并使用该信息识别或创建正确类型的IDbSession(只读或读写)。

根据您当前的设计,我会说ActionFilter是可行的方法。但我确实认为不同的设计可以更好地为您服务,这是业务操作更多explicitly modelled behind a generic abstraction,因为在这种情况下您可以将属性放在业务操作中,并且当您明确地将读取操作与写入分开时操作(CQS / CQRS),你可能根本不需要这个属性。但我现在认为这超出了你的问题的范围,所以这意味着ActionFilter是你的最佳选择。

  

但是如何确保创建的IDbSession的生命周期由容器管理?

诀窍是让ActionFilter存储有关在请求全局值中使用哪个数据库的信息。这允许您为IDbSession创建一个代理实现,它可以在内部根据此设置在可读和可写实现之间切换。

例如:

public class ReadWriteSwitchableDbSessionProxy : IDbSession
{
    private readonly IDbSession reader;
    private readonly IDbSession writer;

    public ReadWriteSwitchableDbSessionProxy(
        IDbSession reader, IDbSession writer) { ... }

    // Session operations
    public IQueryable<T> Set<T>() => this.CurrentSession.Set<T>();

    private IDbSession CurrentSession
    {
        get
        {
            var write = (bool)HttpContext.Current.Items["WritableSession"];

            return write ? this.writer : this.reader;
        }
    }
}