最小驚きの原理（POLA）とインターフェース

四半世紀前に私がC ++を学んでいたとき、インターフェースは寛容であるべきだと教えられました。消費者は代わりにソースやドキュメントにアクセスできないかもしれないので、メソッドが呼び出される順番を気にしないでくださいこの。

しかし、私がジュニアプログラマーや上級開発者を指導したときはいつでも、彼らは驚いたことに反応し、これは本当にこれが本当のことなのか、それとも流行から外れたのかと疑問に思いました。

泥のように明確ですか？

これらのメソッド（データファイルを作成するための）とのインターフェイスを検討してください。

OpenFile
SetHeaderString
WriteDataLine
SetTrailerString
CloseFile

もちろん、これらを順番に実行することもできますが、ファイル名（考えてみてくださいa.out）や、含まれているヘッダーとトレーラーの文字列については気にしないと言って、単に呼び出すことができますAddDataLine。

それほど極端ではない例として、ヘッダーとトレーラーを省略する場合があります。

さらに、ファイルを開く前にヘッダーとトレーラーの文字列を設定することもできます。

これは認識されているインターフェイス設計の原則ですか、それとも名前が与えられる前のPOLAの方法ですか？

NBは、このインターフェイスの詳細に動揺することはありません。これは、この質問のための単なる例です。

最小限の驚きの原則に固執できる1つの方法は、ISPやSRP、またはDRYなどの他の原則を考慮することです。

あなたが与えた特定の例では、ファイルを操作するための順序付けに特定の依存関係があることが示唆されているようです。ただし、APIはファイルアクセスとデータ形式の両方を制御します。これは、SRPの違反に少し似ています。

編集/更新：また、APIを使用するたびに同じ手順を繰り返す必要があるため、API自体がDRYに違反するようユーザーに求めていることを示唆しています。

IO操作がデータ操作とは別の代替APIを検討してください。API自体が順序を「所有」している場合：

ContentBuilder

SetHeader( ... )
AddLine( ... )
SetTrailer ( ... )

FileWriter

Open(filename) 
Write(content) throws InvalidContentException
Close()

上記の分離により、ContentBuilderライン/ヘッダー/トレーラーを保存する以外に実際に何かを「行う」必要はありません（おそらくContentBuilder.Serialize()、順序を知っているメソッドでもあります）。他SOLID原則に従うことにより、あなたが前または行を追加した後、ヘッダーやトレーラーを設定するかどうか、それはもはや問題で何もするのでContentBuilder、実際にその渡されたまで、ファイルに書き込まれませんFileWriter.Write。

また、もう少し柔軟性が高いという利点もあります。たとえば、コンテンツを診断ロガーに書き出すことや、ファイルに直接書き込むのではなく、ネットワークを介して渡すことが役立つ場合があります。

APIを設計する際には、状態、戻り値、例外、コールバックなどのエラーレポートも考慮する必要があります。APIのユーザーは、おそらくプログラムの契約違反や、ファイルI / Oエラーなど制御できないその他のエラーをプログラムで検出できることを期待するでしょう。

これは、POLAだけでなく、バ​​グの原因となる可能性のある無効な状態を防ぐことでもあります。

具体的な実装を提供せずに、例にいくつかの制約を提供する方法を見てみましょう。

最初のステップ：ファイルを開く前に、何も呼び出さないでください。

CreateDataFileInterface
  + OpenFile(filename : string) : DataFileInterface

DataFileInterface
  + SetHeaderString(header : string) : void
  + WriteDataLine(data : string) : void
  + SetTrailerString(trailer : string) : void
  + Close() : void

これで、実際のデータを書き込むことができるインスタンスCreateDataFileInterface.OpenFileを取得するために呼び出す必要があることは明らかDataFileInterfaceです。

2番目のステップ：ヘッダーとトレーラーが常に設定されていることを確認してください。

CreateDataFileInterface
  + OpenFile(filename : string, header: string, trailer : string) : DataFileInterface

DataFileInterface
  + WriteDataLine(data : string) : void
  + Close() : void

ここで、DataFileInterfaceファイル名、ヘッダー、およびトレーラーを取得するために、必要なすべてのパラメーターを事前に提供する必要があります。すべての行が書き込まれるまでトレーラー文字列を使用できない場合は、このパラメーターをClose()（おそらくメソッドの名前を変更してWriteTrailerAndClose()）に移動して、少なくともトレーラー文字列なしでファイルを終了できないようにすることもできます。

コメントに返信するには：

インターフェースの分離が好きです。しかし、私はあなたの施行についての提案（例えばWriteTrailerAndClose（））がSRPの違反に迫っていると思う傾向があります。（これは私が何度も苦労してきたことですが、あなたの提案は可能性のある例のようです。）どのように対応しますか？

本当です。私が主張するのに必要以上に例に集中したくはありませんでしたが、それは良い質問です。この場合、私はそれを呼び出してFinalize(trailer)、それはあまり役に立たないと主張すると思います。トレーラーの作成と終了は、実装の詳細にすぎません。しかし、あなたが同意しないか、それとは異なる状況を持っている場合、考えられる解決策は次のとおりです。

CreateDataFileInterface
  + OpenFile(filename : string, header : string) : IncompleteDataFileInterface

IncompleteDataFileInterface
  + WriteDataLine(data : string) : void
  + FinalizeWithTrailer(trailer : string) : CompleteDataFileInterface

CompleteDataFileInterface
  + Close()

この例では実際にそれを行いませんが、結果としてテクニックを実行する方法を示しています。

ちなみに、たとえば、多くの行を順番に書き込むために、実際にはメソッドをこの順序で呼び出す必要があると想定しました。これが必要でない場合は、Ben Cottrelが示唆するように、常にビルダーを好むでしょう。