时间戳

首页 > 解决方案 > 如何在 API 中隐藏迭代器以使用 std::map 包装器中的项目

c++ - 如何在 API 中隐藏迭代器以使用 std::map 包装器中的项目

问题描述

在一个 c++98 项目中，我有一个Items包装了一个类std::map：

#include <string>
#include <map>

class Item { /* ... */ }; // Some class holding some data

class Items
{
 public:
    typedef std::map<std::string,Item> container_type;
    typedef container_type::iterator iterator;

    Items() {}

    iterator find(const String& k) { return i_map.find(k); }
    iterator end() { return i_map.end(); }
    void erase(iterator i) { i_map.erase(i); }
    // ...

 private:
    container_type i_map;
};

它的主要用途是搜索某个Item，如果找到则使用并删除它。我提出的第一个使用项目的明显 API 是：

Items items;
Items::iterator i = items.find("some-id");
if( i!=items.end() )
   {
    const Item& item = i->second; // Get and use the item
    items.erase(i); // Item consumed: remove it from items
   }

...但我被要求隐藏类 API 的iterator概念pair。为了满足这个新要求，第一个想法是在内部存储一个迭代器i_found来记住最后找到的项目：

#include <stdexcept>
#include <string>
#include <map>

class Item { /* ... */ }; // Some class holding some data

class Items
{
 public:
    typedef std::map<std::string,Item> container_type;
    typedef container_type::iterator iterator;

    Items() : i_found( i_map.end() ) {}

    #define should_be_const // const // Unfortunately 'i_found' must be a non const 'iterator' in order to be erased

    bool contains(const std::string& k) should_be_const
       {
        i_found = i_map.find(k);
        return i_found!=i_map.end();
       }

    const Item& get(const std::string& k) should_be_const
       {
        if(i_found==i_map.end() || k!=i_found->first) i_found = i_map.find(k); // search if necessary
        if(i_found!=i_map.end()) return i_found->second;
        else throw std::runtime_error("key \'" + std::string(k) + "\' not found!");
       }

    void erase_found()
       {
        i_map.erase(i_found);
        i_found = i_map.end(); // invalidate last find
       }

 private:
    container_type i_map;
    mutable iterator i_found; // Last found item
};

这提供了编写的可能性：

Items items;
if( items.contains("some-id") )
   {
    const Item& item = items.get("some-id"); // Get and use the item
    items.erase_found(); // Item used: remove it from items
   }

我知道这是否是一种改进是有争议的，我不是在问这个（是的，我也不喜欢它）。在最后一个实现中是否有办法制作方法contains()和get() const？

鉴于上述要求，我也对有关不同方法的建议感兴趣。虽然Item副本构造是可以接受的，但我想避免构造一个itemif “some-id” was not found，因为在这个替代方案中我拼命尝试：

bool Items::extract_if_present(const std::string& k, Item& item)
   {
    iterator i = i_map.find(k);
    if( i != i_map.end() )
       {
        item = i->second;
        i_map.erase(i);
        return true;
       }
    return false;
   }

Item item; // <-- Avoidable useless work if not found
if( items.extract_if_present("some-id", item) )
   {
    //item; // Use the copied item
   }

标签： c++stlapi-designstdmapc++98

解决方案

使用optional（不是 std，它是 C++17，但可以在 C++98 中完成（boost例如使用）），那么您可能在接口中

optional<Item> get(const std::string&) const;
optional<Item> extract(const std::string&);

用法类似于：

Items items;
// ...
if (optional<Item> item = items.extract("some-id"))
{
    // use *item;
}

推荐阅读