Search code examples
c#polymorphismidisposable

Polymorphism when concrete types *might* be disposable


If a dependency container, or data access factory, can return types that may implement IDisposable, should it be the client's responsibility to check for that and handle it? In my code below, one data class implements IDisposable and the other doesn't. Either can be returned by the data access factory.

    private static void TestPolymorphismWithDisposable()
    {
        // Here we don't know if we're getting a type that implements IDisposable, so
        // if we just do this, then we won't be disposing of our instance.
        DataAccessFactory.Resolve().Invoke();

        // Do we just have to do something like this?
        IFoo foo = DataAccessFactory.Resolve();
        foo.Invoke();
        var fooAsDisposable = foo as IDisposable;
        if (fooAsDisposable != null) { fooAsDisposable.Dispose(); }
    }

The reason I ask is that this seems to place a burden on the client code to have to handle this, and how do you let clients know, when building an API, that they may need to call dispose? Is there a better way to handle this where the client doesn't have to check for IDisposable?

In the interest of a full working example, here are the other classes:

public interface IFoo
{
    void Invoke();
}

public class DataAccessBaseNotDisposable : IFoo
{
    public void Invoke()
    {
        Console.WriteLine("In Invoke() in DataAccessBaseNotDisposable.");
    }
}

public class DataAccessBaseDisposable : IFoo, IDisposable
{
    public void Invoke()
    {
        Console.WriteLine("Invoke() in DataAccessBaseDisposable.");
    }

    public void Dispose()
    {
        Console.WriteLine("In Dispose() in DataAccessBaseDisposable.");
    }
}

public static class DataAccessFactory
{
    public static IFoo Resolve()
    {
        return new DataAccessBaseDisposable();
        //return new DataAccessBaseNotDisposable();
    }
}

Solution

  • Edit: The best solution is to always return an IDisposable object, even if the object doesn't need to be disposed. That way, the framework user doesn't have to keep checking for IDisposable all the time.

    Your framework would look like this:

    public interface IFoo : IDisposable
    {
        void Invoke();
    }
    
    public class DataAccessBase : IFoo
    {
        public void Invoke()
        {
            Console.WriteLine("In Invoke() in DataAccessBase.");
        }
    
        public void Dispose()
        {
            Console.WriteLine("In Dispose() in DataAccessBase.");
        }
    }
    
    public static class DataAccessFactory
    {
        public static IFoo Resolve()
        {
            return new DataAccessBase();
        }
    }
    

    And it is consumed as you'd expect:

    private static void TestPolymorphismWithDisposable()
    {
        using(IFoo foo = DataAccessFactory.Resolve())
        {
            foo.Invoke();
        }
    }
    

    However, If you're a user and you're stuck with a result which may or may not implement IDisposable, you would need to consume it as follows:

    private static void TestPolymorphismWithDisposable()
    {
        IFoo foo = DataAccessFactory.Resolve();
    
        using(foo as IDisposable)
        {
            foo.Invoke(); //This is always executed regardless of whether IDisposable is implemented
    
            //Dispose is called if IDisposable was implemented
        }
    }
    

    See these questions: Using statement with a null object and Using 'as IDisposable' in a using block