“最好的情况,就是如果客户企图使用某个接口而却没有获得预期的行为,这个代码就不应该通过编译;如果代码通过了编译,它的作为就该是客户想要的。”
所以在接口设计时,应该从用户的角度出发,考虑用户会犯什么错误:
那么用户在调用构造函数时,可能会犯两种错误:
1.把年月日的顺序输乱了。
2.可能会输入一个不合法的日期,比如2月30号之类的。
对付这些错误,最好的办法就是定义新的数据类型来取代原来的int:
还有一种思路可以降低代码出错的可能:就是尽可能让你定义的类型与内置数据类型的行为一致。
如果要求用户必须做某件事,那么就有可能发生错误,因为用户有可能会忘记。典型的操作就是对内存的new和delete。最好的办法就是前面提到过的:以对象管理资源。当对象被析构时,自动释放内存。最典型的用法就使用时shared_ptr:
注意,正确的用法是直接将new出来的对象变为一个智能指针,而类的接口都是使用智能指针的。
总之,好的接口容易被正确的使用,不宜被误用。促进正确使用的办法包括接口的一致性以及与内置类型兼容。阻止误用的办法包括建立新的类型,限制类型的操作,束缚对象值,消除用户的管理管理责任。
所以在接口设计时,应该从用户的角度出发,考虑用户会犯什么错误:
假如设计的是一个日期类:
class Date
{
public:
Date(int m, int d, int y):day(d),month(m),year(y){}
private:
int month;
int day;
int year;
};
那么用户在调用构造函数时,可能会犯两种错误:
1.把年月日的顺序输乱了。
2.可能会输入一个不合法的日期,比如2月30号之类的。
对付这些错误,最好的办法就是定义新的数据类型来取代原来的int:
struct Day
{
//将构造函数声明为explict,可以避免发生隐式类型转化
explicit Day(int d):val(d){}
int val;
};
struct Month
{
explicit Month(int m):val(m){}
int val;
};
struct Year
{
explicit Year(int y):val(y){}
int val;
};
class Date
{
public:
Date(const Month m, const Day d, const Year y):month(m),day(d),year(y){}
private:
Month month;
Day day;
Year year;
};
此时,用户只能这样输入:class Date d1(Month(9),Day(8),Year(2012));这至少避免了参数次序的问题。对于这些参数的取值范围,我们可以使用枚举类型。但是由于枚举类型可以被当做int来使用,所以并不是安全的。比较安全的办法是预先定义所有有效的month:
class Month
{
public:
static Month Jan(){return Month(1);}
static Month Feb(){return Month(2);}
private:
explicit Month(int m):month(m){}
int month;
};
这样的话,你只能这样调用class Date d1(Month::Jan(),Day(8),Year(2012));那么出错的机会就大大降低了。
还有一种思路可以降低代码出错的可能:就是尽可能让你定义的类型与内置数据类型的行为一致。
如果要求用户必须做某件事,那么就有可能发生错误,因为用户有可能会忘记。典型的操作就是对内存的new和delete。最好的办法就是前面提到过的:以对象管理资源。当对象被析构时,自动释放内存。最典型的用法就使用时shared_ptr:
class ManageResouse
{
public:
explicit ManageResouse(tr1::shared_ptr<int> p):ptr(p){}
void value(int i){*ptr = i;}
void printValue(){cout<<*ptr<<endl;}
private:
tr1::shared_ptr<int> ptr;
};
tr1::shared_ptr<int> p ( new int(10));
ManageResouse rs1(p);
ManageResouse rs2(p);
rs1.value(1);
rs2.printValue();
注意,正确的用法是直接将new出来的对象变为一个智能指针,而类的接口都是使用智能指针的。
总之,好的接口容易被正确的使用,不宜被误用。促进正确使用的办法包括接口的一致性以及与内置类型兼容。阻止误用的办法包括建立新的类型,限制类型的操作,束缚对象值,消除用户的管理管理责任。