キャッシングを管理するためにクラス内のSRPに違反しないようにする方法は？

注：コードサンプルはc＃で記述されていますが、それは問題ではありません。適切なものを見つけることができないため、c＃をタグとして配置しました。これはコード構造についてです。

Clean Codeを読んで、より良いプログラマーになろうとしています。

私はしばしば、単一の責任原則（クラスと関数は1つのことだけを行うべきです）、特に関数に従うことに苦労しています。たぶん私の問題は、「一つのこと」が明確に定義されていないことですが、それでも...

例：データベースにFluffiesのリストがあります。Fluffyが何であるかは気にしません。クラスに綿毛を回復させたい。ただし、綿毛はいくつかのロジックに従って変化する可能性があります。いくつかのロジックに応じて、このクラスはキャッシュからデータを返すか、データベースから最新のデータを取得します。毛羽立ちを管理していると言えますが、それは一つのことです。簡単にするために、ロードされたデータが1時間有効であり、それを再ロードする必要があるとしましょう。

class FluffiesManager
{
    private Fluffies m_Cache;
    private DateTime m_NextReload = DateTime.MinValue;
    // ...
    public Fluffies GetFluffies()
    {
        if (NeedsReload())
            LoadFluffies();

        return m_Cache;
    }

    private NeedsReload()
    {
        return (m_NextReload < DateTime.Now);
    }

    private void LoadFluffies()
    {
        GetFluffiesFromDb();
        UpdateNextLoad();
    }

    private void UpdateNextLoad()
    {
        m_NextReload = DatTime.Now + TimeSpan.FromHours(1);
    }
    // ...
}

GetFluffies()私には大丈夫そうです。ユーザーはいくつかの綿毛を要求し、それらを提供します。必要に応じてDBからそれらを回復しますが、それは綿毛を取得することの一部と考えることができます（もちろん、それはいくらか主観的です）。

NeedsReload()正しいようです。fluffiesをリロードする必要があるかどうかを確認します。UpdateNextLoadは問題ありません。次のリロードの時間を更新します。それは間違いなく一つのことです。

しかし、私は何LoadFluffies()が単一のものとして説明することはできないと感じています。データベースからデータを取得し、次のリロードをスケジュールしています。次のリロードの時間を計算することがデータ取得の一部であると主張するのは困難です。しかし、私はそれを行うためのより良い方法を見つけることができません（関数の名前を変更するLoadFluffiesAndScheduleNextLoad方が良いかもしれませんが、それは問題をより明白にします）。

SRPに従ってこのクラスを実際に作成するエレガントなソリューションはありますか？私はつまらないですか？

それとも、私のクラスが実際に1つのことだけを行っているわけではありませんか？

このクラスが実際に見かけほど些細なものであれば、SRPに違反することを心配する必要はありません。それでは、3行関数に1つのことを行う2行と、別のことを行う別の1行がある場合はどうでしょうか。はい、この些細な機能はSRPに違反しています。誰も気にしない？SRPの違反は、事態がより複雑になると問題になり始めます。

この特定のケースでのあなたの問題は、おそらく、クラスがあなたが私たちに示した数行よりも複雑であるという事実に起因しています。

具体的には、このクラスがキャッシュを管理するだけでなく、おそらくGetFluffiesFromDb()メソッドの実装も含むという事実に問題がある可能性が最も高いです。したがって、SRPの違反は、投稿したコードに示されているいくつかの簡単なメソッドではなく、クラスにあります。

そのため、この一般的なカテゴリに該当するすべての種類のケースをどのように処理するかについての提案があります。 Decorator Pattern。

/// Provides Fluffies.
interface FluffiesProvider
{
    Fluffies GetFluffies();
}

/// Implements FluffiesProvider using a database.
class DatabaseFluffiesProvider : FluffiesProvider
{
    public override Fluffies GetFluffies()
    {
        ... load fluffies from DB ...
        (the entire implementation of "GetFluffiesFromDb()" goes here.)
    }
}

/// Decorates FluffiesProvider to add caching.
class CachingFluffiesProvider : FluffiesProvider
{
    private FluffiesProvider decoree;
    private DateTime m_NextReload = DateTime.MinValue;
    private Fluffies m_Cache;

    public CachingFluffiesProvider( FluffiesProvider decoree )
    {
        Assert( decoree != null );
        this.decoree = decoree;
    }

    public override Fluffies GetFluffies()
    {
        if( DateTime.Now >= m_NextReload ) 
        {
             m_Cache = decoree.GetFluffies();
             m_NextReload = DatTime.Now + TimeSpan.FromHours(1);
        }
        return m_Cache;
    }
}

そして、次のように使用されます。

FluffiesProvider provider = new DatabaseFluffiesProvider();
provider = new CachingFluffiesProvider( provider );
...go ahead and use provider...

CachingFluffiesProvider.GetFluffies()時間のチェックと更新を行うコードを含めることを恐れないことに注意してください。これは簡単なことです。このメカニズムが行うことは、SRPを重要なシステム設計レベルで対処し、処理することです。小さな個別メソッドのレベルではなく、とにかく重要ではありません。

あなたのクラス自体は私には問題ないように見えますが、あなたはLoadFluffies()その名前が宣伝するとおりではありません。1つの簡単な解決策は、名前を変更し、明示的な再読み込みをGetFluffiesから適切な説明のある関数に移動することです。何かのようなもの

public Fluffies GetFluffies()
{
  MakeSureTheFluffyCacheIsUpToDate();
  return m_Cache;
}

private void MakeSureTheFluffyCacheIsUpToDate()
{
  if( !NeedsReload )
    return;
  GetFluffiesFromDb();
  SetNextReloadTime();
}

私にとってはきれいに見えます（また、Patrickが言っているように、他の小さなSRP従順な機能で構成されているため）、そして特に重要なこともあります。

あなたのクラスは一つのことをしていると思います。タイムアウトのあるデータキャッシュです。LoadFluffiesは、複数の場所から呼び出さない限り、無駄な抽象化のようです。LoadFluffiesから2行を取得し、GetFluffiesのNeedsReload条件に入れる方が良いと思います。これにより、GetFluffiesの実装がより明確になり、単一の目標、つまりデータベースからのデータのキャッシュ取得を達成するために単一の責任サブルーチンを構成しているため、クリーンなコードのままです。以下は、更新されたget fluffiesメソッドです。

public Fluffies GetFluffies()
{
    if (NeedsReload()) {
        GetFluffiesFromDb();
        UpdateNextLoad();
    }

    return m_Cache;
}

あなたの本能は正しいです。あなたのクラスは、小さいかもしれませんが、やりすぎです。時限更新キャッシュロジックを完全に汎用的なクラスに分離する必要があります。次に、Fluffiesを管理するためにそのクラスの特定のインスタンスを作成します。これは次のようなものです（コンパイルされていないため、作業コードは読者の演習として残されています）。

public class TimedRefreshCache<T> {
    T m_Value;
    DateTime m_NextLoadTime;
    Func<T> m_producer();
    public CacheManager(Func<T> T producer, Interval timeBetweenLoads) {
          m_nextLoadTime = INFINITE_PAST;
          m_producer = producer;
    }
    public T Value {
        get {
            if (m_NextLoadTime < DateTime.Now) {
                m_Value = m_Producer();
                m_NextLoadTime = ...;
            }
            return m_Value;
        }
    }
}

public class FluffyCache {
    private TimedRefreshCache m_Cache 
        = new TimedRefreshCache<Fluffy>(GetFluffiesFromDb, interval);
    private Fluffy GetFluffiesFromDb() { ... }
    public Fluffy Value { get { return m_Cache.Value; } }
}

追加の利点は、TimedRefreshCacheのテストが非常に簡単になったことです。

クラスは問題ありません。SRPは関数ではなくクラスに関するものであり、クラス全体が「データソース」から「Fluffies」を提供するため、内部実装は自由です。

cahingメカニズムを拡張したい場合は、データソースを監視するためのクラスを作成できます。

public class ModelWatcher
{

    private static Dictionary<Type, DateTime> LastUpdate;

    public static bool IsUpToDate(Type entityType, DateTime lastRead) {
        if (LastUpdate.ContainsKey(entityType)) {
            return lastRead >= LastUpdate[entityType];
        }
        return true;
    }

    //call this method whenever insert/update changed to any entity
    private void OnDataSourceChanged(Type changedEntityType) {
        //update Date & Time
        LastUpdate[changedEntityType] = DateTime.Now;
    }
}
public class FluffyManager
{
    private DateTime LastRead = DateTime.MinValue;

    private List<Fluffy> list;



    public List<Fluffy> GetFluffies() {

        //if first read or not uptodated
        if (list==null || !ModelWatcher.IsUpToDate(typeof(Fluffy),LastRead)) {
            list = ReadFluffies();
        }
        return list;
    }
    private List<Fluffy> ReadFluffies() { 
    //read code
    }
}