c++ - 设计更好的API接口(interface)，以将结构从一个类传递到另一个类

coder 2024-02-08 原文

As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center提供指导。

已关闭8年。

我坚信以下设计理念:

1>应该在尽可能靠近数据存储的地方实现服务。

2> Getter和Setter是邪恶的，应谨慎使用。

我宁愿在这里不争论上面的两个论点，并假设它们有自己的优势。

这是我当前面临的挑战。我有两个类(即AComputer和A)，其中AComputer为A提供一些服务，而A保留所有基本数据成员。

事实:由于系统设计的原因，我不允许在AComputer中合并A。我知道，这打破了我的观点:1>计算应该与数据保持一致。

当将数据从A传递到AComputer时，我们必须传递10个(大约)单个参数，因此最好设计一个结构来做到这一点，否则构造函数列表会变得疯狂。 AComputer中存储的大多数数据都是A中存储的数据的直接拷贝。我们选择将这些数据存储在AComputer中，因为AComputer中的其他函数也需要这些变量。

这是一个问题(我正在考虑考虑API维护和修改的最佳实践):

1>我们应该在哪里定义传递结构PassData？

2>我们应该为PassData结构提供getter/setter吗？

我提供了以下示例代码来详细说明我的问题。最好能找到一个解决了相同问题的真实工作的开源API，以便我可以从中学习。

如果您查看在PassData m_data;类中定义的私有(private)AComputer，我是故意这样做的。换句话说，如果我们更改了AComputer的基础实现，则可以用单个变量或其他变量替换PassData m_data;，但不要破坏PassData的接口(interface)。
因此，在此设计中，我没有为PassData结构提供获取/设置方法。

谢谢

class AComputer
{
public:
    struct PassData
    {   // int type just used as an illustration. Real data has different types,
        // such as double, data, string, enum, etc.
        // Note: they are not exact copies of variables from A but derived from them
        int m_v1;
        // from m_v1 to m_v10
        //...
        int m_v10;
    };

    // it is better to store the passed-in data since other functions also need it.
    AComputer(const PassData& pd) : m_data(pd) {}

    int GetCombinedValue() const
    { /* This function returns a value based the passed-in struct of pd */ }

private:
    PassData m_data;    
};

class A
{
private:
    int m_i1;
    // from m_i1 to m_i10
    // ...
    int m_i10;
    // from m_i11 to m_i20
    // ...
    int m_i20;

    boost::shared_ptr<AComputer> m_pAComputer;

public:
    A()
    {
        AComputer::PassData aData;
        // populate aData ...
        m_pAComputer = boost::shared_ptr<AComputer>(new AComputer(aData));
    }

    int GetCombinedValue() const
    {
        return m_pAComputer->GetCombinedValue();
    }
};

最佳答案

您说，我认为最好在开始之前澄清几点:

If you look at private PassData m_data; defined in class AComputer, I do this in purpose. In other words, if we change the underlying implementation of AComputer, we can replace PassData m_data; with individual variables or something else but NOT break the interface of PassData.

事实并非如此，PassData是您界面的一部分!您不能在不破坏客户端代码的情况下替换PassData，因为在AComputer的构造函数中需要PassData。 PassData不是实现细节，而是纯接口(interface)。

需要澄清的第二点:

2> Getter and Setter are evil and should be used carefully.

正确的!但是您应该知道，POD(普通数据结构)甚至更糟。使用POD代替带有getter和setter的类的唯一优点是，您可以省去编写函数的麻烦。但是真正的问题仍然是开放的，您的类的接口(interface)太麻烦了，很难维护。

设计始终是不同需求之间的权衡:

一种错误的灵活性

您的库已分发，并且许多代码正在使用您的类。在这种情况下，PassData的变化将是巨大的。如果您可以在运行时付出很小的代价，则可以使您的界面更灵活。例如，AComputer的构造函数将是:

AComputer(const std::map<std::string,boost::any>& PassData);

看看boost::any here。
您还可以为 map 提供factory，以帮助用户轻松创建 map 。

专业版

如果您不再需要字段，则代码不变。

缺点

运行时价格小。

丢失编译器类型安全检查。

如果您的函数需要另一个必填字段，那么您仍然会遇到麻烦。客户端代码将编译，但不会正确运行。

总体而言，这种解决方案不好，到最后它只是原始解决方案的一个花哨的版本。

策略模式

struct CalculateCombinedValueInterface
{
   int GetCombinedValue()=0;
   virtual ~CalculateCombinedValueInterface(){}
};

class CalculateCombinedValueFirst : CalculateCombinedValueInterface
{
   public:
       CalculateCombinedValueFirst(int first):first_(first){}
       int GetCombinedValue(); //your implementation here
   private:
       //I used one field but you get the idea
       int first_;
};

客户端代码将是:

CalculateCombinedValueFirst* values = new CalculateCombinedValueFirst(42);

boost::shared_ptr<CalculateCombinedValueInterface> data(values);

现在，如果要修改代码，则不应该触摸已经部署的界面。面向对象的解决方案为此提供了一个从抽象类继承的新类。

class CalculateCombinedValueSecond : CalculateCombinedValueInterface
{
   public:
       CalculateCombinedValueFirst(int first,double second)
           :first_(first),second_(second){}
       int GetCombinedValue(); //your implementation here
   private:
       int first_;
       double second_;
};

客户将决定是升级到新类还是保留现有版本。

专业版

在不中断客户端代码的情况下改善您的界面。

您没有触及现有代码，但是在新文件中引入了新功能。

如果需要较小的粒度控件，则可能要使用template method design pattern。

缺点

使用虚函数的开销(基本上是几皮秒!)

您不能破坏现有代码。您必须保持现有界面不变，并添加一个新类来对不同行为进行建模。

参数数目

如果在一个函数中输入一组十个参数，则这些值很可能在逻辑上相关。您可以在类中收集其中一些值。这些类可以组合在另一个类中，这将是您函数的输入。一个类中有10个(或更多!)数据成员的事实应该引起关注。

single responsibility principle说:

改变类(class)的理由不应该有一个以上的原因。

该原则的必然结果是:您的类(class)必须很小。如果您的类(class)有20位数据成员，则很可能会找到很多更改它的理由。

结论

在为客户端提供接口(interface)(任何类型的接口(interface))之后，您将无法对其进行更改(一个很好的示例是编译器需要多年使用的C++中所有过时的功能)。请注意提供隐式接口(interface)的接口(interface)。在您的示例中，PassData不是实现细节，而是类接口(interface)的一部分。

参数的数量表明您的设计需要进行审查。换一个大类很难。您的类应该很小，并且仅通过接口(interface)(C++ lang语中的抽象类)依赖于其他类。

如果您的类(class)是:

1)体积小，并且只有一个理由需要更改

2)从抽象类派生

3)其他类使用指向抽象类的指针对其进行引用

您的代码可以轻松更改(但是必须保留已经提供的接口(interface))。

如果您不满足所有这些要求，则会遇到麻烦。

注:如果设计使用静态多态而不是提供动态多态，则要求2)和3)可以更改。

关于c++ - 设计更好的API接口(interface)，以将结构从一个类传递到另一个类，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/10385951/

上一篇：c++ - 我在 Xcode 中使用 C++11 时遇到一些问题

下一篇：C++:array.size() 是循环的良好条件吗？

相关文章：

c++ - 我可以使用什么库在 C++ 中发送 POST 和 GET 请求？

javascript - 你能记录别人使用 swagger 开发的 API 吗？

PHP YouTube Api V3 MaxResults 不工作

c++ - 在事件的 OS X 桌面上保留一个窗口

c++ - 对于 vector 中的指针，我们应该在删除之前还是之后删除？

api - 将 OAuth 2.0 身份验证添加到 RESTful API

c# - 设计翻译 API - 如何处理空格

c# - 请求和操作之间的 Asp.net 核心中间件路由延迟

c++ - SDL中screenSurface->format是什么意思？

java - JNI/ Kotlin : Is it possible to pass delegate to JNI?

amp interface br code section c++api

有关c++ - 设计更好的API接口(interface)，以将结构从一个类传递到另一个类的更多相关文章

ruby-on-rails - Rails - 子类化模型的设计模式是什么？ - 2
我有一个模型:classItem项目有一个属性“商店”基于存储的值，我希望Item对象对特定方法具有不同的行为。Rails中是否有针对此的通用设计模式？如果方法中没有大的if-else语句，这是如何干净利落地完成的？最佳答案通常通过Single-TableInheritance. 关于ruby-on-rails-Rails-子类化模型的设计模式是什么？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.co
ruby - 使用 Vim Rails，您可以创建一个新的迁移文件并一次性打开它吗？ - 2
使用带有Rails插件的vim，您可以创建一个迁移文件，然后一次性打开该文件吗？textmate也可以这样吗？最佳答案你可以使用rails.vim然后做类似的事情::Rgeneratemigratonadd_foo_to_bar插件将打开迁移生成的文件，这正是您想要的。我不能代表textmate。关于ruby-使用VimRails，您可以创建一个新的迁移文件并一次性打开它吗？，我们在StackOverflow上找到一个类似的问题： https://sta
ruby-on-rails - Rails - 一个 View 中的多个模型 - 2
我需要从一个View访问多个模型。以前，我的links_controller仅用于提供以不同方式排序的链接资源。现在我想包括一个部分(我假设)显示按分数排序的顶级用户(@users=User.all.sort_by(&:score))我知道我可以将此代码插入每个链接操作并从View访问它，但这似乎不是“ruby方式”，我将需要在不久的将来访问更多模型。这可能会变得很脏，是否有针对这种情况的任何技术？注意事项:我认为我的应用程序正朝着单一格式和动态页面内容的方向发展，本质上是一个典型的网络应用程序。我知道before_filter但考虑到我希望应用程序进入的方向，这似乎很麻烦。最终从任何
ruby-on-rails - 渲染另一个 Controller 的 View - 2
我想要做的是有2个不同的Controller，client和test_client。客户端Controller已经构建，我想创建一个test_clientController，我可以使用它来玩弄客户端的UI并根据需要进行调整。我主要是想绕过我在客户端中内置的验证及其对加载数据的管理Controller的依赖。所以我希望test_clientController加载示例数据集，然后呈现客户端Controller的索引View，以便我可以调整客户端UI。就是这样。我在test_clients索引方法中试过这个:classTestClientdefindexrender:template=>
ruby-on-rails - 如何优雅地重启 thin + nginx？ - 2
我的瘦服务器配置了nginx，我的ROR应用程序正在它们上运行。在我发布代码更新时运行thinrestart会给我的应用程序带来一些停机时间。我试图弄清楚如何优雅地重启正在运行的Thin实例，但找不到好的解决方案。有没有人能做到这一点？最佳答案 #Restartjustthethinserverdescribedbythatconfigsudothin-C/etc/thin/mysite.ymlrestartNginx将继续运行并代理请求。如果您将Nginx设置为使用多个上游服务器，例如server{listen80;server
ruby-on-rails - 如果 Object::try 被发送到一个 nil 对象，为什么它会起作用？ - 2
如果您尝试在Ruby中的nil对象上调用方法，则会出现NoMethodError异常并显示消息:"undefinedmethod‘...’fornil:NilClass"然而，有一个tryRails中的方法，如果它被发送到一个nil对象，它只返回nil:require'rubygems'require'active_support/all'nil.try(:nonexisting_method)#noNoMethodErrorexceptionanymore那么try如何在内部工作以防止该异常？最佳答案像Ruby中的所有其他对象
ruby-on-rails - 使用 rails 4 设计而不更新用户 - 2
我将应用程序升级到Rails4，一切正常。我可以登录并转到我的编辑页面。也更新了观点。使用标准View时，用户会更新。但是当我添加例如字段:name时，它不会在表单中更新。使用devise3.1.1和gem'protected_attributes'我需要在设备或数据库上运行某种更新命令吗？我也搜索过这个地方，找到了许多不同的解决方案，但没有一个会更新我的用户字段。我没有添加任何自定义字段。最佳答案如果您想允许额外的参数，您可以在ApplicationController中使用beforefilter，因为Rails4将参数
ruby - 为什么 SecureRandom.uuid 创建一个唯一的字符串？ - 2
关闭。这个问题需要detailsorclarity.它目前不接受答案。想改进这个问题吗？通过editingthispost添加细节并澄清问题.关闭8年前。Improvethisquestion为什么SecureRandom.uuid创建一个唯一的字符串？SecureRandom.uuid#=>"35cb4e30-54e1-49f9-b5ce-4134799eb2c0"SecureRandom.uuid方法创建的字符串从不重复？
ruby-on-rails - Rails - 从另一个模型中创建一个模型的实例 - 2
我有一个正在构建的应用程序，我需要一个模型来创建另一个模型的实例。我希望每辆车都有4个轮胎。汽车模型classCar轮胎模型classTire但是，在make_tires内部有一个错误，如果我为Tire尝试它，则没有用于创建或新建的activerecord方法。当我检查轮胎时，它没有这些方法。我该如何补救？错误是这样的:未定义的方法'create'forActiveRecord::AttributeMethods::Serialization::Tire::Module我测试了两个环境:测试和开发，它们都因相同的错误而失败。最佳答案
ruby-on-rails - ActionController::RoutingError: 未初始化常量 Api::V1::ApiController - 2
我有用于控制用户任务的Rails5API项目，我有以下错误，但并非总是针对相同的Controller和路由。ActionController::RoutingError:uninitializedconstantApi::V1::ApiController我向您描述了一些我的项目，以更详细地解释错误。应用结构路线scopemodule:'api'donamespace:v1do#=>Loginroutesscopemodule:'login'domatch'login',to:'sessions#login',as:'login',via::postend#=>Teamroutessc

c++ - 设计更好的API接口(interface)，以将结构从一个类传递到另一个类

有关c++ - 设计更好的API接口(interface)，以将结构从一个类传递到另一个类的更多相关文章

随机推荐