Dlaczego warto używać idiomu "PIMPL"? [duplikat]

Myślę, że większość ludzi odnosi się do tego idiomu ciała uchwytu. Zobacz książkę Jamesa Copliena Advanced C++ Programming Styles and Idioms (Amazon link). Jest również znany jako Kot z Cheshire ze względu na postać Lewisa Carolla, która zanika, dopóki nie zostanie tylko uśmiech.

Przykładowy kod powinien być rozłożony na dwa zestawy plików źródłowych. Potem tylko Cat.h to plik dostarczany wraz z produktem.

CatImpl.h obejmuje Cat.cpp i CatImpl.cpp zawiera implementację CatImpl:: Purr (). To nie będzie widoczne dla publiczności przy użyciu produktu.

Zasadniczo chodzi o to, aby ukryć jak najwięcej implementacji dla wścibskich oczu. Jest to najbardziej przydatne, gdy masz produkt komercyjny, który jest dostarczany jako seria bibliotek, do których dostęp jest możliwy za pośrednictwem interfejsu API, z którym kod klienta jest kompilowany i linkowany.

Zrobiliśmy to z przepisaniem produktu Ionas Orbix 3.3 w 2000 roku.

Jak wspomniano przez inni, używając jego techniki, całkowicie oddzielają realizację od interfejsu obiektu. Wtedy nie będziesz musiał przekompilować wszystkiego, co używa Cat, jeśli chcesz zmienić implementację Purr ().

Technika ta jest stosowana w metodologii zwanej design by contract.

Co jest warte, to oddziela implementację od interfejsu. Zwykle nie jest to bardzo ważne w małych projektach. Ale w dużych projektach i bibliotekach można go wykorzystać do znacznego skrócenia czasu budowy.

Rozważ, że implementacja Cat może zawierać wiele nagłówków, może obejmować meta-programowanie szablonów, które wymaga czasu na samodzielną kompilację. Dlaczego użytkownik, który chce tylko korzystać z Cat musi to wszystko uwzględnić? Stąd wszystkie niezbędne pliki są ukryte za pomocą idiomu pimpl (stąd deklaracja forward CatImpl), a użycie interfejsu nie zmusza użytkownika do ich włączenia.

Rozwijam bibliotekę do nieliniowej optymalizacji (Czytaj "lots of nasty math"), która jest zaimplementowana w szablonach, więc większość kodu znajduje się w nagłówkach. Kompilacja zajmuje około pięciu minut (na przyzwoitym wielordzeniowym procesorze), a samo parsowanie nagłówków w pustym .cpp zajmuje około minuty. Więc każdy kto korzysta z biblioteki musi poczekać kilka minut za każdym razem, gdy kompilują swój kod, co sprawia, że rozwój jest dość żmudny {10]}. Jednak ukrywając implementację i nagłówki, jeden zawiera tylko prosty plik interfejsu, który kompiluje się natychmiast.

Nie musi to mieć nic wspólnego z ochroną implementacji przed kopiowaniem przez inne firmy - co i tak by się nie stało, chyba że wewnętrzne działanie Twojego algorytmu można odgadnąć z definicji zmiennych członkowskich (jeśli tak, to prawdopodobnie nie jest to zbyt skomplikowane i nie warto chronić w pierwszej kolejności).

Jeśli twoja klasa używa idiomu pimpl, możesz uniknąć zmiany pliku nagłówkowego w publicznej klasie.

To pozwala na dodawanie / usuwanie metod do klasy pimpl, bez modyfikowania pliku nagłówkowego klasy zewnętrznej. Możesz również dodać /usunąć # includes do pimpl.

Kiedy zmienisz plik nagłówka klasy zewnętrznej, musisz przekompilować wszystko, co zawiera #(i jeśli któreś z nich są plikami nagłówkowymi, musisz przekompilować wszystko, co zawiera#, itd.)

Zazwyczaj jedynym odniesieniem do klasy Pimpl w nagłówku dla klasy Owner (w tym przypadku Cat) byłaby deklaracja forward, jak to zrobiłeś tutaj, ponieważ może to znacznie zmniejszyć zależności.

Na przykład, jeśli twoja klasa Pimpl ma ComplicatedClass jako członek (a nie tylko wskaźnik lub odniesienie do niego), musisz mieć ComplicatedClass w pełni zdefiniowany przed jej użyciem. W praktyce oznacza to włączenie "Complicatedlass.h" (które także pośrednio obejmie wszystko od czego zależy). Może to prowadzić do pojedynczego wypełnienia nagłówka wciągającego wiele rzeczy, co jest złe dla zarządzania zależnościami (i czasem kompilacji).

Kiedy używasz pimpl idion, musisz tylko # dołączyć rzeczy używane w publicznym interfejsie typu właściciela(który byłby tutaj Cat). Co sprawia, że rzeczy lepiej dla ludzi korzystających z biblioteki, i oznacza, że nie musisz martwić się o ludzi w zależności od jakiejś wewnętrznej części biblioteki - albo przez błąd, lub dlatego, że chcą zrobić coś, na co nie pozwalasz, więc # definiują prywatne publiczne przed włączeniem plików.

Jeśli jest to prosta klasa, zwykle nie ma powodu, aby używać Pimpl, ale w czasach, gdy typy są dość duże, może to być bardzo pomocne (szczególnie w unikaniu długich czasów budowania)

Nie użyłbym tego. Mam lepszą alternatywę:

Foo.h:

class Foo {
public:
    virtual ~Foo() { }
    virtual void someMethod() = 0;

    // This "replaces" the constructor
    static Foo *create();
}

Foo.cpp:

namespace {
    class FooImpl: virtual public Foo {

    public:
        void someMethod() { 
            //....
        }     
    };
}

Foo *Foo::create() {
    return new FooImpl;
}

Czy ten wzór ma jakąś nazwę?

Jako programista Python i Java, podoba mi się to o wiele bardziej niż idiom pImpl.

Umieszczenie wywołania do impl - > Purr wewnątrz pliku cpp oznacza, że w przyszłości możesz zrobić coś zupełnie innego bez konieczności zmiany pliku nagłówkowego. Może w przyszłym roku odkryją metodę pomocniczą, którą mogliby nazwać zamiast niej i mogą zmienić kod, aby wywołać ją bezpośrednio i w ogóle nie używać impl - >Purr. (Tak, mogą osiągnąć to samo, aktualizując rzeczywistą metodę impl:: Purr, ale w takim przypadku utknąłeś z dodatkowym wywołaniem funkcji, które osiąga nic poza wywołaniem następnej funkcji)

Oznacza to również, że nagłówek ma tylko definicje i nie ma żadnej implementacji, która sprawia, że oddzielenie jest czystsze, co jest sednem idiomu.

Właśnie wdrożyłem moje pierwsze zajęcia pimpl w ciągu ostatnich kilku dni. Użyłem go do wyeliminowania problemów, które miałem, w tym winsock2.h W Borland Builder. Wydawało się, że psuje to wyrównanie struktury, a ponieważ miałem socket w klasie private data, te problemy rozprzestrzeniały się na dowolny plik cpp, który zawierał nagłówek.

Używając pimpl, winsock2.h był zawarty tylko w jednym pliku cpp, gdzie mogłem umieścić pokrywę problemu i nie martwić się, że wróci do gryźć ja.

Aby odpowiedzieć na pierwotne pytanie, zaletą, jaką znalazłem w przekierowaniu wywołań do klasy pimpl było to, że Klasa pimpl jest taka sama jak twoja oryginalna Klasa, zanim ją przepiszesz, plus Twoje implementacje nie są rozłożone na 2 klasy w jakiś dziwny sposób. Dużo jaśniej jest zaimplementować publikę, aby po prostu przejść do klasy pimpl.

Jak powiedział Pan Nodet, jedna klasa, jedna odpowiedzialność.

Używamy idiomu PIMPL w celu emulowania programowania aspect oriented, gdzie aspekty pre, post i error są wywoływane przed i po wykonaniu funkcji member.

struct Omg{
   void purr(){ cout<< "purr\n"; }
};

struct Lol{
  Omg* omg;
  /*...*/
  void purr(){ try{ pre(); omg-> purr(); post(); }catch(...){ error(); } }
};

Używamy również wskaźnika do klasy bazowej, aby współdzielić różne aspekty między wieloma klasami.

Nie wiem, czy warto o tym wspomnieć, ale...

Czy możliwe byłoby posiadanie implementacji we własnej przestrzeni nazw i posiadanie publicznej przestrzeni nazw wrappera / biblioteki dla kodu widzianego przez użytkownika:

catlib::Cat::Purr(){ cat_->Purr(); }
cat::Cat::Purr(){
   printf("purrrrrr");
}

W ten sposób cały kod biblioteki może korzystać z przestrzeni nazw cat, a gdy zachodzi potrzeba udostępnienia klasy użytkownikowi, w przestrzeni nazw catlib może zostać utworzony wrapper.

Uważam, że to mówi, że pomimo tego, jak dobrze znany jest idiom pimpl, nie widzę go zbyt często w prawdziwym życiu (np. w projektach open source).

Często zastanawiam się, czy "korzyści" są przesadne; tak, możesz sprawić, że niektóre szczegóły Twojej implementacji będą jeszcze bardziej ukryte, i tak, możesz zmienić swoją implementację bez zmiany nagłówka, ale nie jest oczywiste, że są to duże zalety w rzeczywistości.

To znaczy, nie jest jasne, że jest jakaś potrzeba dla implementacja ma być , która jest dobrze ukryta, i być może jest to dość rzadkie, że ludzie naprawdę zmieniają tylko implementację; jak tylko trzeba dodać nowe metody, powiedzmy, że i tak trzeba zmienić nagłówek.