如何写好C代码之函数接口

为什么80%的码农都做不了架构师？>>>   

如要实现一个需求：判断当前时间是晚上还是白天(假设早上6点到晚上18点为白天，其他时间为晚上)，最直接实现：

const char *get_time_day_or_night()
{
    time_t now = time();
    strcut tm local_time;
    gmtime_r(&now, &local_time);
    //假设早上6点到晚上18点为白天
    if (local_time.tm_hour > 7 && local_time.tm_hour < 19)
    {
        return "day";
    }
    else
    {
        return "night";
    }
}

从功能方面讲这段代码完全满足需求。但是它有两个问题：

• 从测试角度讲：我们无法给这个用例写出完整的代码测试代码。
• 从扩展性角度讲：我们无法获取任意时间是白天还是晚上。

造成这种情况的根本原因是函数调用了系统接口time ，time的返回值作为函数的输入出现在函数内部，导致我们无法全面控制函数的输入。所以从测试方面讲，如果要测试返回"day"情况，必须在白天运行；反之必须在晚上运行。从扩展性方面讲，如果我们要判断已经存在的时间是白天还是网上，这个函数无法做到，而如果要另外开发一个函数，内部90%的代码都是一样的。为了解决上面的问题，我们把time的返回结果作为参数传入：

const char *get_time_day_or_night(time_t now)
{
    strcut tm local_time;
    gmtime_r(&now, &local_time);
    //假设早上6点到晚上18点为白天
    if (local_time.tm_hour > 7 && local_time.tm_hour < 19)
    {
        return "day";
    }
    else
    {
        return "night";
    }
}

现在从测试角度讲，可以在任何时候测试函数的各个场景的返回值；从使用角度讲，无论是当前时间，还是已经存在的任意时间，都可以判断其实白天还是晚上。

所以开发一个函数接口要从下面几个方面考虑：

• 函数的输入是什么，输出是什么。
• 怎样更容易测试接口。
• 接口对于用户来说，使用是否有扩展性。
• 函数内部是否调用了外部API来获取数据。如果有，将其参数化。

转载于:https://my.oschina.net/sundq/blog/3000794