{"id":5894,"date":"2024-04-08T07:00:26","date_gmt":"2024-04-08T14:00:26","guid":{"rendered":"http:\/\/writeasync.net\/?p=5894"},"modified":"2024-04-08T07:07:06","modified_gmt":"2024-04-08T14:07:06","slug":"di-tricks-in-c-ref-or-ptr","status":"publish","type":"post","link":"http:\/\/writeasync.net\/?p=5894","title":{"rendered":"DI tricks in C++: ref or ptr?"},"content":{"rendered":"

Dependency injection, AKA “DI”, AKA “passing arguments”<\/a>, is commonly used in modern software design. You’ll see this approach quite often in C#<\/a> and Java<\/a> applications, mainly because these languages have specific support for interfaces and interfaces are a big part of DI in practice<\/a>. C++, however, supports bonafide multiple inheritance<\/a>; you could say C++ has “interfaces,” but only by convention<\/a>. Here is a C++ “interface” type:<\/p>\n

\r\ntemplate <typename T>\r\nclass ISerializer\r\n{\r\npublic:\r\n    virtual void serialize(const T& value, std::ostream& out) = 0;\r\n\r\n    virtual ~ISerializer() = default;\r\n};\r\n<\/pre>\n
This is a pure abstract base class with a virtual destructor. Voila, it’s an interface type! This one represents a way to serialize a given data type T<\/code> to an output stream.<\/p>\n
If we want to map from DI in C#\/Java to DI in C++, we need two things: one of those interface-like classes we just saw and the knowledge to use it correctly. On the second point, we need to be aware that we have to use reference semantics<\/a> to get proper virtual behavior. That means that the following pattern is almost always wrong in a C++ program:<\/p>\n
\r\n\/\/ WRONG WRONG WRONG\r\nISerializer<MyData> ser = get_data_serializer();\r\nser.serialize(MyData{}, std::cout);\r\n<\/pre>\n
The problem is very subtle, but you will note that the ISerializer<\/code> type is returned by value here from the get_data_serializer<\/code> function. This problem is referred to as object slicing<\/a> (as in, we are “slicing off” the derived class information and leaving behind only the base class). It will thwart your attempts to achieve real polymorphism, which is usually what you need when programming against interfaces<\/a>.<\/p>\n
One common fix is to use a smart pointer, say, std::unique_ptr<\/code>, to wrap our interface. This technique is demonstrated in Vlad Ri\u0219cu\u021bia<\/a>‘s helpful article, “Dependency Injection in C++<\/a>.” The bad example above can be thus rewritten correctly as follows:<\/p>\n
\r\n\/\/ OK; the smart pointer gives us the ref semantics we need\r\nstd::unique_ptr<ISerializer<MyData>> ser = get_data_serializer();\r\nser->serialize(MyData{}, std::cout);\r\n<\/pre>\n
This approach is tried and true. It always works. Yet, it has a cost that C++ programmers especially are wary of — dynamic allocation<\/a>! In many scenarios, this is not a cost worth worrying about. There are a dozen other things that tend to crop up in large C++ systems which are more expensive (e.g., string handling<\/a>). But there is something to be said about seemingly unnecessary<\/em> heap allocation. If my object graph can<\/em> be fully relegated to the stack, why must<\/em> I use the heap?<\/p>\n
Let’s look at a somewhat realistic example. Imagine a Config<\/code> class that contains zero or more named ConfigSection<\/code>s:<\/p>\n
\r\nclass ConfigSection\r\n{\r\npublic:\r\n    using Values = std::map<std::string, std::string>;\r\n\r\n    ConfigSection(std::string&& name);\r\n\r\n    const std::string& name() const noexcept;\r\n\r\n    const std::string& value(const std::string& key) const;\r\n\r\n    Values::const_iterator begin() const noexcept;\r\n    Values::const_iterator end() const noexcept;\r\n\r\n    void insert(std::string&& key, std::string&& value);\r\n\r\n    void remove(const std::string& key);\r\n\r\nprivate:\r\n    std::string m_name;\r\n    Values m_values;\r\n};\r\n\r\nclass Config\r\n{\r\npublic:\r\n    using Sections = std::map<std::string, ConfigSection>;\r\n\r\n    Config();\r\n\r\n    ConfigSection& section(const std::string& name);\r\n\r\n    Sections::iterator begin() noexcept;\r\n    Sections::iterator end() noexcept;\r\n\r\n    Sections::const_iterator begin() const noexcept;\r\n    Sections::const_iterator end() const noexcept;\r\n\r\n    void insert(ConfigSection&& section);\r\n\r\n    void remove(const std::string& name);\r\n\r\nprivate:\r\n    Sections m_sections;\r\n};\r\n<\/pre>\n
This might be a reasonable way to represent configuration loaded from an INI file<\/a>. And in fact, maybe it would be useful to support serializing this data back out to a stream with our ISerializer<\/code> interface above:<\/p>\n
\r\nclass ConfigSectionIniSerializer final : public ISerializer<ConfigSection>\r\n{\r\npublic:\r\n    void serialize(const ConfigSection& value, std::ostream& out) final;\r\n};\r\n\r\nclass ConfigIniSerializer final : public ISerializer<Config>\r\n{\r\npublic:\r\n    ConfigIniSerializer() noexcept;\r\n\r\n    void serialize(const Config& value, std::ostream& out) final;\r\n\r\nprivate:\r\n    ConfigSectionIniSerializer m_inner;\r\n};\r\n<\/pre>\n
This implementation would work fine but only if we never need to customize the serialization mechanism. This is because we have a hardcoded dependency on the concrete ConfigSectionIniSerializer:<\/p>\n
\r\n\/\/ default construct the m_inner serializer -- not injectable!\r\nConfigIniSerializer::ConfigIniSerializer() noexcept : m_inner{}\r\n{}\r\n\r\nvoid ConfigIniSerializer::serialize(const Config& value, std::ostream& out)\r\n{\r\n    for (const auto& s : value)\r\n    {\r\n        out << '\\n';\r\n        m_inner.serialize(s.second, out); \/\/ by-value dependency\r\n    }\r\n}\r\n<\/pre>\n
As I mentioned before, by-ref semantics are generally what we need for polymorphic behavior — especially in a DI context. So maybe we could rework the outer Config serializer like this:<\/p>\n
\r\nclass ConfigIniSerializer final : public ISerializer<Config>\r\n{\r\npublic:\r\n    ConfigIniSerializer(ISerializer<Config>& inner) noexcept;\r\n\r\n    void serialize(const Config& value, std::ostream& out) final;\r\n\r\nprivate:\r\n    ISerializer<Config>& m_inner;\r\n};\r\n<\/pre>\n
This is okay — we now have the ability to inject different implementations. However, we have a new requirement to ensure a strictly nested lifetime of the outer Config serializer and the inner ConfigSection serializer. In a large enough program, this becomes quite hard to manage. We could always swap out the reference for a std::unique_ptr<\/code>, but this gets us back to the original dilemma — maybe sometimes<\/em> it’s fine to use a reference (in a small, constrained scope, say) and other times we would rather use a smart pointer.<\/p>\n
Normally a problem like this would call for a templated serializer. Perhaps there is a good way to make that work, but I see a much easier solution. Why not try std::variant<\/a>? Essentially, we need a type that can hold a reference or a smart pointer and std::variant<\/code> seems perfect for that job. There is one problem, though — a std::variant<\/code> cannot hold a reference<\/a>. In this case, though, that’s only a minor problem. We have a workaround:<\/p>\n
\r\ntemplate <typename T>\r\nclass RefOrPtr\r\n{\r\npublic:\r\n    RefOrPtr(T& ref) noexcept : m_value{ &ref }\r\n    {}\r\n\r\n    RefOrPtr(std::shared_ptr<T> p) noexcept : m_value{ std::move(p) }\r\n    {}\r\n\r\n    RefOrPtr(std::unique_ptr<T> p) noexcept : m_value{ std::move(p) }\r\n    {}\r\n\r\n    T* operator->()\r\n    {\r\n        if (std::holds_alternative<T*>(m_value))\r\n        {\r\n            return std::get<T*>(m_value);\r\n        }\r\n        else if (std::holds_alternative<std::shared_ptr<T>>(m_value))\r\n        {\r\n            return std::get<std::shared_ptr<T>>(m_value).get();\r\n        }\r\n        else\r\n        {\r\n            return std::get<std::unique_ptr<T>>(m_value).get();\r\n        }\r\n    }\r\n\r\nprivate:\r\n    std::variant<T*, std::shared_ptr<T>, std::unique_ptr<T>> m_value;\r\n};\r\n<\/pre>\n
The RefOrPtr<\/code> class wraps a variant over a raw pointer<\/strong>, a std::shared_ptr<\/code>, or a std::unique_ptr<\/code>. Note that the raw pointer value is initialized from a real reference, so we haven’t lost sight of our original goal (it’s but a minor implementation detail!). Now instead of tying yourself to one of these three options, we can have it all! And with judicious use of arrow operator overloading<\/a>, we have a uniform access pattern to get at the internally held ref-or-pointer.<\/p>\n
\r\nclass ConfigIniSerializer final : public ISerializer<Config>\r\n{\r\npublic:\r\n    ConfigIniSerializer(RefOrPtr<ISerializer<ConfigSection>>&& inner) noexcept;\r\n\r\n    void serialize(const Config& value, std::ostream& out) final;\r\n\r\nprivate:\r\n    RefOrPtr<ISerializer<ConfigSection>> m_inner;\r\n};\r\n\r\n\/\/ ...\r\nvoid ConfigIniSerializer::serialize(const Config& value, std::ostream& out)\r\n{\r\n    for (const auto& s : value)\r\n    {\r\n        out << '\\n';\r\n        \/\/ using `->` operator to access the interface method\r\n        m_inner->serialize(s.second, out);\r\n    }\r\n}\r\n<\/pre>\n
Because the RefOrPtr may<\/em> contain a std::unique_ptr<\/code>, it is a move-only type<\/a>. Here we take it by r-value reference<\/a> in the serializer constructor (to be std::move<\/code>‘d into place<\/a> in the implementation). RefOrPtr is also implicitly convertible from any of its variant alternatives<\/a> (because it defines single argument non-explicit constructors<\/a>). This means it’s pretty simple to use as a drop-in replacement.<\/p>\n
What do you think? Is RefOrPtr a DI trick or DI treat?<\/p>\n
For a complete implementation of all the code mentioned above, check out the dinject<\/code> sample on GitHub<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Dependency injection, AKA “DI”, AKA “passing arguments”, is commonly used in modern software design. You’ll see this approach quite often in C# and Java applications, mainly because these languages have specific support for interfaces and interfaces are a big part… <\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[91,101],"tags":[],"class_list":["post-5894","post","type-post","status-publish","format-standard","hentry","category-design","category-native"],"_links":{"self":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5894","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5894"}],"version-history":[{"count":6,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5894\/revisions"}],"predecessor-version":[{"id":5900,"href":"http:\/\/writeasync.net\/index.php?rest_route=\/wp\/v2\/posts\/5894\/revisions\/5900"}],"wp:attachment":[{"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5894"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5894"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/writeasync.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5894"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}