RAIIをファイルマーカーの終わりに書き込むには？

Question

私は、ライターが完了したことを示す明示的なメッセージをファイルに書きたいファイルフォーマットを作成しています。私は過去に、生成プログラムがクラッシュしたところでファイルを生成することで問題を抱えていました。明示的なマーカーがないと、ファイルを検出するためのプログラムを読む方法が不完全であるため、私は認識せずにファイルを切り捨てました。

私はこれらのファイルを書くために使用されるクラスを持っています。通常は、「オープン」操作と「クローズ」操作がRAIIを使用する場合は、デストラクタにファイルマーカーの終わりを書き込むコードを挿入します。このようにして、ユーザーは忘れることができません。しかし、例外がスローされて書き込みが完了しない状況では、デストラクタは引き続き実行されます。その場合、メッセージを書きたくないので、読者はファイルが不完全であることを知ることができます。

これは「コミット」操作がいつでも発生する可能性があります。 RAIIがコミットするのを忘れることはできないようにしたいが、例外が発生したときにコミットしたくない。ここの誘惑はstd :: uncaught_exceptionsを使うことですが、それはコードの匂いだと思います。

これに対する通常の解決方法は何ですか？人々が覚えていることだけを要求する私は、誰かが私のAPIを使用しようとするたびに、これが戸惑いになることに懸念しています。

Answer 1

この問題に取り組む1つの方法は、書き込みの最後に完全に埋められるだけのヘッダーを定義できる単純なフレーミングシステムを実装することです。ヘッダーをファイルの内容の検証に役立てるためにSHA256ハッシュを含めます。これは通常、ファイルの最後にバイトを読み込むよりもはるかに便利です。

いくつかのフィールドを意図的にゼロにしてヘッダーを書き出し、ペイロードの内容をハッシュ方法で入力しながら書き出し、ヘッダーに戻って最後に書き直します値。ファイルは明らかに無効な状態から始まり、すべてが完了するまで有効である場合、のみがになります。

実装の詳細を処理するストリームハンドルでこれをまとめてもかまいません。これは、呼び出しコードが通常のファイルを開くことに関する限りです。ヘッダーが不完全または無効な場合は、読み取りバージョンで例外がスローされます。

Answer 2

あなたのクラスのユーザーがファイルへの書き込みを完了したときに呼び出すcommitメソッドを追加すると、RAIIが正常に動作するようです。

class MyFileFormat { 
public: 
    MyFileFormat() : committed_(false) {} 
    ~MyFileFormat() { 
     if (committed_) { 
      // write the completion footer (I hope this doesn't throw!) 
     } 
     // close the underlying stream... 
    } 

    bool open(const std::string& path) { 
     committed_ = false; 
     // open the underlying stream... 
    } 

    bool commit() { 
     committed_ = true; 
    } 
}; 

責任は、彼らが完了したら、commitを呼び出すために使用者にありますが、少なくともあなたは、リソースが閉じられ得ることを確認することができます。

このような場合のより一般的なパターンについては、ScopeGuardsをご覧ください。

ScopeGuardは、クラスからのクリーンアップの責任を持ち、ScopeGuardが有効範囲外になり、明示的に破棄される前に破棄された場合に任意の "クリーンアップ"コールバックを指定するために使用できます。あなたのケースでは、失敗クリーンアップ（クローズファイルハンドルなど）と成功クリーンアップ（書き込み完了フッターとクローズファイルハンドルなど）の両方のコールバックをサポートするというアイディアを拡張することができます。

Answer 3

私は一時ファイルに書き込むことで、そのような状況を処理しました。ファイルに追加している場合でも、ファイルの一時的なコピーに追加してください。

デストラクタでは、std::uncaught_exception()をチェックして、テンポラリファイルを目的の場所に移動するかどうかを判断できます。