ミドルウェアAPIのベストプラクティスは何ですか？

Question

C++とJavaの両方で、ゲーム開発者、アニメーションソフトウェア開発者、Avatar開発者などがライブラリ/ DLLとして使用して製品を強化するためのミドルウェアSDKを開発しています。

私が知りたいことは、次のとおりです。これらのタイプのAPIを開発するための標準的なベストプラクティスはありますか？

私は使いやすさ、読みやすさ、効率性などの面で考えています

Answer 1

あなたが解決しているかに応じて、APIを設計する方法はたくさんあります。私は、この質問に対する完全な答えが、gang of four patterns bookのような本全体にふさわしいと思います。 Javaの場合、一般的なOOプログラミングだけでも、私はEffecitve Java 2nd Editionをお勧めします。最初のものは一般的なもので、一般的なプログラミングパターン、適用時およびその利点がたくさんあります。効果的なJavaはJavaを中心としていますが、その一部はプログラミング言語に適用するのに十分一般的です。

Answer 2

Framework Design Guidelinesをご覧ください。私はそれが.NET固有であることを知っていますが、あなたはおそらくそれからも多くの一般的な情報を学ぶことができます。件名に

Answer 3

私の2つの好きな資源：http://mollyrocket.com/873とhttp://video.google.com/videoplay?docid=-3733345136856180693

Answer 4

YRPで言及したジョシュ・ブロッホからのビデオは古典的である - 私は2番目のものの推薦。

いくつかの一般的なガイドライン：

1. は主にインターフェース、工場、建設業者の面であなたのAPIを定義するようにしてください。
2. APIの一部であるパッケージとクラスを明確に指定します。
3. APIに対してコンパイルするために特に使用されるjarを提供してください。
4. 継承やテンプレートメソッドのパターンに大きく依存しないでください。時間がたつと壊れやすくなり、壊れてしまいます。
5. シングルトンパターンを使用しないでください。
6. パッケージとクラスレベルのjavadocを使って、使い方と概念を説明します。

   がDLLではなく静的ライブラリとしてライブラリを配布してください：私は、次の二つのことを学んできたWindows上でサードパーティのライブラリを使用してから、

Answer 5

。これにより、異なるcコンパイラとリンカ間の互換性が向上します。 Visual C++の静的ライブラリのもう1つの問題は、ランタイムライブラリを選択すると、異なるランタイムライブラリを使用してライブラリとコードが互換性がなくなり、ランタイムライブラリごとにライブラリの1つのバージョンを配布する必要が生じることです。

可能であれば、C++を避けてください。 C++の名前のマングリングは、異なるコンパイラによって大きく異なり、Visual C++用に構築されたライブラリは、Windowsの別のビルド環境からリンクすることはできません。それはCになると、特にdllのを使用する場合、物事ははるかに優れています。

実際にC++の優れた部分（コンストラクタやデストラクタによるリソース管理など）を取得したい場合は、C++の便利なレイヤーを構築して、c関数を隠すソースコードとして配布します。ユーザーはソースを持ち、それをローカルでコンパイルするので、ローカル環境には何の名前もないし、abiの問題もありません。

JavaからC/C++コードを呼び出すことについてあまり知らないと、名前の変更に関する問題のために、C++コードよりもCコードで作業する方が簡単だと思います。

"Imperfect C++"という本は、私が非常に参考にしたライブラリの互換性に関する議論をしています。