深入C++中API的问题详解

前言：本文书写的格式与其它不相同。本文题目说是关于C++ API的思考，其实也不仅仅是C++，对于其它语言同样适用。

API实际是指Application Programming Interface,应用程序编程接口。对API是一套用来控制Windows的各个部件的外观和行为的一套预先定义的Windows函数。在C++中我认为：一个API就是一堆类以及类中方法和字段的集合。
并不是所有的签名都是API的一部分，未公开的部分(private)内容不是API，它不对外承诺兼容性。API广泛定义：凡是有利于在“无绪”的状态下把一个大的系统以组件集成的方法拼装出来的东西都属于API。

为什么要开发API？
我们希望将大块的构建模块“无绪”地集合成应用程序，一些构建模块包含共享库、框架、预先定义好的程序架构，以及这些内容的组合。

如何检查API的质量？
1、可理解性
2、一致性
3、可见性
4、简单的任务应该有简单的方案
5、保护投资

API设计技巧一:
不要把类中的字段直接对外公布，而应该放置在内部。最好让外部用户只能通过set、Get方法来访问字段，千万不要将字段直接公布出来。

使用方法访问字段要好于直接访问字段。如果你在编写API的时候遵守这一建议，那么可以在这个API的下一个版本中对方法的具体实现进行很多改动，如添加数据的验证和校验、覆盖一个方法等，还可以做一些大的变化。如果直接使用指端就不能做上述改动。

API设计技巧二:
使用工厂方法而不是直接使用构造函数来创建一个对象。

使用工厂方法创建对象的好处：
1、工厂方法的返回值并不一定是声明类型的实例，它可以是它子类的实例。使用工厂方法可以更好的体现面向对象语言中多态的优势，代码也会显得更加简洁。
2、每次返回的对象并不一定都是新创建的对象，完全可以将其缓存。相比之下，每次调用构造函数都会创建一个实例，而一个工厂方法可以缓存以前创建的对象，并重用他们，从而节省了内存。
3、对同步控制，在工厂方法中可以将创建对象前后的相应代码进行统一处理。构造函数对这一种情况就无能为力。

API设计技巧三:
让所有的内容不可改，如果不考虑让其拥有子类，就应该让这个类不能被继承。
强烈推荐：不公开构造函数，转而提供工厂方法
 
API设计技巧四:
避免滥用set方法，在不部分情况下set方法是多余的。
建议：小心API中的每一个不必要的set方法

API设计技巧五:
尽可能通过友元的方式来公开功能。为了让用户更加简单明了地使用好你的API，就不要再你的API中公开太多的方法，不要给用户犯错的机会。

API设计技巧六:
避免暴露深层次继承。一旦发现继承体系超过两层时，一定要打住，并多多思考一下，要弄清楚：“我到底设计API还是在复用代码？”如果答案是后者，那么重新审视，并严格设计这个API，或者做好子类化的准备。

赞 (0)

相关推荐

  • c#调用c++方法介绍,window api

    例子1如下: 复制代码 代码如下: //声明部分 [DllImport("um_web_client.dll")]  private static extern int CheckUserName(string UserName); // public static int AuthUserName(string username)  {   if(!IsConnection())   {    StartWebClient(UDBClientIP,UDBClientPort,UDBC

  • C#中通过API实现的打印类 实例代码

    复制代码 代码如下: using System;using System.Collections;using System.Text;using System.Runtime.InteropServices; using System.Security; using System.ComponentModel; using System.Drawing.Printing; namespace PrinterAPI{ public class Printer  {   private Printe

  • 深入C++中API的问题详解

    前言:本文书写的格式与其它不相同.本文题目说是关于C++ API的思考,其实也不仅仅是C++,对于其它语言同样适用. API实际是指Application Programming Interface,应用程序编程接口.对API是一套用来控制Windows的各个部件的外观和行为的一套预先定义的Windows函数.在C++中我认为:一个API就是一堆类以及类中方法和字段的集合.并不是所有的签名都是API的一部分,未公开的部分(private)内容不是API,它不对外承诺兼容性.API广泛定义:凡是有

  • java中栈和队列的实现和API的用法(详解)

    在java中要实现栈和队列,需要用到java集合的相关知识,特别是Stack.LinkedList等相关集合类型. 一.栈的实现 栈的实现,有两个方法:一个是用java本身的集合类型Stack类型:另一个是借用LinkedList来间接实现Stack. 1.Stack实现 直接用Stack来实现非常方便,常用的api函数如下: boolean        isEmpty() // 判断当前栈是否为空 synchronized E        peek() //获得当前栈顶元素 synchro

  • React18 中的 Suspense API使用实例详解

    React18 中的 Suspense API使用实例详解

    目录 什么是新的 ReactJS Suspense API,什么时候应该使用它? 什么是Suspense API? 什么是 transition API? 最后 什么是新的 ReactJS Suspense API,什么时候应该使用它? 何时使用:当组件开始变大并且您在同一页面上有许多组件时,您可能希望开始优化下载到客户端浏览器的方式和时间. 为此,React 为您提供了lazyAPI,它允许您将组件标记为lazy,这意味着被lazy包裹的组件,将会在第一次真正使用时被加载,而不是页面初始化的时

  • 基于angular中的重要指令详解($eval,$parse和$compile)

    在angular的服务中,有一些服务你不得不去了解,因为他可以说是ng的核心,而今天,我要介绍的就是ng的两个核心服务,$parse和$compile.其实这两个服务讲的人已经很多了,但是100个读者就有100个哈姆雷特,我在这里讲讲自己对于他们两个服务的理解. 大家可能会疑问,$eval呢,其实他并不是一个服务,他是scope里面的一个方法,并不能算服务,而且它也基于parse的,所以只能算是$parse的另一种写法而已,我们看一下ng源码中$eval的定义是怎样的就知道了 $eval: fu

  • Java中的反射机制详解

    Java中的反射机制详解

    Java中的反射机制详解 反射,当时经常听他们说,自己也看过一些资料,也可能在设计模式中使用过,但是感觉对它没有一个较深入的了解,这次重新学习了一下,感觉还行吧! 一,先看一下反射的概念: 主要是指程序可以访问,检测和修改它本身状态或行为的一种能力,并能根据自身行为的状态和结果,调整或修改应用所描述行为的状态和相关的语义. 反射是Java中一种强大的工具,能够使我们很方便的创建灵活的代码,这些代码可以再运行时装配,无需在组件之间进行源代码链接.但是反射使用不当会成本很高! 看概念很晕的,继续往下

  • IOS中Json解析实例方法详解(四种方法)

    IOS中Json解析实例方法详解(四种方法)

    作为一种轻量级的数据交换格式,json正在逐步取代xml,成为网络数据的通用格式. 有的json代码格式比较混乱,可以使用此"http://www.bejson.com/"网站来进行JSON格式化校验(点击打开链接).此网站不仅可以检测Json代码中的错误,而且可以以视图形式显示json中的数据内容,很是方便. 从IOS5开始,APPLE提供了对json的原生支持(NSJSONSerialization),但是为了兼容以前的iOS版本,可以使用第三方库来解析Json. 本文将介绍Tou

  • OpenStack 中的Nova组件详解

    Open Stack Compute Infrastructure (Nova) Nova是OpenStack云中的计算组织控制器.支持OpenStack云中实例(instances)生命周期的所有活动都由Nova处理.这样使得Nova成为一个负责管理计算资源.网络.认证.所需可扩展性的平台.但是,Nova自身并没有提供任何虚拟化能力,相反它使用libvirt API来与被支持的Hypervisors交互.Nova 通过一个与Amazon Web Services(AWS)EC2 API兼容的w

  • Android中SQLite 使用方法详解

    Android中SQLite 使用方法详解

    Android中SQLite 使用方法详解 现在的主流移动设备像android.iPhone等都使用SQLite作为复杂数据的存储引擎,在我们为移动设备开发应用程序时,也许就要使用到SQLite来存储我们大量的数据,所以我们就需要掌握移动设备上的SQLite开发技巧.对于Android平台来说,系统内置了丰富的API来供开发人员操作SQLite,我们可以轻松的完成对数据的存取. 下面就向大家介绍一下SQLite常用的操作方法,为了方便,我将代码写在了Activity的onCreate中: @Ov

  • Android 中 ActivityLifecycleCallbacks的实例详解

    Android 中 ActivityLifecycleCallbacks的实例详解           以上就是使用ActivityLifecycleCallbacks的实例,代码注释写的很清楚大家可以参考下, MyApplication如下: package com.cc; import java.util.LinkedList; import android.app.Activity; import android.app.Application; import android.os.Bun

  • python+requests+unittest API接口测试实例(详解)

    python+requests+unittest API接口测试实例(详解)

    我在网上查找了下接口测试相关的资料,大都重点是以数据驱动的形式,将用例维护在文本或表格中,而没有说明怎么样去生成想要的用例, 问题: 测试接口时,比如参数a,b,c,我要先测a参数,有(不传,为空,整形,浮点,字符串,object,过短,超长,sql注入)这些情况,其中一种情况就是一条用例,同时要保证b,c的正确,确保a的测试不受b,c参数的错误影响 解决思路: 符合接口规范的参数可以手动去填写,或者准备在代码库中.那些不符合规范的参数(不传,为空,整形,浮点,字符串,object,过短,超长,

随机推荐