APIデザイン - オブジェクトまたはコレクションをパラメータとして使用しますか？

Question

次のデザインのどれがAPIにとってより良いと思われますか？その理由は何ですか？ MapWrapperを単にマップへの参照を含むクラスである

apiMethod(Map<A, B> aToB)

又は

apiMethod(MapWrapper<A, B> mapWrapper)。

両方のアプローチの賛否両論は何ですか？

Answer 1

あなたは常に「最小限の」APIに努めます。この場合

：あなたのAPIは、地図を渡すときに動作します - そして、もちろん、あなたがそのパスを選択します。なぜあなたのクライアントに負担をかけるラップその地図に？

オプション1のプロは - これはまっすぐ進むパスです。

オプション2は、APIの使用を難しくするという欠点があります。

つまり、の「プロパティ」の「プロパティ」が「マップ」になっている場合は、マップとして渡す必要があります。しかし、 "中心的なテーマ"が何か違うなら、あなたは他のテーマに合ったものを渡します。

Answer 2

私はそれはあなたのAPIが本当に必要ないものを理解することは非常に困難ですので、APIのパラメータとしてMapを使用することは悪い習慣だと思います。私はのような方法を発見したいくつかの古代のコードでは：

doSomeStuff(String aa, String bb){ 
    return aa + bb; 
} 

と、あなたはあなたのAPIを呼び出すためにaaとbbが必要であることを知っている：

doSomeStuff(Session session){ 
    String aa = session.get("aa"); 
    String bb = session.get("bb"); 
    return aa + bb; 
} 

このコードのリファクタリングになります。