如何删除相似的const和非const成员函数之间的代码重复？

假设class X我想在以下位置返回对内部成员的访问权限：

class Z
{
    // details
};

class X
{
    std::vector<Z> vecZ;

public:
    Z& Z(size_t index)
    {
        // massive amounts of code for validating index

        Z& ret = vecZ[index];

        // even more code for determining that the Z instance
        // at index is *exactly* the right sort of Z (a process
        // which involves calculating leap years in which
        // religious holidays fall on Tuesdays for
        // the next thousand years or so)

        return ret;
    }
    const Z& Z(size_t index) const
    {
        // identical to non-const X::Z(), except printed in
        // a lighter shade of gray since
        // we're running low on toner by this point
    }
};

的两个成员函数X::Z()和X::Z() const具有大括号内相同的代码。这是重复的代码，可能会对具有复杂逻辑的长功能造成维护问题。

有没有办法避免此代码重复？

有关详细的说明，请参阅第38 页码标题“避免重复const和使用非const成员功能”。23，在有效的C ++中第3项“ const尽可能使用”中，斯科特·迈耶斯（Scott Meyers）编辑，3d，ISBN-13：9780321334879。

这是Meyers的解决方案（简化）：

struct C {
  const char & get() const {
    return c;
  }
  char & get() {
    return const_cast<char &>(static_cast<const C &>(*this).get());
  }
  char c;
};

这两个强制类型转换和函数调用可能很难看，但这是正确的。迈耶斯对此做了详尽的解释。

是的，可以避免代码重复。您需要使用const成员函数来具有逻辑，并使非const成员函数调用const成员函数，然后将返回值重新转换为非const引用（如果函数返回指针，则为指针）：

class X
{
   std::vector<Z> vecZ;

public:
   const Z& z(size_t index) const
   {
      // same really-really-really long access 
      // and checking code as in OP
      // ...
      return vecZ[index];
   }

   Z& z(size_t index)
   {
      // One line. One ugly, ugly line - but just one line!
      return const_cast<Z&>( static_cast<const X&>(*this).z(index) );
   }

 #if 0 // A slightly less-ugly version
   Z& Z(size_t index)
   {
      // Two lines -- one cast. This is slightly less ugly but takes an extra line.
      const X& constMe = *this;
      return const_cast<Z&>( constMe.z(index) );
   }
 #endif
};

注意：重要的是不要将逻辑放在非const函数中，而让const函数调用非const函数-这可能会导致未定义的行为。原因是常量类实例被转换为非常量实例。非const成员函数可能会不小心修改该类，而C ++标准状态将导致未定义的行为。

C ++ 17更新了此问题的最佳答案：

T const & f() const {
    return something_complicated();
}
T & f() {
    return const_cast<T &>(std::as_const(*this).f());
}

这具有以下优点：

• 很明显发生了什么事
• 最小的代码开销-它适合一行
• 很难犯错（只能volatile被偶然抛弃，但却volatile是罕见的预选赛）

如果您想走完整的推演路线，则可以通过具有辅助功能来完成

template<typename T>
constexpr T & as_mutable(T const & value) noexcept {
    return const_cast<T &>(value);
}
template<typename T>
constexpr T * as_mutable(T const * value) noexcept {
    return const_cast<T *>(value);
}
template<typename T>
constexpr T * as_mutable(T * value) noexcept {
    return value;
}
template<typename T>
void as_mutable(T const &&) = delete;

现在您甚至无法搞乱volatile，用法看起来像

decltype(auto) f() const {
    return something_complicated();
}
decltype(auto) f() {
    return as_mutable(std::as_const(*this).f());
}

我认为，可以通过使用临时帮助函数在C ++ 11中改进Scott Meyers的解决方案。这使得意图更加明显，并且可以被许多其他吸气剂重用。

template <typename T>
struct NonConst {typedef T type;};
template <typename T>
struct NonConst<T const> {typedef T type;}; //by value
template <typename T>
struct NonConst<T const&> {typedef T& type;}; //by reference
template <typename T>
struct NonConst<T const*> {typedef T* type;}; //by pointer
template <typename T>
struct NonConst<T const&&> {typedef T&& type;}; //by rvalue-reference

template<typename TConstReturn, class TObj, typename... TArgs>
typename NonConst<TConstReturn>::type likeConstVersion(
   TObj const* obj,
   TConstReturn (TObj::* memFun)(TArgs...) const,
   TArgs&&... args) {
      return const_cast<typename NonConst<TConstReturn>::type>(
         (obj->*memFun)(std::forward<TArgs>(args)...));
}

可以通过以下方式使用此辅助功能。

struct T {
   int arr[100];

   int const& getElement(size_t i) const{
      return arr[i];
   }

   int& getElement(size_t i) {
      return likeConstVersion(this, &T::getElement, i);
   }
};

第一个参数始终是此指针。第二个是指向要调用的成员函数的指针。之后，可以传递任意数量的附加参数，以便可以将其转发给函数。由于可变参数模板，这需要C ++ 11。

比Meyers更为冗长，但我可以这样做：

class X {

    private:

    // This method MUST NOT be called except from boilerplate accessors.
    Z &_getZ(size_t index) const {
        return something;
    }

    // boilerplate accessors
    public:
    Z &getZ(size_t index)             { return _getZ(index); }
    const Z &getZ(size_t index) const { return _getZ(index); }
};

private方法具有令人讨厌的属性，即它为const实例返回非const Z＆，这就是为什么它是private的原因。私有方法可能会破坏外部接口的不变性（在这种情况下，所需的不变性是“无法通过对const对象的引用来修改其const对象”）。

请注意，注释是模式的一部分-_getZ的接口指定调用它永远无效（很显然，除了访问器之外）：这样做没有任何好处，因为它会多输入1个字符，并且不会导致更小或更快速的代码。调用该方法等效于使用const_cast调用其中一个访问器，并且您也不想这样做。如果您担心使错误变得明显（这是一个公平的目标），则将其称为const_cast_getZ而不是_getZ。

顺便说一句，我感谢迈耶斯的解决方案。我对此没有哲学上的异议。但是，就我个人而言，我喜欢一点点受控的重复，并且只喜欢在某些严格受控的情况下才调用私有方法，而不是看起来像线路噪声的方法。选择你的毒药并坚持下去。

[编辑：凯文正确地指出，_getZ可能想要调用另一种方法（例如generateZ），该方法以与getZ相同的方式进行const专业化。在这种情况下，_getZ将看到const Z＆，并且必须在返回之前进行const_cast。由于样板访问器可以管理所有操作，因此这仍然是安全的，但并不是很明显它是安全的。此外，如果您这样做，然后在以后将generateZ更改为始终返回const，则还需要将getZ更改为始终返回const，但是编译器不会告诉您这样做。

关于编译器的后一点也适用于Meyers的推荐模式，但是关于非显而易见的const_cast的第一点不是。因此，总的来说，我认为如果_getZ的返回值确实需要const_cast，则此模式将失去其与Meyers相比的很多值。与Meyers相比，由于它也有缺点，所以我认为在这种情况下我会改用他。从一个到另一个的重构很容易-它不会影响该类中的任何其他有效代码，因为只有无效代码和样板代码才调用_getZ。

好问题，好答案。我有另一个解决方案，不使用强制类型转换：

class X {

private:

    std::vector<Z> v;

    template<typename InstanceType>
    static auto get(InstanceType& instance, std::size_t i) -> decltype(instance.get(i)) {
        // massive amounts of code for validating index
        // the instance variable has to be used to access class members
        return instance.v[i];
    }

public:

    const Z& get(std::size_t i) const {
        return get(*this, i);
    }

    Z& get(std::size_t i) {
        return get(*this, i);
    }

};

但是，它具有要求使用静态成员的麻烦，并且需要在其中使用instance变量。

我没有考虑此解决方案的所有可能（负面）影响。请让我知道。

您也可以使用模板解决此问题。此解决方案有点丑陋（但是丑陋隐藏在.cpp文件中），但是它确实提供了编译器的一致性检查，并且没有代码重复。

.h文件：

#include <vector>

class Z
{
    // details
};

class X
{
    std::vector<Z> vecZ;

public:
    const std::vector<Z>& GetVector() const { return vecZ; }
    std::vector<Z>& GetVector() { return vecZ; }

    Z& GetZ( size_t index );
    const Z& GetZ( size_t index ) const;
};

.cpp文件：

#include "constnonconst.h"

template< class ParentPtr, class Child >
Child& GetZImpl( ParentPtr parent, size_t index )
{
    // ... massive amounts of code ...

    // Note you may only use methods of X here that are
    // available in both const and non-const varieties.

    Child& ret = parent->GetVector()[index];

    // ... even more code ...

    return ret;
}

Z& X::GetZ( size_t index )
{
    return GetZImpl< X*, Z >( this, index );
}

const Z& X::GetZ( size_t index ) const
{
    return GetZImpl< const X*, const Z >( this, index );
}

我看到的主要缺点是，因为该方法的所有复杂实现都在全局函数中，所以您要么需要使用上面的GetVector（）之类的公共方法来获取X的成员（其中总是需要有一个const和非const版本），也可以将此函数作为朋友。但是我不喜欢朋友。

[编辑：删除了在测试过程中添加的不需要的cstdio。]

将逻辑移到私有方法中，只在吸气剂内部做“获取引用并返回”的事情，怎么样？实际上，对于一个简单的getter函数中的static和const强制转换，我会感到非常困惑，除了极少数情况下，我会认为这很丑陋！

使用预处理器是否作弊？

struct A {

    #define GETTER_CORE_CODE       \
    /* line 1 of getter code */    \
    /* line 2 of getter code */    \
    /* .....etc............. */    \
    /* line n of getter code */       

    // ^ NOTE: line continuation char '\' on all lines but the last

   B& get() {
        GETTER_CORE_CODE
   }

   const B& get() const {
        GETTER_CORE_CODE
   }

   #undef GETTER_CORE_CODE

};

它不像模板或强制转换那么花哨，但确实使您的意图（“这两个功能要相同”）非常明确。

令我惊讶的是，有这么多不同的答案，但是几乎所有答案都依赖于繁琐的模板魔术。模板功能强大，但有时宏会简洁地击败它们。通过将两者结合在一起，通常可以实现最大的多功能性。

我写了一个宏FROM_CONST_OVERLOAD()，可以将其放在非const函数中以调用const函数。

用法示例：

class MyClass
{
private:
    std::vector<std::string> data = {"str", "x"};

public:
    // Works for references
    const std::string& GetRef(std::size_t index) const
    {
        return data[index];
    }

    std::string& GetRef(std::size_t index)
    {
        return FROM_CONST_OVERLOAD( GetRef(index) );
    }


    // Works for pointers
    const std::string* GetPtr(std::size_t index) const
    {
        return &data[index];
    }

    std::string* GetPtr(std::size_t index)
    {
        return FROM_CONST_OVERLOAD( GetPtr(index) );
    }
};

简单且可重用的实现：

template <typename T>
T& WithoutConst(const T& ref)
{
    return const_cast<T&>(ref);
}

template <typename T>
T* WithoutConst(const T* ptr)
{
    return const_cast<T*>(ptr);
}

template <typename T>
const T* WithConst(T* ptr)
{
    return ptr;
}

#define FROM_CONST_OVERLOAD(FunctionCall) \
  WithoutConst(WithConst(this)->FunctionCall)

说明：

如许多答案中所述，在非const成员函数中避免代码重复的典型模式是：

return const_cast<Result&>( static_cast<const MyClass*>(this)->Method(args) );

使用类型推断可以避免很多这种样板。首先，const_cast可以封装在中WithoutConst()，以推断其参数类型并删除co​​nst限定符。其次，可以使用类似的方法WithConst()对this指针进行const限定，从而可以调用const重载方法。

其余的是一个简单的宏，它以正确的限定条件为调用添加前缀，this->并从结果中删除const。由于宏中使用的表达式几乎总是带有1：1转发参数的简单函数调用，因此不会出现诸如多重求值之类的宏的缺点。__VA_ARGS__也可以使用省略号和，但由于逗号（如参数分隔符）出现在括号内。

这种方法有几个好处：

• 最小自然的语法-只需将调用包装 FROM_CONST_OVERLOAD( )
• 无需额外的成员功能
• 与C ++ 98兼容
• 实现简单，无需模板元编程且零依赖
• 扩展性：其他常量关系可以添加（如const_iterator，std::shared_ptr<const T>等）。为此，只需WithoutConst()为相应类型重载即可。

局限性：该解决方案针对非const重载与const重载完全相同的情况进行了优化，因此可以将参数1：1转发。如果您的逻辑有所不同，并且您没有通过调用const版本this->Method(args)，则可以考虑其他方法。

对于那些像我这样的人

• 使用c ++ 17
• 想要添加最少的样板 /重复和
• 不要介意使用宏（在等待元类时...），

这是另一种做法：

#include <utility>
#include <type_traits>

template <typename T> struct NonConst;
template <typename T> struct NonConst<T const&> {using type = T&;};
template <typename T> struct NonConst<T const*> {using type = T*;};

#define NON_CONST(func)                                                     \
    template <typename... T> auto func(T&&... a)                            \
        -> typename NonConst<decltype(func(std::forward<T>(a)...))>::type   \
    {                                                                       \
        return const_cast<decltype(func(std::forward<T>(a)...))>(           \
            std::as_const(*this).func(std::forward<T>(a)...));              \
    }

它基本上是@ Pait，@ DavidStone和@ sh1的答案的混合体（编辑：和@cdhowie的改进）。它增加了表格的功能，使您仅需简单地为函数命名（但没有参数或返回类型重复）的一行额外代码即可：

class X
{
    const Z& get(size_t index) const { ... }
    NON_CONST(get)
};

注意：gcc无法在8.1之前的版本中进行编译，clang-5和更高版本以及MSVC-19对此感到满意（根据编译器浏览器）。

这是模板静态帮助程序函数的C ++ 17版本，带有可选的SFINAE测试。

#include <type_traits>

#define REQUIRES(...)         class = std::enable_if_t<(__VA_ARGS__)>
#define REQUIRES_CV_OF(A,B)   REQUIRES( std::is_same_v< std::remove_cv_t< A >, B > )

class Foobar {
private:
    int something;

    template<class FOOBAR, REQUIRES_CV_OF(FOOBAR, Foobar)>
    static auto& _getSomething(FOOBAR& self, int index) {
        // big, non-trivial chunk of code...
        return self.something;
    }

public:
    auto& getSomething(int index)       { return _getSomething(*this, index); }
    auto& getSomething(int index) const { return _getSomething(*this, index); }
};

完整版本：https：//godbolt.org/z/mMK4r3

我想出了一个宏，该宏会自动生成一对const / non-const函数。

class A
{
    int x;    
  public:
    MAYBE_CONST(
        CV int &GetX() CV {return x;}
        CV int &GetY() CV {return y;}
    )

    //   Equivalent to:
    // int &GetX() {return x;}
    // int &GetY() {return y;}
    // const int &GetX() const {return x;}
    // const int &GetY() const {return y;}
};

有关实现，请参见答案结尾。

的参数MAYBE_CONST重复。在第一个副本中，CV什么也没有替换；在第二个副本中，它被替换为const。

CV宏参数中可以出现多少次没有限制。

不过有一点不便。如果CV出现在括号内，则这对括号必须以CV_IN：为前缀

// Doesn't work
MAYBE_CONST( CV int &foo(CV int &); )

// Works, expands to
//         int &foo(      int &);
//   const int &foo(const int &);
MAYBE_CONST( CV int &foo CV_IN(CV int &); )

实现方式：

#define MAYBE_CONST(...) IMPL_CV_maybe_const( (IMPL_CV_null,__VA_ARGS__)() )
#define CV )(IMPL_CV_identity,
#define CV_IN(...) )(IMPL_CV_p_open,)(IMPL_CV_null,__VA_ARGS__)(IMPL_CV_p_close,)(IMPL_CV_null,

#define IMPL_CV_null(...)
#define IMPL_CV_identity(...) __VA_ARGS__
#define IMPL_CV_p_open(...) (
#define IMPL_CV_p_close(...) )

#define IMPL_CV_maybe_const(seq) IMPL_CV_a seq IMPL_CV_const_a seq

#define IMPL_CV_body(cv, m, ...) m(cv) __VA_ARGS__

#define IMPL_CV_a(...) __VA_OPT__(IMPL_CV_body(,__VA_ARGS__) IMPL_CV_b)
#define IMPL_CV_b(...) __VA_OPT__(IMPL_CV_body(,__VA_ARGS__) IMPL_CV_a)

#define IMPL_CV_const_a(...) __VA_OPT__(IMPL_CV_body(const,__VA_ARGS__) IMPL_CV_const_b)
#define IMPL_CV_const_b(...) __VA_OPT__(IMPL_CV_body(const,__VA_ARGS__) IMPL_CV_const_a)

不支持的C ++ 20之前的实现CV_IN：

#define MAYBE_CONST(...) IMPL_MC( ((__VA_ARGS__)) )
#define CV ))((

#define IMPL_MC(seq) \
    IMPL_MC_end(IMPL_MC_a seq) \
    IMPL_MC_end(IMPL_MC_const_0 seq)

#define IMPL_MC_identity(...) __VA_ARGS__
#define IMPL_MC_end(...) IMPL_MC_end_(__VA_ARGS__)
#define IMPL_MC_end_(...) __VA_ARGS__##_end

#define IMPL_MC_a(elem) IMPL_MC_identity elem IMPL_MC_b
#define IMPL_MC_b(elem) IMPL_MC_identity elem IMPL_MC_a
#define IMPL_MC_a_end
#define IMPL_MC_b_end

#define IMPL_MC_const_0(elem)       IMPL_MC_identity elem IMPL_MC_const_a
#define IMPL_MC_const_a(elem) const IMPL_MC_identity elem IMPL_MC_const_b
#define IMPL_MC_const_b(elem) const IMPL_MC_identity elem IMPL_MC_const_a
#define IMPL_MC_const_a_end
#define IMPL_MC_const_b_end

通常，需要const和非const版本的成员函数是getter和setter。在大多数情况下，它们是单行的，因此代码重复不是问题。

我是为一个有正当理由使用const_cast... 的朋友做的……不知道我可能会做这样的事情（不是很优雅）：

#include <iostream>

class MyClass
{

public:

    int getI()
    {
        std::cout << "non-const getter" << std::endl;
        return privateGetI<MyClass, int>(*this);
    }

    const int getI() const
    {
        std::cout << "const getter" << std::endl;
        return privateGetI<const MyClass, const int>(*this);
    }

private:

    template <class C, typename T>
    static T privateGetI(C c)
    {
        //do my stuff
        return c._i;
    }

    int _i;
};

int main()
{
    const MyClass myConstClass = MyClass();
    myConstClass.getI();

    MyClass myNonConstClass;
    myNonConstClass.getI();

    return 0;
}

我建议使用私有助手静态函数模板，如下所示：

class X
{
    std::vector<Z> vecZ;

    // ReturnType is explicitly 'Z&' or 'const Z&'
    // ThisType is deduced to be 'X' or 'const X'
    template <typename ReturnType, typename ThisType>
    static ReturnType Z_impl(ThisType& self, size_t index)
    {
        // massive amounts of code for validating index
        ReturnType ret = self.vecZ[index];
        // even more code for determining, blah, blah...
        return ret;
    }

public:
    Z& Z(size_t index)
    {
        return Z_impl<Z&>(*this, index);
    }
    const Z& Z(size_t index) const
    {
        return Z_impl<const Z&>(*this, index);
    }
};

这篇DDJ文章展示了一种使用模板特化的方法，不需要您使用const_cast。对于这样一个简单的功能，实际上并不需要它。

boost :: any_cast（在某一时刻，不再使用）使用const版本的const_cast调用非const版本，以避免重复。但是，您不能在非const版本上强加const语义，因此您必须非常小心。

最后，只要两个代码片段彼此直接重叠，就可以进行一些代码复制。

要添加到jwfearn和kevin提供的解决方案中，以下是该函数返回shared_ptr时的相应解决方案：

struct C {
  shared_ptr<const char> get() const {
    return c;
  }
  shared_ptr<char> get() {
    return const_pointer_cast<char>(static_cast<const C &>(*this).get());
  }
  shared_ptr<char> c;
};

没有找到我想要的东西，所以我自己滚了几个...

这个有点罗word，但具有一次处理多个相同名称（和返回类型）的重载方法的优点：

struct C {
  int x[10];

  int const* getp() const { return x; }
  int const* getp(int i) const { return &x[i]; }
  int const* getp(int* p) const { return &x[*p]; }

  int const& getr() const { return x[0]; }
  int const& getr(int i) const { return x[i]; }
  int const& getr(int* p) const { return x[*p]; }

  template<typename... Ts>
  auto* getp(Ts... args) {
    auto const* p = this;
    return const_cast<int*>(p->getp(args...));
  }

  template<typename... Ts>
  auto& getr(Ts... args) {
    auto const* p = this;
    return const_cast<int&>(p->getr(args...));
  }
};

如果const每个名称只有一个方法，但是仍然有很多方法可以重复，那么您可能更喜欢这样：

  template<typename T, typename... Ts>
  auto* pwrap(T const* (C::*f)(Ts...) const, Ts... args) {
    return const_cast<T*>((this->*f)(args...));
  }

  int* getp_i(int i) { return pwrap(&C::getp_i, i); }
  int* getp_p(int* p) { return pwrap(&C::getp_p, p); }

不幸的是，当您开始重载名称时，这种情况就会消失（此时函数指针参数的参数列表似乎尚未解析，因此找不到与函数参数匹配的对象）。尽管您也可以通过模板来实现：

  template<typename... Ts>
  auto* getp(Ts... args) { return pwrap<int, Ts...>(&C::getp, args...); }

但是，该const方法的引用自变量无法与模板的明显按值自变量相匹配，并且会中断。 不知道为什么。这就是为什么。