EC笔记:第4部分:18、接口正确使用,不易被误用

时间:2022-09-22 22:26:32
  • 好的接口容易被正确使用,不易被误用

考虑以下函数:

void
func(int year,int month,int day){

//一些操作

}

这个函数看似合理,因为参数的名字已经暴露了它的用途。但是如果只有寒暑签名呢?如下:

void
func(int,int,int);

就算我告诉你,此处需要日期作为参数,你可能会以月日年、日月年等不同形式作为参数。

正确的做法是把年月日都各自抽象为一个类(或者说是结构体):

struct Year {

int year;

};

struct Month {

int month;

};

struct Day {

int day;

};

void
func(Year year,Month month,Day day){

//一些操作

}

这样即使你只有函数签名,也不会轻易出错。

  • 用于内置类型的行为兼容

尽量要在行为上与现有类型兼容,因为一般用户会先与类型作为参考。

如:int类型不支持:

int a=5;

int b=6;

int c=50;

a+b=c;//错误

那么你自己定义的类型,也不应该有类似的语法:

MyType a;

MyType b;

MyType c;

a+b=c;//尽量不要这样去做,除非你有更好的理由

  • 建立新类型、限制类型上的操作、束缚对象值、消除客户的资源管理责任

为了防止用户犯错,一般的方式就是为我们的新类型加上各种限制,比如限定月份的值为1到12,日期的值为1到31等。在用户输入非法的值的时候给出明确的提示或警告。

  • 设想各种被应用的场景

我们要假设用户各种可能犯错的场景,比如,在多线程环境中使用,如果不支持多线程,就应该明确的在文档中输出。或者是,用户的非法输入,非法调用,我们应该尽可能地进行合法性检验。

尽可能让用户在不改变现有使用习惯的情况下,尽可能的少出错。