インターフェイスのカプセル化。 C ++のAPIを便利で理解しやすくします

かつて、C ++ Academyの見出しのHacker誌に一連の記事を執筆し、C ++を使用する興味深い可能性について説明しました。 サイクルはもう終わりましたが、彼らはまだ最初の記事からの動的型付けエミュレーションがどのように機能するかをしばしば私に尋ねます。 事実、サイクルを始めたとき、何が必要で何が必要でないかを正確に知りませんでした。また、説明で必要な多くの事実を見逃していました。 無駄だ！ トレーニング資料に余分なものはありません。 今日は、最も一般的なC ++（クラス、メソッド、およびデータ）の観点から、美しい高レベルAPIがどのように取得されるかを詳細に説明します。

それは何のためですか？

原則として、高速なものはC ++で記述されていますが、常に使いやすいとは限りません。 製品の開発プロセスでは、製品エンティティを操作するための非常に不十分に設計されたインターフェイスを持つ一般的な機能が強調表示されます。 C ++言語は、コードを乗算およ​​び複雑化し、あらゆる種類の「スマート」ポインターでラップし、そのような構造にアクセスするためのキロメートル線を生成する基本クラスへのポインターとリンクを強く推奨します。

同意して、これを使用することはほとんど便利ではありません：

std::unordered_map<std::string, std::vector< std::shared_ptr<base_class>>>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

特に、ベクターの各要素に対して後続クラスの操作が必要な場合、つまり、メソッドは上記のbase_classに含まれません。 コンストラクトでbase_classが少し上にありませんか？ そして、私が話していたこと！

使いやすくするために、基本クラスを使用することは、それを使用する本質を分離し、クラスデータへの単純なポインターとしてインターフェイスをカプセル化する最も簡単な方法です。

基本クラスインターフェイス

ストーリーをできるだけ単純化するために、多くの例がありますが、コードからそれほど遠くありません。 コード自体は記事に添付され、ここでは誰もそれを失うことはありません。 そこで、基本クラスをデータオブジェクトとして設計することを提案します。可能な限り単純化しましょう。

 class object { public: object(); //     ,  null virtual ~object(); //    unique_ptr //  object(const object& another); object& operator = (const object& another); //   null bool is_null() const; //      class data; //     const data* get_data() const; //     const char* data_class() const; protected: //    object(data* new_data); void reset(data* new_data); //       void assert_not_null(const char* file, int line) const; private: //    std::unique_ptr<data> m_data; };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

以前に基本クラスへのインターフェイスとして使用していたものは、オブジェクト::データに変わります-これは、他のどこにも表示されない最も重要なクラスです。

実際、objectおよびobject :: dataには、base_classが設定された基本操作が存在する必要があります。 しかし、説明ではそれらは必要ありません。それなしでは、多くの興味深いことがあります。

最小限の形式では、オブジェクトのデータクラスはどこにも単純ではありません。

 class object::data { public: //      virtual data* clone() const = 0; //     virtual const char* class_name() const = 0; };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

基本クラスで本当に必要な唯一のメソッドは、対応する相続人のデータを複製することです。 さらに、ご覧のとおり、インターフェイスクラスはclone（）メソッドがなくても問題ありません。オブジェクト自体とそのすべての子孫は通常のコピーコンストラクターを使用します。 ここで、最も重要なことに注目します-カプセル化された基本クラスからの継承です。

二重継承

相続人のために、エンティティのペアを選択する必要があります。 宇宙船と小惑星を持つコンピューターゲームを開発しましょう。 したがって、動作するには2組のクラスが必要です。小惑星と宇宙船です。

相続人をユニークな方法でクラスに追加しましょう：小惑星は整数識別子で異なり、宇宙船はユニークな名前で識別されます：

 class asteroid : public object { public: //       asteroid(int identifier); //   asteroid(const asteroid& another); asteroid& operator = (const asteroid& another); //     "" asteroid(const object& another); asteroid& operator = (const object& another); //   - int get_identifier() const; //    class data; private: //     (!)   data* m_data; }; class spaceship : public object { public: //      spaceship(const char* name); //    spaceship(const spaceship& another); spaceship& operator = (const spaceship& another); //     "" spaceship(const object& another); spaceship& operator = (const object& another); //    " " const char* get_name() const; //    class data; private: //    (!)    data* m_data; };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

オブジェクトの祖先がコンテナの役割を果たしているという事実にもかかわらず、子孫にはオブジェクトのコンテンツへのリンクがありますが、目的のタイプであることに注意してください。 メインクラスの継承もデータクラスに複製する必要があります（以下に、これが必要な理由を示します）。

 class asteroid::data : public object::data { public: //       data(int identifier); //       int get_identifier() const; //     ! virtual object::data* clone() const override; //       virtual const char* class_name() const override; private: //   asteroid     int m_identifier; }; class spaceship::data : public object::data { public: //  ,        data(const char* name); //       spaceship::data const char* get_name() const; //     ! virtual object::data* clone() const override; //      virtual const char* class_name() const override; private: //       #include <string> std::string m_name; };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

次に、実装についてもう少し説明します。すべてがすぐに実行されます。

メソッドの実装

デフォルトのコンストラクターによってオブジェクト型のインスタンスを直接作成すると、null値を持つオブジェクトが作成されます。

 object::object() { } object::~object() { } object::object(object::data* new_data) : m_data(new_data) { } object::object(const object& another) : m_data(another.is_null() ? nullptr : another.m_data->clone()) { } object& object::operator = (const object& another) { m_data.reset(another.is_null() ? nullptr : another.m_data->clone()); return *this; } bool object::is_null() const { return !m_data; } const object::data* object::get_data() const { return m_data.get(); } const char* object::data_class() const { return is_null() ? "null" : m_data->class_name(); } void object::reset(object::data* new_data) { m_data.reset(new_data); } void object::assert_not_null(const char* file, int line) const { if (is_null()) { std::stringstream output; output << "Assert 'object is not null' failed at file: '" << file << "' line: " << line; throw std::runtime_error(output.str()); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで最も重要なことは、派生クラスのインスタンスがどのように初期化されるかです。

 asteroid::asteroid(int identifier) : object(m_data = new asteroid::data(identifier)) { } spaceship::spaceship(const char* name) : object(m_data = new spaceship::data(name)) { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これらの数行からわかるように、フェーズブラスターの1つのひと口で、ノウサギの群れだけをすぐに殺します。

1. 通常のコンストラクターによる特別なコンテナークラスのデータへの参照を使用して、相続人を作成します。
2. コンテナクラスは他のすべての基底クラスでもあり、インターフェイスを格納するすべての基本的な作業は基底クラスで行われます。
3. 下位クラスには、m_dataの対応するクラスのデータクラスを操作するためのインターフェイスがあります。
4. 参照ではなく、最も一般的なクラスを使用して、クラスインスタンスを操作するためのC ++自動化のすべての利点を取得します。

もちろん、データにアクセスするとき、対応するクラスは独自の子孫インターフェイスを使用し、データのnullをチェックします。

 int asteroid::get_identifier() const { assert_not_null(__FILE__, __LINE__); return m_data->get_identifier(); } const char* spaceship::get_name() const { assert_not_null(__FILE__, __LINE__); return m_data->get_name(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

時計のように機能する簡単な例：

  asteroid aster(12345); spaceship ship("Alfa-Romeo"); object obj; object obj_aster = asteroid(67890); object obj_ship = spaceship("Omega-Juliette");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

私たちはチェックします：

nullのテスト：

aster.is_null（）：false

ship.is_null（）：false

obj.is_null（）：true

obj_aster.is_null（）：false

obj_ship.is_null（）：false



データクラスのテスト：

aster.data_class（）：小惑星

ship.data_class（）：宇宙船

obj.data_class（）：null

obj_aster.data_class（）：小惑星

obj_ship.data_class（）：宇宙船



テスト識別：

aster.get_identifier（）：12345

ship.get_name（）：アルファロメオ

C＃、Java、Pythonなどの高水準言語に似ていませんか？ 唯一の難しさは、オブジェクトに詰め込まれた相続人のインターフェースを取り戻すことです。 次に、以前にオブジェクトにパックされていたものを小惑星や宇宙船のインスタンスに抽出する方法を学びます。

ウェイアップ

必要なのは、初期化自体はあまりうまくいきませんが、派生クラスのコンストラクターをオーバーロードすることです。

 asteroid::asteroid(const asteroid& another) : object(m_data = another.is_null() ? nullptr : static_cast<asteroid::data*>(another.get_data()->clone())) { } asteroid& asteroid::operator = (const asteroid& another) { reset(m_data = another.is_null() ? nullptr : static_cast<asteroid::data*>(another.get_data()->clone())); return *this; } asteroid::asteroid(const object& another) : object(m_data = (dynamic_cast<const asteroid::data*>(another.get_data()) ? dynamic_cast<asteroid::data*>(another.get_data()->clone()) : nullptr)) { } asteroid& asteroid::operator = (const object& another) { reset(m_data = (dynamic_cast<const asteroid::data*>(another.get_data()) ? dynamic_cast<asteroid::data*>(another.get_data()->clone()) : nullptr)); return *this; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

 spaceship::spaceship(const spaceship& another) : object(m_data = another.is_null() ? nullptr : static_cast<spaceship::data*>(another.get_data()->clone())) { } spaceship& spaceship::operator = (const spaceship& another) { reset(m_data = another.is_null() ? nullptr : static_cast<spaceship::data*>(another.get_data()->clone())); return *this; } spaceship::spaceship(const object& another) : object(m_data = (dynamic_cast<const spaceship::data*>(another.get_data()) ? dynamic_cast<spaceship::data*>(another.get_data()->clone()) : nullptr)) { } spaceship& spaceship::operator = (const object& another) { reset(m_data = (dynamic_cast<const spaceship::data*>(another.get_data()) ? dynamic_cast<spaceship::data*>(another.get_data()->clone()) : nullptr)); return *this; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ご覧のとおり、ここではdynamic_castを使用する必要があります。データクラスの階層を上に移動する必要があるからです。 それは巨大に見えますが、結果は価値があります：

  object obj_aster = asteroid(67890); object obj_ship = spaceship("Omega-Juliette"); asteroid aster_obj = obj_aster; spaceship ship_obj = obj_ship;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

私たちはチェックします：

nullのテスト：

aster_obj.is_null（）：false

ship_obj.is_null（）：false



データクラスのテスト：

aster_obj.data_class（）：小惑星

ship_obj.data_class（）：宇宙船



テスト識別：

aster_obj.get_identifier（）：67890

ship_obj.get_name（）：オメガジュリエット

前後に。 トールキンのように、はるかに短いだけです。

代入演算子もテストすることを忘れないでください：

  aster = asteroid(335577); ship = spaceship("Ramambahara"); obj = object(); obj_aster = asteroid(446688); obj_ship = spaceship("Mamburu"); aster_obj = obj_aster; ship_obj = obj_ship;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして再び確認します：

nullのテスト：

aster.is_null（）：false

ship.is_null（）：false

obj.is_null（）：true

obj_aster.is_null（）：false

obj_ship.is_null（）：false

aster_obj.is_null（）：false

ship_obj.is_null（）：false



データクラスのテスト：

aster.data_class（）：小惑星

ship.data_class（）：宇宙船

obj.data_class（）：null

obj_aster.data_class（）：小惑星

obj_ship.data_class（）：宇宙船

aster_obj.data_class（）：小惑星

ship_obj.data_class（）：宇宙船



テスト識別：

aster.get_identifier（）：335577

ship.get_name（）：Ramambahara

aster_obj.get_identifier（）：446688

ship_obj.get_name（）：マンブル

すべてが正常に機能します！ 以下はsourceを使用したGitHubへのリンクです 。

利益！

何がありますか？ これはPimplではありません。Pimplには多型が多すぎるため、「実装ポインタ」という名前は最適ではありません。 C ++では、実装はクラス宣言とは別です。.cppファイルでは、Pimmplを使用してデータを実装に入れることができます。 ここで、データは実装内に隠されているだけでなく、階層ツリーを形成し、インターフェイスクラスの階層をミラーリングしています。 さらに、null値のカプセル化を取得し、null値の有効性のロジックを派生クラスに埋め込むことができます。 すべてのクラスは簡単にデータとやり取りできます-独自のクラスと祖先と継承者のチェーン全体の両方であり、構文自体はシンプルで簡潔です。

ライブラリAPIだけを実行したいですか？ 今では何も気にしません。 C ++が非常に複雑であり、その上に高レベルのロジックを作成することは不可能であるレプリカについては、そのようなオブジェクトの配列を結合することができ、C＃またはJavaよりも悪くなく、変換はさらに簡単になります。 基本クラスへのポインターを保存する必要なく、ファクトリーをいじる必要なく、クラスを使いやすくすることができます。一般に、通常のコンストラクターや代入演算子をあらゆる方法でエミュレートする必要はありません。

便利なリンク

この記事には、 GitHubに投稿されたソースコードが付属しています。

ソースは、テストを簡素化し、オブジェクト間のデータ転送がどのように機能するかをすばやく理解できるようにするいくつかの方法によって補完されます。

また、HackerマガジンのC ++ Academyシリーズの記事へのリンクも残します。