在WebAPI中处置对象

时间:2018-09-19 14:27:30

标签: c# asp.net-web-api2 dbcontext

我将维护一个现有的API实现。当我查看代码时,发现对象处置存在一些问题。

以下是我的基本控制器,它是所有控制器的父控制器。

[LoggingFilter]
[System.Web.Http.Authorize]
public abstract class BaseV1Controller : ApiController
{
    private ModelFactoryV1 _modelFactoryV1;
    private MyDBContext __db;
    private MyLoggingService _loggingService;
    private int _customerId;

    protected string __IPAddress;
    protected ILogger __logger;
    protected const int PAGE_SIZE_NORMAL = 20;
    protected const int PAGE_SIZE_MEDIA = 2;
    // GET: Base
    protected string __loggingResourceName = "Undefined - base controller";
    private void InitLogger()
    {
       Log.Logger.ForContext<BaseV1Controller>();
    }

    protected MyDBContext _db
    {
        get { return __db; }
        set { __db = value; }
    }

    public BaseV1Controller()
    {
        IEnumerable<string> values;
        __db = new MyDBContext();
        _loggingService = new MyLoggingService ();
        InitLogger();
    }

    public BaseV1Controller(MyDBContext db)
    {
        __db = db;
        _loggingService = new MyLoggingService ();
        InitLogger();
    }

    protected override void Dispose(bool disposing)
    {
        base.Dispose(disposing);
        _loggingService = null;
    }

  }

我们没有在控制器中重写处理方法。在控制器中,我们正在调用Repository类来执行CRUD操作。

下面的示例实现;

控制器:

   [LoggingFilter]
    [ValidateModel]
    [Authorize]
    public class CustomersV1Controller : BaseV1Controller
    {
        IAsyncRepository<Customer> _repo = new CustomerAsyncRepository();
        public CustomersV1Controller() : base()
        {
            _repo = new CustomerAsyncRepository();
        }

        public CustomersV1Controller(IAsyncRepository<Customer> repo, MyDBContext db) : base(db)
        {
            __loggingResourceName = "Customer";
            _repo = repo;
        }

       //All Actions implemented here

    }

存储库接口和类:

    public interface IAsyncRepository<T>
    {

        Task<T> Add(T type);
        Task<T> Get(int Id);
        Task Update(T type);
    }

public class CustomerAsyncRepository : IAsyncRepository<Customer>
    {
        //saves the customer view models
        private MyDBContext _db { get; }

        public CustomerAsyncRepository(MyDBContext db)
        {
            this._db = db;
        }

        public CustomerAsyncRepository()
        {
            _db = new MyDBContext ();
        }

        public async Task<Customer> Add(Customer model)
        {
            //Add method implmementation
            return model;
        }

        public async Task<Customer> Get(int id)
        {
           //Implementation to return customer model
        }

        public async Task Update(Customer model)
        {
           //Implementation to update customer model
        }

    }

基于此,我有以下澄清

  1. 我认为我们应该在BaseV1Controller的dispose方法中包含_db.Dispose()。目前,我无法实现DI模式。请提出建议?
  2. 在存储库IDisposable中未实现。它是否正确?
  3. 还有其他改进吗?

1 个答案:

答案 0 :(得分:1)

是的,您应该将DbContext放置在基本控制器的Dipose方法中。否则,没人知道它需要处理。该请求可能最终会在请求完成后的某个时间完成,但是在此之前,基础数据库连接将保持打开状态并且不可用,这意味着您将更快地耗尽连接池。

为确保发生这种情况,您可能不希望将_db属性(应该重命名为Db,甚至更好的DataContext,因为.Net中的属性名称通常不以_开头)具有受保护的属性。二传手一个子类可能会更改属性的值,并且在那里的原始上下文会丢失而不会被丢弃。

关于存储库,规范是,如果类具有IDisposable字段,那么您也应该在该类中实现IDisposable。在这种情况下,我可能要做的就是将您的IAsyncRepository<T>更改为也需要实现IDisposable。然后,您的存储库实现应处理DbConext,而您的控制器将处理该存储库实例。在那种情况下,最好也不要让控制器保留对DbContext的任何引用,而只公开repo实例。

您可以在https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose?view=netframework-4.7.2

上了解有关如何正确实现IDisposable的更多信息。