Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
archibate authored Sep 13, 2024
1 parent 2977e0a commit 03889fc
Showing 1 changed file with 81 additions and 15 deletions.
96 changes: 81 additions & 15 deletions docs/no_more_new.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,31 +222,97 @@ int func() {
过去,人们使用 `goto` 大法拙劣地在提前返回时 `delete` 动态内存:

```cpp
int func() {
Foo *foo1 = nullptr;
Foo *foo2 = nullptr;
int main() {
Foo *foo1, *foo2;
int ret = 0;
foo1 = new Foo();
...
foo2 = new Foo();
...
if (出错) {
goto EXIT;
ret = -1;
goto out_foo1;
}
...
EXIT:
if (nullptr != foo1) {
delete foo1;
}
if (nullptr != foo2) {
delete foo2;
Foo *foo2 = new Foo();
...
if (出错) {
ret = -2;
goto out_foo2;
}
return 0;
...
out_foo2: delete foo2;
out_foo1: delete foo1;
return ret;
}
```

这就会让编写程序的人精神紧绷,更加仔细的检查 `new``delete` 是否配对,`goto EXIT` 会不会有其他负面影响。享受不到编程的快乐就算了,反而在遭罪。。。
这对于“写”程序的人,其实还不算什么,无非就是注意匹配,反正都是一次性写完就得了。

真正遭罪的是“改”程序的人,如果他要删掉foo1,那么他需要在两个地方来回跳转,如果foo1变成 `new[]` 了,那么他需要跳到下面把 `delete foo1` 也改成 `delete[] foo1`。如果foo1要改名,那么还需要跳到下面 `out_foo1:` 标签也改了。如果要新增一个foo3指针,那还需要跳到上面加个 `Foo *foo3;`,下面加个标签和 delete。

> {{ icon.fun }} BUG漫漫其修远兮,吾将上下而求索。
你是否遇到过写程序梭哈,事后“上下求索”的情况?同一个变量 foo 的生命周期被极限撕扯,分居两地,极大的妨碍了我们改程序的效率。

而统计表明,程序员10%的时间用于写代码,90%的时间花在改代码上。节约改代码的时间,就是节约程序员90%的生命。改代码不容易出错,可以省去软件中90%的BUG。

所以,除非你是一次性交差项目不打算更新了,或者确认了改代码的人不会是你,否则必然要用包括智能指针、设计模式在内的各种手段竭力避免代码分散化。

在一个庞大的代码系统中看到原始指针是最头疼的:

```cpp
Student *getstu(const char *name);
```
没有任何信息告诉我:
1. 这个指针指向对象生命周期如何?
2. 要我负责释放内存吗?
3. 如何释放,`delete`、`delete[]`、`free`、还是 `fclose`?
4. 可以是空指针吗?
5. 数组还是单个对象?
6. 如果是数组,那么长度多少?是C风格0结尾字符串吗?
7. 是否移交所有权?
8. 共享或独占?
9. 该资源可以拷贝吗?
10. 如果可以,如何拷贝?
而你只能通过查阅文档,才能确认这些信息,拖慢了开发效率。
而使用 RAII 容器(不仅是只能指针)作为类型,就能让人一眼就看出以上10个信息。
```cpp
gsl::not_null<std::unique_ptr<Student>> getstu1(std::string_view name);
Student &getstu2(std::string_view name);
```

以上代码中,一看就明白,getstu1会移交所有权,且不可能为空;getstu2不转移所有权,仅仅只是提供给调用者访问,且不可能为空。

传统指针因为语义不明确,功能多样化,有用错的可能,例如用户可能偷懒不看文档,就擅自瞎写:

```cpp
char name;
Student *stu = getstu(&name);
if (stu == NULL) exit(1);
free(stu);
```
实际上 `getstu` 的参数 `name` 需要是一个 C 风格 0 结尾字符串,用户却不小心当作单个 `char` 的指针写了,编译器没有报错。
而 `stu` 实际上是 `getstu` 返回给调用者的临时引用,并不移交所有权,而用户却想当然的释放了。
并且实际上 `getstu` 从不返回空指针,用户根本不用提心吊胆地检查。
一个优质的函数接口,就不应该给用户这种犯错的机会。
我知道,你会说,`std::string` 不也能从 `&name` 构造,放任编译通过,不也会犯错吗?
是这样的,你甚至可以从 `0` 构造 `std::string`,编译一样通过,程序会直接崩溃:
```cpp
std::string s = 0; // 0 被当作 NULL,从而调用构造函数 std::string(const char *)
```

此外,`new``delete` 使用不配套时,也会导致严重的错误。由于 `new``delete` 是基于指针操作的,但是在很庞大的代码系统中我们拿到一个指针 `data *ptr` 后。这个 `ptr` 是空指针吗?还是已经被释放了吗?还是已经有内存了?还是交由我们申请内存?很容易忘记 `new` 而直接 `delete`,或者对同一个指针 `new` 了两次,或者没有 `delete` 等等。看到屎山代码后的坏心情会导致代码维护难度指数级增加
标准库里不符合小彭老师设计模式的多了去了,标准库的垃圾是历史遗留问题,不是小彭老师的问题

而智能指针,不论是提前返回还是最终的返回,只要是函数结束了,都能自动释放。智能指针使得程序员写出“提前返回式”毫无精神压力,再也不用惦记着哪些需要释放。

Expand Down

0 comments on commit 03889fc

Please sign in to comment.