C++ Core Guidelines 中文版 GSL

C++ GSL（Guideline Support Library）是由 Microsoft 开发的一个开源库，旨在提供一组通用的 C++ 标准库扩展，以支持 C++ 标准委员会提出的指导原则。GSL 为 C++ 开发人员提供了许多有用的工具和类型，以帮助他们编写更安全、更高效的代码。

以下是 GSL 提供的一些重要组件和功能：

Bounds 检查：GSL 包括用于执行数组边界检查、迭代器有效性检查等的工具。这有助于避免数组越界访问和迭代器失效等问题。

1. #include <iostream>
   #include <gsl/gsl>
   
   int main() {
       int data[] = {1, 2, 3, 4, 5};
       
       // 创建一个 span 对象来引用数组
       gsl::span<int> dataArray(data);
   
       // 使用 Expects 约定来确保数组不为空
       Expects(!dataArray.empty());
   
       // 检查数组边界并进行访问
       for (size_t i = 0; i < dataArray.size(); ++i) {
           std::cout << dataArray[i] << " ";
       }
       std::cout << std::endl;
   
       // 尝试越界访问数组
       try {
           int value = dataArray[dataArray.size()];  // 越界访问
           std::cout << "Value at index " << dataArray.size() << ": " << value << std::endl;
       } catch (gsl::fail_fast& ex) {
           std::cerr << "Caught gsl::fail_fast exception: " << ex.what() << std::endl;
       }
   
       return 0;
   }
   

2. 不可变性：GSL 提供了 gsl::not_null 类型，用于表示指针或引用不能为空，从而帮助避免空指针异常。

3. #include <iostream>
   #include <gsl/gsl>
   
   void printValue(gsl::not_null<int*> ptr) {
       std::cout << "The value is: " << *ptr << std::endl;
   }
   
   int main() {
       int value = 42;
       int* ptr = &value;
   
       // 传递指针给函数，使用 not_null 来确保指针不为空
       printValue(gsl::not_null<int*>(ptr));
   
       // 尝试传递空指针给函数
       int* nullPtr = nullptr;
       try {
           printValue(gsl::not_null<int*>(nullPtr));  // 这会引发错误
       } catch (gsl::fail_fast& ex) {
           std::cerr << "Caught gsl::fail_fast exception: " << ex.what() << std::endl;
       }
   
       return 0;
   }
   

4. 算法和数据结构：GSL 包括一些额外的算法和数据结构，例如 span 类型，用于表示连续内存范围，并提供对该范围的安全访问。

5. gsl::at

   实际上是一个用于访问数组或容器元素的函数。它提供了类似于标准库 at 函数的功能，但是在索引超出有效范围时，gsl::at 会触发断言而非抛出异常。

   以下是关于 gsl::at 的详细说明和代码使用示例：

   详细说明

   gsl::at 函数的语法如下：

6. gsl::at(container, index);
   

   其中，container 是要访问的数组或容器对象，index 是要访问的元素的索引。

   当使用 gsl::at 函数时，如果索引超出了容器的有效范围，它会触发断言，导致程序终止。

   代码使用示例

   以下是一个使用 gsl::at 函数的示例代码，演示了如何安全地访问向量中的元素：

7. #include <iostream>
   #include <gsl/gsl>
   #include <vector>
   
   int main() {
       std::vector<int> vec = {1, 2, 3, 4, 5};
   
       // 访问向量中的元素
       for (int i = 0; i <= vec.size(); ++i) {
           std::cout << "Element at index " << i << ": ";
           try {
               std::cout << gsl::at(vec, i) << std::endl;
           } catch (const gsl::fail_fast& e) {
               std::cerr << "Out of range access: " << e.what() << std::endl;
           }
       }
   
       return 0;
   }
   

8. 字符串视图：GSL 提供对字符串的视图类，如 string_span，用于安全地引用字符串而无需复制数据。

9. 用于提供一种轻量级、非拥有式的字符串访问方式。这些视图类可以用于在不复制字符串内容的情况下进行字符串操作和访问，从而提高性能并减少内存开销。

   在 GSL 中，提供了两个主要的字符串视图类：gsl::cstring_span 和 gsl::string_span。它们分别用于 C 风格字符串和 C++ 标准库字符串的视图。以下是关于这两个类的详细说明和代码使用示例：

   gsl::cstring_span 类

   gsl::cstring_span 类用于表示对 C 风格字符串的非拥有式视图，允许对字符串进行安全的访问和操作，而无需复制字符串内容。

   详细说明

   gsl::cstring_span 的基本用法如下：

   gsl::cstring_span strSpan = "Hello, GSL!";
   

   gsl::string_span 类

   gsl::string_span 类用于表示对 C++ 标准库字符串的非拥有式视图，同样允许对字符串进行安全的访问和操作，而无需复制字符串内容。

   详细说明

   gsl::string_span 的基本用法如下：

10. std::string str = "Hello, GSL!";
    gsl::string_span strSpan = str;
    

    代码使用示例

    以下是一个简单的示例代码，演示了如何使用 gsl::cstring_span 和 gsl::string_span 类来创建字符串视图并进行访问操作：

11. #include <iostream>
    #include <gsl/gsl>
    
    int main() {
        // 使用 gsl::cstring_span 访问 C 风格字符串
        gsl::cstring_span strSpanC = "Hello, GSL!";
        std::cout << "String view using gsl::cstring_span: " << strSpanC << std::endl;
    
        // 使用 gsl::string_span 访问 C++ 标准库字符串
        std::string str = "Hello, GSL!";
        gsl::string_span strSpan = str;
        std::cout << "String view using gsl::string_span: " << strSpan << std::endl;
    
        return 0;
    }
    

12. 约定：GSL 引入了一些编程约定，如 Expects 和 Ensures，用于在代码中明确表达前置条件和后置条件。

13. Expects 宏

14. Expects 宏用于指定函数或代码块执行前的先决条件，如果先决条件不满足，将导致程序终止。通常用于检查参数的有效性或函数执行前的必要条件。

    详细说明

    Expects 宏的基本用法如下：

15. #include <gsl/gsl>
    void example_function(int value) {
        Expects(value > 0 && "Value must be greater than 0");
        // 函数的其他逻辑
    }
    

    Ensures 宏

    Ensures 宏用于指定函数执行后的后置条件，如果后置条件不满足，同样会导致程序终止。通常用于确保函数执行后的状态或结果。

    详细说明

    Ensures 宏的基本用法如下：

16. #include <gsl/gsl>
    int example_function(int input) {
        int result = input * 2;
        Ensures(result > 0 && "Result must be greater than 0");
        return result;
    }
    

    代码使用示例

    以下是一个简单的示例代码，演示了如何使用 Expects 和 Ensures 宏来进行先决条件和后置条件检查：

17. #include <iostream>
    #include <gsl/gsl>
    
    void divide(int dividend, int divisor) {
        Expects(divisor != 0 && "Divisor cannot be zero");
        int result = dividend / divisor;
        Ensures(result >= 0 && "Result must be non-negative");
        std::cout << "Result of division: " << result << std::endl;
    }
    
    int main() {
        divide(10, 2);
        divide(20, 0); // 这里违反了 Expects 的先决条件，将导致程序终止
        return 0;
    }
    

对于 C++ 开发人员来说，GSL 是一个非常有用的工具库，可以帮助他们编写更加健壮和安全的代码。它有助于避免常见的程序错误，如空指针访问、越界访问等，并通过引入新的类型和约定，提高了代码的可读性和可维护性。