對于許多C ++開發(fā)人員來說，API設(shè)計(jì)可能會在其優(yōu)先級列表中排名第3或第4。大多數(shù)開發(fā)人員都傾向于使用C ++來獲得原始功能和控制權(quán)。因此，性能和優(yōu)化的想法占據(jù)這些開發(fā)者的時(shí)間的百分之八十。
當(dāng)然，每個(gè)C ++開發(fā)人員都會考慮頭文件設(shè)計(jì)的各個(gè)方面，但是API設(shè)計(jì)不僅僅是頭文件設(shè)計(jì)那樣。事實(shí)上，我強(qiáng)烈建議每一個(gè)開發(fā)人員在其API的設(shè)計(jì)上，無論是面向公共還是面向內(nèi)部，都給予一些幫助，因?yàn)檫@樣可以節(jié)省你大量的維護(hù)成本，提供平滑的升級路徑，并為你的客戶節(jié)省麻煩。
下面列出的許多錯(cuò)誤都是我自己的經(jīng)驗(yàn)和我從Martin Reddy的精彩書籍《C ++ API Design》（我強(qiáng)烈推薦的書）中學(xué)到的東西的結(jié)合。如果你真的想要深入了解C ++ API設(shè)計(jì)，那么你應(yīng)該閱讀Martin Reddy的書，然后使用下面的列表作為更多的清單來強(qiáng)制執(zhí)行代碼審查。
為什么這是一個(gè)錯(cuò)誤？
因?yàn)槟悴恢缹⑹褂媚膫€(gè)代碼庫，特別是對于外部API。如果不將API功能限制在命名空間中，則可能導(dǎo)致與該系統(tǒng)中使用的其他API發(fā)生名稱沖突。
例如：讓我們考慮一個(gè)非常簡單的API和使用它的客戶端類：
重慶分公司
重慶分公司
//API - In Location.h
class vector
{
public:
vector(double x, double y, double z);
private:
double xCoordinate;
double yCoordinate;
double zCoordinate;
};
//Client Program
#include "stdafx.h"
#include "Location.h"
#include
using namespace std;
int main()
{
vector myVector;
myVector.push_back(99);
return 0;
}
如果有人試圖在同時(shí)使用std::vector的項(xiàng)目中使用這個(gè)類，他們會得到一個(gè)錯(cuò)誤:
“error C2872: ‘vector’: ambiguous symbol”
這是因?yàn)榫幾g器無法決定客戶端代碼引用的向量是std::vector還是location.h中定義的vector對象。
如何解決這個(gè)問題？
始終將API放在自定義命名空間中，例如：
//API
namespace LocationAPI
{
class vector
{
public:
vector(double x, double y, double z);
private:
double xCoordinate;
double yCoordinate;
double zCoordinate;
};
}
另一種方法是為所有公共API符號添加一個(gè)唯一的前綴。如果遵循此約定，我們將調(diào)用我們的類“l(fā)vector”而不是“vector”。此方法用于OpenGL和QT。
在我看來，如果你正在開發(fā)純C的API，這是有道理的。確保所有公共符號符合此唯一命名約定是另一個(gè)令人頭痛的問題。如果你正在使用C ++，那么你應(yīng)該只在命名空間中對API功能進(jìn)行分組，讓編譯器為你完成繁重的任務(wù)。
我還強(qiáng)烈建議你使用嵌套命名空間來進(jìn)行功能分組或?qū)⒐睞PI與內(nèi)部API分開。一個(gè)很好的例子是Boost庫，它們可以自由地使用嵌套的命名空間。例如，在根“boost”命名空間內(nèi)，boost :: variant包含Boost Variant API的公共符號，boost :: detail :: variant包含該API的內(nèi)部詳細(xì)信息。
為什么這是一個(gè)錯(cuò)誤？
這將導(dǎo)致被引用命名空間中的所有符號在全局命名空間中變得可見，并首先抵消掉使用命名空間的好處。
另外：
如何解決這個(gè)問題？
//File:MyHeader.h:
class MyClass
{
private:
Microsoft::WRL::ComPtr _parent;
Microsoft::WRL::ComPtr _child;
}
//File:MyHeader.h:
class MyClass
{
namespace wrl = Microsoft::WRL; // note the aliasing here !
private:
wrl::ComPtr _parent;
wrl::ComPtr _child;
}有關(guān)與C ++頭文件相關(guān)的其他問題，請參閱帖子“十大C ++頭文件錯(cuò)誤以及如何修復(fù)它們”（https://www.acodersjourney.com/top-10-c-header-file-mistakes-and-how-to-fix-them/）。
more to read at https://mp.weixin.qq.com/s/Yyno5VNHr88BaQvMoZafVA
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
