第十二篇：为用户设计良好的接口

Posted 2020-08-29 穆晨

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了第十二篇：为用户设计良好的接口相关的知识，希望对你有一定的参考价值。

前言

作为一名优秀的程序员，必须保证自己的代码能提供正确的，完善的接口，如此方能和同事，甲方更好的沟通合作，也让自己的代码更加地容易维护。

本文将介绍一些设计优秀接口的思路。

思路一：导入新的类型

下面还是先看这个例子，我定义了一个存储日期的 Date 类：

1 class Date
2 {
3 public:
4     Date(int month, int day, int year);
5     // ......
6 };

可用以下方法定义一个 Date 对象：

1 Date d(30, 3, 1995);

可有些用户会犯很蠢的错误，比如：

1 Date d(30, 3, 1995);

显然，他用户将接口的参数输错位了。然而，优秀的接口应当能够友好反馈错误信息给用户，这种情况下，最好的策略就是定义新的类型，请参考下面这个 Date 类的设计：

 1 class Day
 2 {
 3 public:
 4     explicit Day(int d)
 5         :val(d) {}
 6     // ......
 7 private:
 8     int val;
 9 };
10 
11 class Month
12 {
13 public:
14     static Month Jan() {
15         return Month(1);
16     }
17     static Month Feb() {
18         return Month(2);
19     }
20     // ......
21 
22 private:
23     explicit Month(int m) {
24         val = m;
25     }
26     // ......
27 
28     int val;
29     // ......
30 };
31 
32 class Year
33 {
34 public:
35     explicit Year(int y)
36         :val(y) {}
37 private:
38     int val;
39 };

而定义一个 Date 对象，可采用如下方式：

1 Date d(Month::Feb(), Day(30), Year(1995));

在日，月，年各个类中，还可以实现更高级的封装。

思路二：引导用户进行正确编码

这里继续上一篇文章中提到的智能指针的一个例子，这里要说明的是，当时给出的那个工厂函数：

1 class Investment
2 {
3     // ......
4 };
5 
6 Investment * createInvestment();

并不是很好的一种设计。

为啥？因为用户可能忘了使用智能指针把 Investment * 接过去。而使用下面的工厂函数接口设计可以有效的避免这个问题：

1 std::tr1::shared_ptr<Investment> createInvestment();

这样就让用户你不用智能指针都不行了，哈哈。

甚至你还可以更过分，指定智能指针在资源被指数为0的时候要调用的析构函数：

std::tr1::shared_ptr<Investment> createInvestment()
{
    // 指定智能指针类型及删除器
    std::tr1::shared_ptr<Investment>retVal (static_cast<Investment *>(0), getRidOfInvestment);
    
    // retVal = ...
    // 令 retVal 指向正确的对象

    return retVal;
}

上段代码中的getRidOfInvestment是你自己指定的删除器。