Skip to content

Latest commit

 

History

History
635 lines (549 loc) · 26.4 KB

ch19.md

File metadata and controls

635 lines (549 loc) · 26.4 KB

Chapter19 字符串视图(String Views)

在C++17中,C++标准库引入了一个特殊的字符串类:std::string_view, 它能让我们像处理字符串一样处理字符序列,而不需要为它们分配内存空间。 也就是说,std::string_view类型的对象只是引用一个外部的字符序列, 而不需要持有它们。因此,一个字符串视图对象可以被看作字符串序列的 引用

使用字符串视图的开销很小,速度却很快(以值传递一个string_view的开销总是很小)。 然而,它也有一些潜在的危险,就和原生指针一样,在使用string_view时也必须 由程序员自己来保证引用的字符串序列是有效的。

19.1 和std::string的不同之处

std::string相比,std::string_view对象有以下特点:

  • 底层的字符序列是只读的。没有操作可以修改底层的字符。你只能赋予一个新值、 交换值、把视图缩小为字符序列的子序列。
  • 字符序列不保证有空字符终止。因此,字符串视图并不是一个 空字符终止的字节流(NTBS)
  • data()返回的值可能是nullptr。例如,当用默认构造函数初始化一个 字符串视图之后,调用data()将返回nullptr
  • 没有分配器支持。

因为可能返回nullptr,并且可能不以空字符结尾, 所以在使用operator[]data()之前应该 总是使用size()获取长度 (除非你已经知道了长度)。

19.2 使用字符串视图

字符串视图有两个主要的应用:

  • 你可能已经分配或者映射了字符序列或者字符串的数据, 并且想在不分配更多内存的情况下使用这些数据。典型的例子是内存映射文件或者处理长文本的子串。
  • 你可能想提升接收字符串为参数并以只读方式使用它们的函数/操作的性能, 且这些函数/操作不需要结尾有空字符。

这种情况的一种特殊形式是想以类似于string的API来处理字符串字面量对象:

std::string_view hello{"hello world"};

第一个应用通常意味着只需要传递字符串视图,然而程序逻辑必须保证底层的字符序列仍然有效 (即内存映射文件不会中途取消映射)。 你也可以在任何时候使用一个字符串视图来初始化或赋值给std::string

注意不要把字符串视图当作“更好的string”来使用。 这样可能导致性能问题和一些运行时错误。 请仔细的阅读下面的小节。

19.3 使用字符串视图作为参数

下面是使用字符串视图作为只读字符串的第一个例子, 这个例子定义了一个函数将传入的字符串视图作为前缀,之后打印一个集合中的元素:

#include <string_view>

template<typename T>
void printElems(const T& coll, std::string_view prefix = {})
{
    for (const auto& elem : coll) {
        if (prefix.data()) {    // 排除nullptr
            std::cout << prefix << ' ';
        }
        std::cout << elem << '\n';
    }
}

这里,把函数参数声明为std::string_view,与声明为std::string比较起来, 可能会减少一次分配堆内存的调用。具体的情况依赖于是否传递的是短字符串和是否使用了短字符串优化(SSO)。 例如,如果我们像下面这么声明:

template<typename T>
void printElems(const T& coll, const std::string& prefix = {});

然后传递了一个字符串字面量,那么这个调用会创建一个临时的string,这将会在堆上分配一次内存, 除非使用了短字符串优化。 通过使用字符串视图,将不会分配内存,因为字符串视图只 指向 字符串字面量。

注意在使用值未知的字符串视图前应该检查data()来排除nullptr。 这里为了避免写入额外的空格分隔符,必须检查nullptr。 值为nullptr的字符串视图写入到输出流时不应该写入任何字符。

另一个例子是使用字符串视图作为只读的字符串来改进std::optional<>章节的asInt()示例, 改进的方法就是把参数声明为字符串视图:

#include <optional>
#include <string_view>
#include <charconv> // for from_chars()
#include <iostream>

// 尝试将string转换为int:
std::optional<int> asInt(std::string_view sv)
{
    int val;
    // 把字符序列读入int:
    auto [ptr, ec] = std::from_chars(sv.data(), sv.data() + sv.size(), val);
    // 如果有错误码,就返回空值:
    if (ec != std::errc{}) {
        return std::nullopt;
    }
    return val;
}

int main()
{
    for (auto s : {"42", "  077", "hello", "0x33"}) {
        // 尝试把s转换为int,并打印结果:
        std::optional<int> oi = asInt(s);
        if (oi) {
            std::cout << "convert '" << s << "' to int: " << *oi << "\n";
        }
        else {
            std::cout << "can't convert '" << s << "' to int\n";
        }
    }
}

asInt()的参数改为字符串视图之后需要进行很多修改。 首先,没有必要再使用std::stoi()来转换为整数,因为stoi()的参数是string, 而根据string view创建string的开销相对较高。

作为代替,我们向新的标准库函数std::from_chars()传递了字符范围。 这个函数需要两个字符指针为参数,分别代表字符序列的起点和终点,并进行转换。 注意这意味着我们可以避免单独处理空字符串视图,这种情况下data()返回nullptrsize()返回0,因为从nullptrnullptr+0是一个有效的空范围 (任何指针类型都支持与0相加,并且不会有任何效果)。

std::from_chars()返回一个std::from_chars_result类型的结构体, 它有两个成员:一个指针ptr指向未被处理的第一个字符, 另一个成员ec的类型是std:errcstd::errc{}代表没有错误。 因此,使用返回值中的ec成员初始化ec之后(使用了结构化绑定), 下面的检查将在转换失败时返回nullopt

if (ec != std::errc{}) {
    return std::nullopt;
}

使用字符串视图还可以显著提升子字符串排序的性能。

19.3.1 字符串视图有害的一面

通常“智能对象”例如智能指针会比相应的语言特性更安全(至少不会更危险)。 因此,你可能会有一种印象:字符串视图是一种字符串的引用,应该比字符串引用更安全或者至少一样安全。 然而不幸的是,事实并不是这样的,字符串视图远比字符串引用或者智能指针更危险。 它们的行为更近似于原生字符指针。

不要把临时字符串赋值给字符串视图

考虑声明一个返回新字符串的函数:

std::string retString();

使用返回值总是安全的:

  • 用返回值来初始化一个string或者用auto声明的对象是安全的:
std::string s1 = retString();   // 安全
  • 用返回值初始化常量string引用,只在局部使用时也是安全的。 因为引用会延长返回值的生命周期:
std::string& s2 = retString();  // 编译期ERROR(缺少const)

const std::string& s3 = retString();  // s3延长了返回的string的生命周期
std::cout << s3 << '\n';        // OK
auto&& s4 = retString();        // s4延长了返回的string的生命周期
std::cout << s4 << '\n';        // OK

字符串视图没有这么安全,它 既不 拷贝 也不 延长返回值的生命周期:

std::string_view sv = retString(); // sv不延长返回值的生命周期
std::cout << sv << '\n';           // 运行时ERROR:返回值已经被销毁

这里,在第一条语句结束时返回的字符串已经被销毁了,所以使用指向它的字符串视图sv 将会导致未定义的运行时错误。

这个问题类似于如下调用:

const char* p = retString().c_str();

或者:

auto p = retString().c_str();

因此,当使用返回的字符串视图时必须非常小心:

// 非常危险:
std::string_view substring(const std::string& s, std::size_t idx = 0);

// 因为:
auto sub = substring("very nice", 5); // 返回临时string的视图
                                      // 但是临时string已经被销毁了
std::cout << sub << '\n';     // 运行时ERROR:临时字符串s已经被销毁

返回值类型是字符串视图时不要返回字符串

返回值类型是字符串视图时返回字符串是非常危险的。因此,你 不应该 像下面这样写:

class Person {
    std::string name;
public:
    ...
    std::string_view getName() const {  // 不要这么做
        return name;
    }
};

这是因为,下面的代码将会产生运行时错误并导致未定义行为:

Person createPerson();
auto n = createPerson().getName();  // OOPS:delete临时字符串
std::cout << "name: " << n << '\n'; // 运行时错误

如果把getName()改为返回一个字符串类型的值或引用就不会有这个问题了, 因为n将会变为返回值的拷贝。

函数模板应该使用auto作为返回值类型

注意无意中把字符串作为字符串视图返回是很常见的。 例如,下面的两个函数单独看起来都很有用:

// 为字符串视图定义+,返回string:
std::string operator+ (std::string_view sv1, std::string_view sv2) {
    return std::string(sv1) + std::string(sv2);
}

// 泛型连接函数
template<typename T>
T concat (const T& x, const T& y) {
    return x + y;
}

然而,如果把它们一起使用就很容易导致运行时错误:

std::string_view hi = "hi";
auto xy = concat(hi, hi);   // xy是std::string_view
std::cout << xy << '\n';    // 运行时错误:指向的string已经被销毁了

这样的代码很可能在无意中被写出来。真正的问题在于concat()的返回类型。 如果你把返回类型交给编译期自动推导,上面的例子将会把xy初始化为std::string

// 改进的泛型连接函数
template<typename T>
auto concat (const T& x, const T& y) {
    return x + y;
}

不要在调用链中使用字符串视图来初始化字符串

在一个中途或者最后需要字符串的调用链中使用字符串视图可能会适得其反。 例如,如果你定义了一个有如下构造函数的类Person

class Person {
    std::string name;
public:
    Person (std::string_view n) // 不要这样做
        : name {n} {
    }
    ...
};

传递一个字符串字面量或者之后还会使用的string是没问题的:

Person p1{"Jim"};       // 没有性能开销
std::string s = "Joe";
Person p2{s};           // 没有性能开销

然而,使用move的string将会导致不必要的开销。 因为传入的string首先要隐式转换为字符串视图, 之后会再用它创建一个新的string,会再次分配内存:

Person p3{std::move(s)};  // 性能开销:move被破坏

不要在这里使用std::string_view。以值传参然后把值move到成员里仍然是 最佳的方案(除非你想要双倍的开销):

class Person {
    std::string name;
public:
    Person (std::string n) : name{std::move(n)} {
    }
    ...
};

如果我们必须创建/初始化一个string,直接作为参数创建可以让我们在传参时享受所有可能的优化。 最后只需要简单的把参数move就行了,这个操作开销很小。

因此,如果我们使用一个返回临时字符串的辅助函数来初始化一个字符串:

std::string newName()
{
    ...
    return std::string{...};
}

Person p{newName()};

强制省略拷贝特性将把新string的实质化过程推迟到值被传递给构造函数。 构造函数里我们有了一个叫n的string,这是一个有内存地址的对象 (一个 广义左值(glvalue) )。之后把这个对象的值move到成员name里。

安全使用字符串视图的总结

总结起来就是 小心地使用std::string_view , 也就是说你应该按下面这样调整你的编码风格:

  • 不要在那些会把参数传递给string的API中使用string view。

  • 不要用string view形参来初始化string成员。

  • 不要把string设为string view调用链的终点。

  • 不要返回string view。

  • 除非它只是转发输入的参数,或者你可以标记它很危险,例如,通过命名来体现危险性。

  • 函数模板 永远不应该返回泛型参数的类型 T

  • 作为替代,返回auto类型。

  • 永远不要用返回值来初始化string view。

  • 不要 把返回泛型类型的函数模板的返回值赋给 auto

  • 这意味着AAA( 总是auto(Almost Always Auto) )原则不适用于string view。

如果因为这些规则太过复杂或者太困难而不能遵守,那就完全不要 使用std::string_view(除非你知道自己在做什么)。

19.4 字符串视图类型和操作

这一节详细描述字符串视图类型和操作

19.4.1 字符串视图的具体类型

在头文件<string_view>中,C++标准库为basic_string_view<>提供了很多 特化版本:

  • std::string_view是预定义的字符类型为char的特化模板:
namespace std {
    using string_view = basic_string_view<char>;
}
  • 对于使用宽字符集,例如Unicode或者某些亚洲字符集的字符串,还定义了另外三个类型:
namespace std {
    using u16string_view = basic_string_view<char16_t>;
    using u32string_view = basic_string_view<char32_t>;
    using wstring_view = basic_string_view<wchar_t>;
}

在接下来的几节中,使用哪一种字符串视图并没有任何区别。 这几种字符串视图类的用法和问题都是一样的,因为它们都有相同的接口。 因此,“string view”意味着任何string view类型:string_viewu16string_viewu32string_viewwstring_view。 这本书中的例子通常使用类型string_view,因为欧洲和英美的环境是大部分软件开发的 普遍环境。

19.4.2 字符串视图的操作

表字符串视图的操作列出了字符串视图的所有操作。

操作 效果
构造函数 创建或拷贝一个字符串视图
析构函数 销毁一个字符串视图
= 赋予新值
swap() 交换两个字符串视图的值
==、!=、<、<=、>,>=、compare() 比较字符串视图
empty() 返回字符串视图是否为空
size()、length() 返回字符的数量
max_size() 返回可能的最大字符数
[]、at() 访问一个字符
front()、back() 访问第一个或最后一个字符
<< 将值写入输出流
copy() 把内容拷贝或写入到字符数组
data() 返回nullptr或常量字符数组(没有空字符终止)
查找函数 查找子字符串或字符
begin()、end() 提供普通迭代器支持
cbegin()、cend() 提供常量迭代器支持
rbegin()、 rend() 提供反向迭代器支持
crbegin()、crend() 提供常量反向迭代器支持
substr() 返回子字符串
remove_prefix() 移除开头的若干字符
remove_suffix() 移除结尾的若干字符
hash<> 计算哈希值的函数对象的类型

除了remove_prefixremove_suffix()之外, 所有字符串视图的操作std::string也都有。 然而,相应的操作的保证可能有些许不同,data()的返回值可能是nullptr 或者没有空字符终止。

构造

你可以使用很多种方法来创建字符串视图:用默认构造函数创建、用拷贝函数构造创建、从原生字符数组创建 (空字符终止或者指明长度)、从std::string创建或者从带有sv后缀的字面量创建。 然而,注意以下几点:

  • 默认构造函数创建的字符串视图对象调用data()会返回nullptr。 因此,operator[]调用将无效。
std::string_view sv;
auto p = sv.data();     // 返回nullptr
std::cout << sv[0];     // ERROR:没有有效的字符
  • 当使用空字符终止的字节流初始化字符串视图时,最终的大小是不包括'\0'在内的 字符的数量,另外索引空字符所在的位置是无效的:
std::string_view sv{"hello"};
std::cout << sv;        // OK
std::cout << sv.size(); // 5
std::cout << sv.at(5);  // 抛出std::out_of_range异常
std::cout << sv[5];     // 未定义行为
std::cout << sv.data(); // OOPS:恰好sv后边还有个'\0',所以能直接输出字符指针

你可以指定传递的字符数量来把空字符初始化为字符串视图的一部分:

std::string_view sv{"hello", 6};    // NOTE:包含'\0'的6个字符
std::cout << sv.size();             // 6
std::cout << sv.at(5);              // OK,打印出'\0'的值
std::cout << sv[5];                 // OK,打印出'\0'的值
std::cout << sv.data();             // OK
  • 为了从一个string创建一个字符串视图,有一个为std::string定义的隐式转换运算符。 再强调一次,string保证在最后一个字符之后有一个空字符,字符串视图没有这个保证:
std::string s = "hello";
std::cout << s.size();      // 5
std::cout << s.at(5);       // 抛出std::out_of_range异常
std::cout << s[5];          // OK,打印出'\0'的值
std::cout << s.data();      // OK

std::string_view sv{s};
std::cout << sv.size();     // 5
std::cout << sv.at(5);      // 抛出std::out_of_range异常
std::cout << sv[5];         // 未定义行为
std::cout << sv.data();     // OOPS:只有当sv后有'\0'时才能正常工作
  • 因为后缀sv定义了字面量运算符,所以可以像下面这样创建一个字符串视图:
using namespace std::literals;
auto s = "hello"sv;

注意std::char_traits成员被改为了constexpr, 所以你可以在编译期用一个字符串字面量初始化字符串视图:

constexpr string_view hello = "Hello World!";

结尾的空字符

创建字符串视图的不同方式展示了字符串视图优越的一点,理解这一点是很重要的: 一般情况下,字符串视图的值不以空字符结尾,甚至可能是nullptr。 因此,你应该 总是 在访问字符串视图的字符之前检查size() (除非你知道了长度)。 然而,你 可能 会遇到两个特殊的场景,这两个场景会让人很迷惑:

  • 你可以确保字符串视图的值以空字符结尾,尽管空字符并不是值的一部分。 当你用字符串字面量初始化字符串视图时就会遇到这种情况:
std::string_view sv1{"hello"};      // sv1的结尾之后有一个'\0'

这里,字符串视图的状态可能让人很困惑。这种状态有明确的定义所以可以将它用作空字符结尾的 字符序列。然而,只有当我们明确知道这个字符串视图后有一个不属于自身的空字符时才有明确的定义。

  • 你可以确保'\0'成为字符串视图的一部分。例如:
std::string_view sv2{"hello", 6};   // 参数6使'\0'变为值的一部分

这里,字符串视图的状态可能让人困惑:打印它的话看起来像是只有5个字符, 但它的实际状态是持有6个字符(空字符成为了值的一部分, 使它变得更像一个两段的字符串(视图)(binary string(view)))。

问题在于要想确保字符串视图后有一个空字符的话,这两种方式哪一种更好。 我倾向于不要用这两种方式中的任何一种,但截止目前,C++还没有更好的实现方式。 看起来我们似乎还需要一个既保证以空字符结尾又不需要拷贝字符 的字符串视图类型(就像std::string一样)。 在没有更好的替代的情况下,字符串视图就只能这么用了。 事实上,我们已经可以看到很多提案建议C++标准把返回字符指针的 函数的返回类型替换为string_viewhttps://wg21.link/P0555r0有一个例子)。

哈希

C++标准库保证值相同的字符串和字符串视图的哈希值相同。

修改字符串视图

这里有几个修改字符串视图的操作:

  • 你可以赋予新值或者交换两个字符串视图的值:
std::string_view sv1 = "hey";
std::string_view sv2 = "world";
sv1.swap(sv2);
sv2 = sv1;
  • 你可以跳过开头或结尾的字符(即把起始位置后移或者把结尾位置前移)。
std::string_view sv = "I like my kindergarten";
sv.remove_prefix(2);
sv.remove_suffix(8);
std::cout << sv;    // 打印出:like my kind

注意没有对operator+的支持。因此:

std::string_view sv1 = "hello";
std::string_view sv2 = "world";
auto s1 = sv1 + sv2;    // ERROR

两个操作数都必须是string:

auto s2 = std::string(sv1) + std::string(sv2);   // OK

注意字符串视图没有到string的隐式类型转换,因为这个操作会分配内存所以开销很大。 因此,只能使用显式的转换。

19.4.3 其他类型对字符串视图的支持

理论上讲,任何需要传递字符串值的地方都可以传递字符串视图, 前提是接收者只读取值且不需要空字符结尾。

然而,到目前为止,C++标准只为大多数重要的场景添加了支持:

  • 使用字符串时可以联合使用字符串视图:

  • 你可以从一个字符串视图创建一个string(构造函数是explicit的)。如果字符串视图 没有值(data()返回nullptr),字符串将被初始化为空。

  • 你可以把字符串视图用作字符串的赋值、扩展、插入、替换、比较或查找操作的参数。

  • 存在从string到string view的隐式类型转换。

  • 你可以把字符串视图传给std::quoted,它把参数用双引号括起来输出。例如:

using namespace std::literals;

auto s = R"(some\value)"sv;     // raw string view
std::cout << std::quoted(s);    // 输出:"some\value"
  • 你可以使用字符串视图初始化、扩展或比较文件系统路径。

其他对字符串视图的支持,例如C++标准库中的正则表达式库的支持,仍然缺失。

19.5 在API中使用字符串视图

字符串视图开销很小并且每一个std::string都可以用作字符串视图。 因此,看起来好像std::string_view是更好的用作字符串参数的类型。 然而,有一些细节很重要...

首先,只有当函数按照如下约束使用参数时,使用std::string_view才有意义:

  • 它并不需要结尾有空字符。给一个以单个const char* 为参数而没有长度参数的C函数传递参数时就不属于这种情况。
  • 它不会违反传入参数的生命周期。通常,这意味着接收函数只会在传入值的生命周期结束之前使用它。
  • 调用者函数不应该更改底层字符的所有权(例如销毁它、改变它的值或者释放它的内存)。
  • 它可以处理参数值为nullptr的情况。

注意同时有std::stringstd::string_view重载的函数可能会导致歧义:

void foo(const std::string&);
void foo(std::string_view);

foo("hello");   // ERROR:歧义

最后,记住上文提到的警告:

  • 不要把临时字符串赋给字符串视图。
  • 不要返回字符串视图。
  • 不要在调用链中使用字符串视图来初始化或重设字符串的值。

带着这些考虑,让我们来看一些使用字符串视图进行改进的例子。

19.5.1 使用字符串视图代替string

考虑下列代码:

// 带前缀输出时间点:
void print (const std::string& prefix, const std::chrono::system_clock::time_point& tp)
{
    // 转换为日历时间:
    auto rawtime{std::chrono::system_clock::to_time_t(tp)};
    std::string ts{std::ctime(&rawtime)};   // 注意:不是线程安全的

    ts.resize(ts.size()-1); // 跳过末尾的换行符

    std::cout << prefix << ts;
}

可以被替换为下列代码:

void print (std::string_view prefix, const std::chrono::system_clock::time_point& tp)
{
    auto rawtime{std::chrono::system_clock::to_time_t(tp)};
    std::string_view ts{std::ctime(&rawtime)};  // 注意:不是线程安全的

    ts.remove_suffix(1);    // 跳过末尾的换行符

    std::cout << prefix << ts;
}

最先想到也是最简单的改进就是把只读字符串引用prefix换成字符串视图, 只要我们不使用会因为没有值或者没有空终止符而失败的操作就可以。 这个例子中我们只是打印字符串视图的值,这是没问题的。 如果字符串视图没有值(data()返回nullptr)将不会输出任何字符。 注意字符串视图是以值传参的,因为拷贝字符串视图的开销很小。

我们也对内部ctime()返回的值使用了字符串视图。 然而,我们必须小心保证当我们在字符串视图中使用它时它的值还存在。 也就是说,这个值只有在下一次ctime()或者asctime()调用之前有效。 因此,在多线程环境下,这个函数将导致问题(使用string时也有一样的问题)。

如果函数返回把前缀和时间点连接起来的字符串,代码可能会像下面这样:

std::string toString (std::string_view prefix, const std::chrono::system_clock::time_point& tp)
{
    auto rawtime{std::chrono::system_clock_to_time_t(tp)};
    std::string_view ts{std::ctime(&rawtime)};  // 注意:不是线程安全的

    ts.remove_suffix(1);    // 跳过末尾的换行符
    return std::string{prefix} + ts; // 很不幸没有两个字符串视图的+运算符
}

注意我们不能简单地用operator+连接两个字符串视图。 我们必须把其中一个转换为std::string (很不幸这个操作会分配不必要的内存)。如果字符串视图没有值 (data()返回nullptr),字符串将为空。

另一个使用字符串视图的例子是使用字符串视图和 并行算法来排序子字符串:

sort(std::execution::par, coll.begin(), coll.end(),
     // 译者注:此处原文是
     // sort(coll.begin(), coll.end(),
     // 应是作者笔误

     [] (const auto& a, const auto& b) {
         return std::string_view{a}.substr(2) < std::string_view{b}.substr(2);
     });

要比使用string的子字符串快得多:

sort(std::execution::par, coll.begin(), coll.end(),
     [] (const auto& a, const auto& b) {
         return a.substr(2) < b.substr(2);
     });

这是因为string的substr()函数会返回一个分配自己内存的新字符串。