最近开始看《Effective C++》,为了方便以后回顾,特意做了笔记。若本人对书中的知识点理解有误的话,望请指正!!!
设计一个好接口必须遵守三条规则:
- 必须考虑用户可能做出什么样的错误
- 要把接口设计得一致
- 不要要求用户记得必须做某事
必须考虑用户可能做出什么样的错误:
欲开发一个”容易被正确使用,不容易被误用“的接口,首先必须考虑用户可能做出什么样的错误。假设你为一个用来表现日期的类设计构造函数:
class Date{
public:
Date(int month, int day, int year); //美式标准,2021-11-8,美国表示成11/8/21
...
};
这个接口在美国很通情达理,但它的用户很容易犯下至少两个错误:
-
以错误的顺序传递参数
Date d(8,11,2021);//英式标准,2021-11-8,英国表示成8/11/21
-
传递一个无效的月份或天数
Date d(2,30,2021);//应该是3月30日,而不是2月30日
我们可以自定义类型来表示年月日,如
class Day{
explicit Day(int d):val(d){}
int val;
};
class Month{
explicit Month(int m):val(m){}
int val;
};
class Year{
explicit Year(int y):val(y){}
int val;
};
class Date{
Date(const Month& m,const Day& d,const Year& y);
...
};
//使用Date类型表示2021-11-8
Date d(8,11,2021); //错误,参数类型不匹配
Date d(Day(8),Month(11),Year(2021)); //错误,参数类型不匹配
Date d(Month(11),Day(8),Year(2021)); //正确
参数类型顺序问题解决后,那么有时传入的参数的值不合理,如月份只有1~12月。办法之一是利用 enum
表现月份,但它不具备我们希望拥有的类型安全性,比较安全的做法是预先定义所有的月份:
class Month{
public:
static Month Jan(){return Month(1);}
static Month Feb(){return Month(2);}
...
static Month Nov(){return Month(11);}
static Month Dec(){return Month(12);}
...
private:
explicit Month(int m); //explicit禁止参数隐式转换,private禁止用户生成自定义的月份
...
};
//使用
Date d(Month::Nov(), Day(30), Year(1995)); //正确
要把接口设计得一致:
”一致性“更能导致”接口容易被正确使用“,”不一致性“更能加剧接口的恶化。STL容器的接口十分一致(虽然不是完美地一致),这使它们非常容易被使用。例如每个STL容器接口都有一个名为 size()
的成员函数,它会告诉调用者目前容器内有多少对象。
在Java中,获得数组array的长度使用length property;获得 String
的长度使用 length method,获得List
的大小用 size method。
在.Net中,其 Array
中有个 property 名为 Length,其 List
中有个 property 名为 Count。
不要要求用户记得必须做某事:
任何接口如果要求用户必须记得做某些事请就很容易造成误用,因为用户可能会忘记。如条款13中导入了一个 factory 函数,它返回一个指向 Inv1estment
的派生类的指针,然后再把指针存储在智能指针 shared_ptr
内防止资源泄漏。但用户很可能忘记把指针存储于智能指针中,所以我们可以进一步优化 factory 函数,让它直接返回存储了指向 Investment
的 派生类指针 的智能指针。
Investment* createInvestment(); //优化前的工厂函数
shared_ptr<Investment> createInvestment(); //优化后的工厂函数
使用智能指针的好处是:在引用计数为0时会自主释放存储的资源,如果不是需要进行释放操作,而是调用某个函数,还可以在智能指针的构造函数中指定需要调用的函数作为删除器。这很好松缓了”要求用户记得必须做某事“这个不好的要求。
Note:
- 好的接口很容易被正确使用,不容易被误用。
- ”促进正确使用“的方法包括接口的一致性,以及与内置类型的行为兼容
- ”阻止误用“的方法包括建立新类型、限制类型上的操作,束缚对象值,以及消除用户的资源管理责任