friend (C++)

在某些情况下，类向不属于类成员的函数或单独类中的所有成员授予成员级访问权限非常有用。 这些自由函数和类称为“友元”，由 friend 关键字标记。 仅类实现器可以声明其友元。 函数或类不能将其自身声明为任何类的友元。 在类定义中，使用 friend 关键字和非成员函数或其他类的名称，以允许其访问类的私有和受保护成员。 在模板定义中，类型参数可以声明为 friend。

语法

friend-declaration：
 friend function-declaration
 friend function-definition
 friendelaborated-type-specifier;；
 friend simple-type-specifier ;
 friend typename-specifier ;

friend 声明

如果声明以前未声明的 friend 函数，则该函数将被导出到封闭非类范围。

friend 声明中声明的函数被视为已使用 extern 关键字声明。 有关详细信息，请参阅 extern。

尽管具有全局范围的函数可以在其原型之前声明为 friend 函数，但是成员函数在它们的完整类声明出现前不能声明为 friend 函数。 以下代码演示了此类声明是如何失败的：

class ForwardDeclared;   // Class name is known.
class HasFriends
{
    friend int ForwardDeclared::IsAFriend();   // C2039 error expected
};

前面的示例将类名 ForwardDeclared 输入到范围中，但是完整的声明（具体而言，声明函数 IsAFriend 的部分）是未知的。 HasFriends 类中的 friend 声明会生成一个错误。

在 C++11 中，一个类有两种形式的友元声明：

friend class F;
friend F;

如果最内层的命名空间中找不到任何具有该名称的现有类，则第一种形式引入新的类 F。 C++11：第二种形式不引入新的类；当类已声明时，可以使用该形式，而当将模板类型参数或 typedef 声明为 friend 时，必须使用该形式。

在引用类型尚未声明时使用 friend class F：

namespace NS
{
    class M
    {
        friend class F;  // Introduces F but doesn't define it
    };
}

如果使用类类型尚未声明的 friend，则会发生错误：

namespace NS
{
    class M
    {
        friend F; // error C2433: 'NS::F': 'friend' not permitted on data declarations
    };
}

在以下示例中，friend F 引用在 NS 范围之外声明的类 F。

class F {};
namespace NS
{
    class M
    {
        friend F;  // OK
    };
}

使用 friend F 将模板参数声明为友元：

template <typename T>
class my_class
{
    friend T;
    //...
};

用于 friend F 将 typedef 声明为友元：

class Foo {};
typedef Foo F;

class G
{
    friend F; // OK
    friend class F // Error C2371 -- redefinition
};

若要声明两个互为友元的类，则必须将整个第二个类指定为第一个类的友元。 此限制的原因是该编译器仅在声明第二个类的位置有足够的信息来声明各个友元函数。

注意

尽管整个第二个类必须是第一个类的友元，但是可以选择将第一个类中的哪些函数作为第二个类的友元。

友元函数

friend 函数是一个不为类成员的函数，但它可以访问类的私有和受保护的成员。 友元函数不被视为类成员；它们是获得了特殊访问权限的普通外部函数。 友元不在类的范围内，除非它们是另一个类的成员，否则不会使用成员选择运算符（. 和 ->）调用它们。 friend 函数由授予访问权限的类声明。 可将 friend 声明放置在类声明中的任何位置。 它不受访问控制关键字的影响。

以下示例显示 Point 类和友元函数 ChangePrivate。 friend 函数可以访问其接受为参数的 Point 对象的私有数据成员。

// friend_functions.cpp
// compile with: /EHsc
#include <iostream>

using namespace std;
class Point
{
    friend void ChangePrivate( Point & );
public:
    Point( void ) : m_i(0) {}
    void PrintPrivate( void ){cout << m_i << endl; }

private:
    int m_i;
};

void ChangePrivate ( Point &i ) { i.m_i++; }

int main()
{
   Point sPoint;
   sPoint.PrintPrivate();
   ChangePrivate(sPoint);
   sPoint.PrintPrivate();
// Output: 0
           1
}

作为友元的类成员

类成员函数可以声明为其他类中的友元。 请考虑以下示例：

// classes_as_friends1.cpp
// compile with: /c
class B;

class A {
public:
   int Func1( B& b );

private:
   int Func2( B& b );
};

class B {
private:
   int _b;

   // A::Func1 is a friend function to class B
   // so A::Func1 has access to all members of B
   friend int A::Func1( B& );
};

int A::Func1( B& b ) { return b._b; }   // OK
int A::Func2( B& b ) { return b._b; }   // C2248

在前面的示例中，仅为函数 A::Func1( B& ) 授予对类 B 的 friend 访问权限。 因此，访问私有成员 _b 在类 A 的 Func1 中是正确的，但在 Func2 中是不正确的。

friend 类是其所有成员函数都是类的 friend 函数的类，即，其成员函数具有对类的私有成员和受保护成员访问权限。 假定类 friend 中的 B 声明是：

friend class A;

在这种情况下，将为类 A 中所有成员函数授予对类 B 的 friend 访问权限。 以下代码是 friend 类的示例：

// classes_as_friends2.cpp
// compile with: /EHsc
#include <iostream>

using namespace std;
class YourClass {
friend class YourOtherClass;  // Declare a friend class
public:
   YourClass() : topSecret(0){}
   void printMember() { cout << topSecret << endl; }
private:
   int topSecret;
};

class YourOtherClass {
public:
   void change( YourClass& yc, int x ){yc.topSecret = x;}
};

int main() {
   YourClass yc1;
   YourOtherClass yoc1;
   yc1.printMember();
   yoc1.change( yc1, 5 );
   yc1.printMember();
}

友元关系不是相互的，除非如此显式指定。 在上面的示例中，YourClass 的成员函数无法访问 YourOtherClass 的私有成员。

托管类型（C++/CLI 中）不能具有任何 friend 函数、friend 类或 friend 接口。

友元关系不能继承，这意味着从 YourOtherClass 派生的类不能访问 YourClass 的私有成员。 友元关系不可传递，因此 YourOtherClass 的友元类无法访问 YourClass 的私有成员。

下图显示了 4 个类声明：Base、Derived、aFriend 和 anotherFriend。 只有类 aFriend 具有对 Base 的私有成员（以及对 Base 可能已继承的所有成员）的直接访问权限。

该图显示类 anotherFriend 与朋友类 aFriend 的基类没有友元关系。 类 aFriend 与类 Base 是友元关系，但它与类 Derived 没有友元关系，即使类 Derived 继承自 Base。 这表明继承并不意味着派生类与基类具有相同的朋友。

内联 friend 定义

可以在类声明中定义友元函数（给定函数主体）。 这些函数是内联函数。 类似于成员内联函数，其行为就像它们在所有类成员显示后但在类范围关闭前（在类声明的结尾）被定义时的行为一样。 类声明中定义的友元函数在封闭类的范围内。

另请参阅

关键字