函数返回值

本节阅读量:

以下程序：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


#include <iostream>

int main()
{
    // 让用户输入一个值
    std::cout << "Enter an integer: ";
    int num{};
    std::cin >> num;

    // 输入的值 * 2, 然后输出
    std::cout << num << " doubled is: " << num * 2 << '\n';

    return 0;
}

此程序由两部分组成：首先，从用户获得一个值。然后告诉用户该值的两倍。

尽管此程序非常琐碎，我们不需要将其分解成多个函数，但如果想这样做呢？从用户那里获得整数值是一个概念上完整的部分，可以将它封装成函数。

编写程序：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


// 这个程序不会产出预期的效果
#include <iostream>

void getValueFromUser()
{
    std::cout << "Enter an integer: ";
    int input{};
    std::cin >> input;  
}

int main()
{
    getValueFromUser(); // 让用户输入一个数字

    int num{}; // 如何将getValueFromUser函数中获取的值，放置到变量num中？

    std::cout << num << " doubled is: " << num * 2 << '\n';

    return 0;
}

虽然该程序是一个很好的尝试，但并不满足我们的需求。

调用函数getValueFromUser时，要求用户按预期输入整数。但当getValueFromUser执行结束并返回main时，输入值将丢失。变量num无法使用输入值初始化，程序会打印答案0。

我们缺少从getValueFromUser将用户输入值返回给main的方法，以便main可使用该数据。

返回值

编写用户定义函数时，函数能将值返回给调用方。将值返回给调用者，要两步。

首先，函数要标识返回的值类型。通过设置函数的返回类型，该类型是在函数名称前定义的类型。上面示例中，函数getValueFromUser的返回类型为void（表示不会向调用方返回值），函数main返回类型是int（表示向调用者返回类型为int的值）。注意，这并不是要返回什么特定的值——只是返回什么类型的值。

其次，在要返回值的函数内，使用return语句来指示返回给调用方的特定值。函数返回的值称为返回值。执行return语句，函数立即退出，返回值从函数复制回调用方。这个过程称为按值返回。

以下是返回整数值的简单函数，及调用它的示例程序：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


#include <iostream>

// 返回值类型是 int
// 这意味着调用该函数的调用者，会得到一个 int 类型的数据
int returnFive()
{
    // 使用return语句来返回数据
    return 5; // 这里返回的是值 5
}

int main()
{
    std::cout << returnFive() << '\n'; // 打印 5
    std::cout << returnFive() + 2 << '\n'; // 打印 7

    returnFive(); // 5被返回，但main函数没有其它任何处理

    return 0;
}

运行时，此程序打印：

执行从main的顶部开始。第一条语句中，调用函数returnFive。函数returnFive将特定值 5 返回给调用者，std::cout将其打印到控制台。

第二个函数调用中，函数 returnFive 再次被调用。函数returnFive将5的值返回给调用者。计算表达式5+2产生结果7，std::cout将其打印到控制台。

第三条语句，再次调用函数returnFive，将值5返回给调用者。但函数main不处理返回值（返回值被忽略）。

注意：只有调用者通过std::cout将返回值发送至控制台，才会打印返回值。最后一个例子中，返回值未发送到std::cout，因此不会打印。

提示

当被调用函数有返回值时，调用者可决定在表达式或语句中是否使用该值（例如，分配给变量，或发送到std::cout），或忽略它（不执行操作）。

修复问题代码

修复在课程开始的演示程序：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


#include <iostream>

int getValueFromUser() // 本函数返回一个int值
{
     std::cout << "Enter an integer: ";
    int input{};
    std::cin >> input;  

    return input; // 将用户输入的值返回给调用函数
}

int main()
{
    int num { getValueFromUser() }; // 使用getValueFromUser()的结果初始化变量num

    std::cout << num << " doubled is: " << num * 2 << '\n';

    return 0;
}

程序执行时，main中第一条语句将创建一个名为num的int变量。程序初始化num时，有个函数getValueFromUser()的调用，因此将执行该函数。函数getValueFromUser要求用户输入一个值，然后将该值返回给调用者（main）。此返回值作为变量num的初始化值。

自己编译程序并运行几次，以证明它是有效的。

重新理解main()

对函数调用有概念后，继续了解main()函数的实际工作方式。程序执行时，操作系统对main进行函数调用。然后执行到main的顶部。main中的语句按顺序执行。最后，main返回一个整数值（通常为0），程序终止。main的返回值也称为状态代码（也称为退出代码，或称为返回代码），它用于指示程序是否成功运行。

状态代码0表示程序成功执行。

非零状态代码常用于指示故障（虽然在大多数操作系统上都很好，但严格地说，它不能保证是可移植的）。

C++不允许显式调用main函数。

现在，您还应该在代码文件的底部，其他函数的下面定义main函数。

最佳实践

如果程序正常运行，则主函数应返回值0。

对于高级读者

C++标准仅定义3个状态代码的含义：0、EXIT_SUCCESS和EXIT_FAILURE。0和EXIT_SUCCESS都表示程序成功执行。EXIT_FAILURE表示程序未成功执行。

EXIT_SUCCESS和EXIT_FAILURE是在头中定义的预处理器宏：

1
2
3
4
5
6


#include <cstdlib> // for EXIT_SUCCESS and EXIT_FAILURE

int main()
{
    return EXIT_SUCCESS;
}

如果要最大限度地提高可移植性，则应仅使用0或EXIT_SUCCESS表示成功终止，或使用EXIT_FAILURE表示不成功终止。

在预处理器简介小节中会介绍预处理器和预处理器宏。

若有返回值的函数未返回结果，将产生未定义的行为

如果函数的返回类型不是void，但未使用return函数返回结果。调用该函数，获取的值将导致未定义的行为。

下面是一个产生未定义行为的函数的示例：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


#include <iostream>

int getValueFromUserUB() // 返回一个int值
{
     std::cout << "Enter an integer: ";
    int input{};
    std::cin >> input;

    // note: 无return语句
}

int main()
{
    int num { getValueFromUserUB() }; // 使用 getValueFromUserUB() 的返回值初始化num

    std::cout << num << " doubled is: " << num * 2 << '\n';

    return 0;
}

现代编译器应生成警告，因为getValueFromUserUB被定义为返回int，但没有提供返回语句。运行这样的程序将产生未定义的行为，因为getValueFromUserUB()是一个不返回值的可获取返回值的函数。

在大多数情况下，编译器将检测是否忘记返回值。然而，在某些复杂的情况下，编译器可能无法在所有情况下正确检查函数是否返回值，因此不应依赖编译器。

最佳实践

确保具有非void返回类型的函数在所有情况下都返回值。

如果未提供返回语句，函数main将隐式返回0

函数必须通过return语句返回值，这一规则的唯一例外是函数main()。如果没有提供return语句，函数main()将隐式返回值0。也就是说，最好的做法是显式地从main返回一个值，以显示您的意图，并与其他函数保持一致（如果未指定返回值，则会显示未定义的行为）。

函数只能返回单个值

函数每次被调用时只能将单个值返回给调用方。

注意，return语句中提供的值不需要是文本——它可以是任何有效表达式的结果，包括变量，甚至是对另一个函数的调用结果。在上面的getValueFromUser（）示例中，返回了一个变量，保存了用户输入的数字。

有各种方法可以解决函数只能返回单个值的限制，在以后的课程会介绍。

函数作者可以决定返回值的含义

函数返回的值的含义由函数的作者决定。一些函数使用返回值作为状态代码，以指示它们是成功的还是失败的。一些函数返回计算值或选定值。一些函数不返回内容（在下一课中看到这些函数的示例）。

由于有各种各样的可能性，最好用注释来记录函数，说明返回值的含义。例如：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


// 让用户输入数字
// 返回值是用户输入的数字
int getValueFromUser()
{
     std::cout << "Enter an integer: ";
    int input{};
    std::cin >> input;  

    return input;
}

重复使用函数

以下程序是函数重用很好的例子：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


#include <iostream>

int main()
{
    int x{};
    std::cout << "Enter an integer: ";
    std::cin >> x; 

    int y{};
    std::cout << "Enter an integer: ";
    std::cin >> y; 

    std::cout << x << " + " << y << " = " << x + y << '\n';

    return 0;
}

虽然这个程序能工作，但它有点冗余。事实上，此程序违反了良好编程的核心原则之一：不要重复自己（通常缩写为DRY）。

为什么重复的代码是坏的？如果想将文本“Enter an integer:”更改，必须在两个位置更改。如果想初始化10个变量，而不是2个，会怎么样？将是大量冗余代码（使程序更长、更难理解），且有很大的空间让打字错误蔓延进来。

更新此程序，使用上面开发的getValueFromUser函数：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20


#include <iostream>

int getValueFromUser()
{
     std::cout << "Enter an integer: ";
    int input{};
    std::cin >> input;  

    return input;
}

int main()
{
    int x{ getValueFromUser() };
    int y{ getValueFromUser() };

    std::cout << x << " + " << y << " = " << x + y << '\n';

    return 0;
}

该程序产生以下输出：

1
2
3


Enter an integer: 5
Enter an integer: 7
5 + 7 = 12

该程序中，调用getValueFromUser两次，一次初始化变量x，一次初始变量y。避免了重复代码获取用户输入，降低了出错的几率。一旦确定getValueFromUser工作正常，可根据需要多次调用。

这是模块化编程的本质：编写函数、测试、确保工作正常，然后可根据需要多次重用。

最佳实践

遵循DRY（Don’t Repeat Yourself）最佳实践：“不要重复自己”。如果需要多次执行某些操作，考虑如何修改代码以尽可能地删除冗余。变量可用于存储要多次使用的计算结果（因此不必重复计算）。函数可用于定义要多次执行的语句序列。循环（将在后面的章节中介绍）可用于多次执行语句。

旁白…

DRY的反义词是WET（“将所有内容写入两次”，“Write everything twice”）。

总结

函数返回值是将单个值返回给函数调用方的方法。

函数是最小化程序冗余的方法。

2.0 函数简介

2.2 无返回值函数