3

我正在扩展现有的一类新功能，但我对使用哪种设计解决方案表示怀疑。有几个，每个都有优点和缺点。我的情况是这样的：我有一个特殊格式的文件头，我要读取并保存它。有一个名为 FileHeader 的类，它已经实现了一些从/到流的序列化和一些其他功能。我的任务列表中的一项是添加特定的时间戳功能。自 1994 年 1 月 1 日 00:00:00 以来，时间戳应以秒为单位读取/存储。但是 FileHeader 类将日期和时间存储在两个单独的变量中。因此，我需要编写从/到秒到日期和时间的转换。问题是这个功能应该驻留在哪里。我使用 secondsPerDay (60*60*24) 和 dateOrigin (1/1/1994) 作为常量。

我看到有以下选项：

A) 将转换实现为 FileHeader 类的私有方法。然后 secondsPerDay 和 dateOrigin 将是该类的静态私有常量。

//fileheader.h
class FileHeader
{
private:
    static const unsigned secondsPerDate = 60 * 60 * 24;
    static const Date dateOrigin;
    const Date &m_date;
    const Time &m_time;
    unsigned convertToSeconds() const; // convert m_date and m_time to seconds
    void fromSeconds(unsigned secs); // convert and store to m_date and m_time
public:
    void saveToStream(Stream &s) const;
    void restoreFromStream(const Stream &s);
//... other methods
}

//fileheader.cpp
const Date FileHeader::dateOrigin = Date(1994, 1, 1);

这更直接。但我不喜欢的是它给已经很重的课增加了更多的责任。你知道规则：一类=一项责任。例如，维护会很困难。如果有人决定将秒数更改为分钟或其他值，他会重写方法，但如果不够小心，可能会留下静态常量 secondsPerDay，尽管不再需要它。等等。此外，我不喜欢我必须更新头文件这一事实，尽管它只影响实现细节。

B) 仅在 .cpp 文件中的未命名命名空间中执行实现，并使用普通函数和静态变量：

namespace
{
    const unsigned secondsPerDay = 60 * 60 * 24;
    const Date dateOrigin = Date(1994, 1, 1);
    unsigned dateTimeToSeconds(const Date &d, const Time &t) ...
    Date secondsToDate(unsigned secs) ...
    Time secondsToTtime(unsigned secs) ...
}

FileHeader 的保存和恢复方法会调用这些函数。嗯，我更喜欢它。我没有弄乱标题，类的 FileHeader 责任没有增长。但是，如果有人决定将算法更改为使用分钟而不是秒，他可以更改函数，但如果不小心，他会留下不必要的 secondsPerDay 静态变量，即使不再需要它。

C) 在 FileHeader.cpp 中使用未命名的命名空间和其中的专用类。

namespace 
{
    class TimeConverter
    {
    private:
        static const unsigned secondsPerDay = 60 * 60 * 24;
        static const Date dateOrigin;
    public:
        static unsigned secondsFromDateTime(const Date &date, const Time &time) //implementation here...
        static Date dateFromSeconds(unsigned seconds) //implementation here...
        static Time timeFromSeconds(unsigned seconds) //implementation here...
    };
    const Date TimeConverter::dateOrigin = Date(1994, 1, 1);
}

FileHeader 保存和恢复将调用这些静态方法，例如

m_date = TimeConverter::dateFromSeconds(secs);
m_time = TimeConverter::timeFromSeconds(secs);

我个人选择了这个解决方案。它不会弄乱标题，它在视觉上限制了静态变量的范围，因此如果有人将 TimeConverter 的实现从秒更改为分钟，他很可能不会留下不必要的静态变量 secondsPerDay... 目前TimeConverter 不被任何其他类（仅 FileHeader）使用，但如果更改，它可以很容易地移动到它自己的头文件和源文件中。

在编写代码时，我意识到这是我扩展现有类的新实现细节的功能的常用方式。因为我经常这样做，所以我很好奇其他人正在使用什么以及为什么。根据我的经验，95% 的开发人员使用选项 A 并扩展类。所以这里有问题：

  • 还有其他好的和有用的选择吗？

  • 我错过了使用这些选项的一些重要方面或含义吗？

更新：根据以下答案之一的建议，我特此提出选项 D：

namespace TimeConverter
{
    const unsigned secondsPerDay = 60 * 60 * 24;
    const Date dateOrigin = Date(1994, 1, 1);
    unsigned secondsFromDateTime(const Date &date, const Time &time)
    {
        return (date - dateOrigin) * secondsPerDay + time.asSeconds();
    }

    Date dateFromSeconds(unsigned seconds)
    {
        return dateOrigin + seconds / secondsPerDay;
    }

    Time timeFromSeconds(unsigned seconds)
    {
        return Time(seconds % secondsPerDay);
    }
}

以及接下来的一个问题 - D 如何比 C 更好，反之亦然。优缺点都有什么？

4

3 回答 3

1

就个人而言，我会选择选项 B。如果我需要重用该功能，我会将其调整为 C。但我认为为每一件小事创建一个类会导致过多的臃肿和样板。我更喜欢在需要的时候进行抽象，而不是在...... YAGNI的一个变体之前。选项 B 在同一个地方定义和使用功能，这样更容易阅读。另外，正如您所说，它不会弄乱头文件。

于 2014-07-31T07:56:28.437 回答
1

如果我理解正确，您要应用的修改只是实现细节。用户将永远无法修改它。

在我看来，该函数足够通用，可以在其他地方使用，所以我将把它放在不同标题中的命名空间中。

//date time conversions function header
namespace foo
{
   unsigned secondsPerDay();
   unsigned secondsFromDateTime(
                     const Date &date, 
                     const Time &time, 
                     const Date& startOfTime);
   Date dateFromSeconds(unsigned seconds, const Date& startOfTime);
   Time timeFromSeconds(unsigned seconds, const Date& startOfTime);
}

为了样式和清晰度，我将介绍函数 secondsPerDay 而不是全局变量。我相信性能上的差异是可以忽略的（只有分析才能说明）。

真正的区别是使函数采用额外的参数。您将单独测试这些函数，并且可以在 FileHeader 类之外的其他上下文中重用它们。

最后，在您的 FileHeader.cpp 文件中，您将包含标题并定义您的开始日期。

关于选项 C 的最后评论。没有必要在 C++ 中创建仅具有静态方法的类（例如，在不允许使用自由函数的情况下，您需要在 java 中使用它）。命名空间是实现它的 C++ 方式。

于 2014-07-31T10:22:32.147 回答
1

绝对不要与 A 一起使用。如果将其设为私有成员，它仍然是类接口的一部分，只会把它弄乱。

我不会使用 C。我不喜欢所有函数和成员都是静态的类。这并没有真正命名一种事物。它只是对相关的东西进行分组。这就是命名空间的用途。

我会选择 D。我会将其拉出到它自己的 .h 和 .cpp 文件中以方便编写单元测试，然后 #include 仅在 .cpp 文件中，因为它是你的类的实现细节，而不是界面的一部分。

于 2014-08-04T15:31:44.983 回答