如何使用API_api接口有什么优点

yingujun 2018-01-04 20418

接口/时钟/PLL

49人已加入

描述

应用程序接口API是什么

接口是一个抽象概念，一般有好几种层面的接口。Interface可翻译为界面也可翻译为接口，翻译为接口的由来应该是从电器的插口而来（未做考证）。通俗说法：接口就是用来连接而开放的入口。大致有这些类型的接口：硬件接口、用户界面（UI）、软件接口、面向对象接口。

至于API一般仅仅限于应用程序的编程接口。通俗的解释应该是：一个组件（或程序库）提供给开发者进行编程使用的，通过代码可以与之沟通的入口。比如说你下载了一个控件包，通过阅读说明你知道应该如何创建上下文、初始化、设置属性、调用、回调、事件处理，这些就是这个控件包的API。

API一般对应函数，在面向对象领域可能对应类提供的特性，而对于传输协议一般指协议的一种实现所提供的使用该协议的方式。

返回值方法名（参数1，参数2 。。。）这就可以认为是接口。

应用程序接口为：“‘计算机操作系统（Operating system）’或‘程序库’提供给应用程序调用使用的代码”。其主要目的是让应用程序开发人员得以调用一组例程功能，而无须考虑其底层的源代码为何、或理解其内部工作机制的细节。API本身是抽象的，它仅定义了一个接口，而不涉入应用程序如何实现的细节。例如，图形库中的一组API定义了绘制指针的方式，可于图形输出设备上显示指针。当应用程序需要指针功能时，可在引用、编译时链接到这组API，而运行时就会调用此API的实现（库）来显示指针。

应用程序接口API，就是软件系统不同组成部分衔接的约定。由于近年来软件的规模日益庞大，常常需要把复杂的系统划分成小的组成部分，编程接口的设计十分重要。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的维护性和扩展性。应用程序接口是一组数量上千、极其复杂的函数和副程序，可让程序员做很多任务作，譬如“读取文件”、“显示菜单”、“在视窗中显示网页”等等。操作系统的API可用来分配存储器或读取文件。许多系统应用程序借由API接口来实现，像是图形系统、数据库、网络Web服务，甚至是在线游戏。应用程序接口有诸多不同设计。用于快速执行的接口通常包括函数、常量、变量与数据结构。也有其它方式，如通过解释器，或是提供抽象层以屏蔽同API实现相关的信息，确保使用API的代码无需更改而适应实现变化。

应用程序接口经常是软件开发工具包（SDK）的一部分

API又分为（Windows、Linux、Unix等系统的）系统级API，及非操作系统级的自定义API。作为一种有效的代码封装模式，微软Windows的API开发模式已经为许多商业应用开发的公司所借鉴，并开发出某些商业应用系统的API函数予以发布，方便第三方进行功能扩展。如Google、苹果电脑公司，以及诺基亚等手机开发的API等等。

#p##e#

关于API使用

网上有很多API教程，但是都是针对单个API的使用来讲解，但是如果遇到网上没有教程的API呢？如下教程的目的就是这样：当遇到一个不会的API的时候，懂得如何利用资料学会使用这个API。

本文读者需具备的知识：

1、VB的基本语法

2、API、结构体、常数

3、VB的数据类型，C语言的简单数据类型

4、API Viewer 2004（或其他同类软件）的基本使用

5、一定的英文阅读能力

那么要调用一个陌生的API，基本上遵循以下步骤

1、找到相关API、结构体、常数的声明

2、到MSDN阅读这个API的网页指南

3、按照MSDN写代码

实战演示：

这次实战的目标是：GetOpenFileName

首先介绍一下这个API吧，这个API会显示一个打开对话框，给用户选择一个文件打开

这个跟CommonDialog里面的打开对话框是一样的（那干嘛不直接用那个控件？教程用来做演示嘛，而且用API也有他的好处）

第一步：找到声明

找声明主要有两种方法

第一种是通过软件找，例如API Viewer 2004，这类软件内置有绝大部分常用的声明，直接复制即可，方便快捷

第二种是去MSDN找到API的页面，然后复制声明。MSDN是微软的网站，声明肯定是准确的，但是对于VB开发者的劣势是，绝大部分声明都是按照C语言的格式的（至今没见过一个API的页面有VB声明），所以如果不懂C语言的话要转换成VB的声明难度就大了

还有其他方法，例如dump dll文件之类的

本文主要讨论第一种方法，使用的软件是API Viewer 2004，其他同类软件操作大同小异

打开API Viewer 2004，打开Win32api.apv文件，然后选择Declarations一栏，然后选择Subs and Functions，在文本框输入GetOpenFileName，然后就找到这个API的声明了，复制下来，扔进VB的代码里面

好了，现在来仔细看一下这个声明：

Private Declare Function GetOpenFileName Lib “comdlg32.dll” Alias “GetOpenFileNameA” （ByRef pOpenfilename As OPENFILENAME） As Long

可以看到这里有一个陌生的参数类型OPENFILENAME，这明显不是VB的基本数据类型，所以我们需要这个OPENFILENAME的声明

于是回到API Viewer 2004，选择Types一栏，在文本框输入OPENFILENAME，找到声明了，复制下来，扔到VB代码里面

Private Type OPENFILENAME

lStructSize As Long

hwndOwner As Long

hInstance As Long

lpstrFilter As String

lpstrCustomFilter As String

nMaxCustFilter As Long

nFilterIndex As Long

lpstrFile As String

nMaxFile As Long

lpstrFileTitle As String

nMaxFileTitle As Long

lpstrInitialDir As String

lpstrTitle As String

flags As Long

nFileOffset As Integer

nFileExtension As Integer

lpstrDefExt As String

lCustData As Long

lpfnHook As Long

lpTemplateName As String

End Type

继续仔细看这个结构体的声明，可以发现成员都是VB的基本数据类型，说明不需要在找其他声明了

第二步：阅读MSDN对于这个API的解释 & 第三步：按照MSDN写代码

这里说的MSDN不是按F1出来那个MSDN，而是MSDN网站msdn.microsoft.com。这个是微软的官方开发者网站，里面资料齐全绝对是开发者的天堂

网站有中文版本和英文版本，不过强烈建议大家看英文版本，中文版的翻译质量不好（这就是为什么要求有一定的英文阅读能力）

好吧进入了这个官网之后，在最上面的Bing搜索里面打GetOpenFileName，然后搜索

出来的结果，一般选择xxxx function这种页面，这里选的就是第一个结果GetOpenFileName function

http://msdn.microsoft.com/en-us/library/windows/desktop/ms646927（v=vs.85）.aspx

页面打开了，可以看到这个页面分成几大节：

开头：对API的简单介绍

Syntax：语法，也就是API的声明

Parameters：API的参数

Return Value：返回值

Remarks：一些附加的说明

Examples：示例代码，一般都是用C语言写的

Requirements：API对系统的要求等等

API与Windows

API是系统的基石，是Windows的一砖一瓦。

明确一个概念，软件是运行在系统平台的支持上的，软件的功能其实就是向系统伸请，并由系统完成这些功能的过程。那么软件要做的事情如何传递给系统呢，也就是这些API的作用了，系统定义了这些API函数，做为支持软件执行系统功能的接口。不同的操作系统自然API会是不同的。API是一组作为应用程序呼叫某个功能与服务的函数。程序设计师可依据API函数撰写程序，让操作系统或某个程序激活某个程序以执行特定的功能。

基本上，API是操作系统的框架，通常包含在名为.DLL的动态连接库文件中，可控制Windows各个组件、外观与服务。而这一套事先预定的函数，可与在API下方的操作系统的核心沟通，进而呼叫其它程序或服务，且让程序设计师依据API，架构出各种的Windows应用程序。

API 就是应用程序编程接口。它是能用来操作组件、应用程序或者操作系统的一组函数。典型的情况下，API 由一个或多个提供某种特殊功能的 DLL 组成。（java中有所不同，但大同小异）DLL 是一个文件，其中包含了在 Microsoft Windows 下运行的任何应用程序都可调用的函数。运行时，DLL 中的函数动态地链接到调用它的应用程序中。无论有多少应用程序调用 DLL 中的某个函数，在磁盘上只有一个文件包含该函数，且只在它调入内存时才创建该 DLL。

您听到最多的 API 可能是 Windows API，它包括构成 Windows 操作系统的各种 DLL。每个 Windows 应用程序都直接或间接地与 Windows API 互动。Windows API 保证 Windows 下运行的所有应用程序的行为方式一致。

注意随着 Windows 操作系统的发展，现已发布了几个版本的 Windows API。Windows 3.1 使用 Win16 API。Microsoft Windows NTindows 95 和 Windows 98 平台使用 Microsoft Win32 API。除 Windows API 外，其他一些 API 也已发布。例如，邮件应用程序编程接口（MAPI）是一组可用于编写电子邮件应用程序的 DLL。

API 传统上是为开发 Windows 应用程序的 C 和 C++ 程序员编写的，但其他的编程语言（包括VBA）也可以调用 DLL 中的函数。因为大部分 DLL 主要是为 C 和 C++ 程序员编写和整理说明的，所以调用 DLL 函数的方法与调用 VBA 函数会有所不同。在使用 API 时必须了解如何给 DLL 函数传递参数。

警告调用 Windows API 和其他 DLL 函数可能会给您的应用程序带来不良影响。从自己的代码中直接调用 DLL 函数时，您绕过了 VBA 通常提供的一些安全机制。如果在定义或调用 DLL 函数时出现错误（所有程序员都不可避免），可能会在应用程序中引起应用程序错误（也称为通用性保护错误，或 GPF）。最好的解决办法是在运行代码以前保存该项目，并确保了解 DLL 函数调用的原理。

#p##e#

好的API的特性

简单

首先简单是最重要的。程序员倾向于解决复杂的问题，这使得我们很容易地让这些复杂性影响到编写的用户API。保持简单就需要大量工作，有时还会带来严重的挑战。

我们想要帮助的意愿一定程度上增加了困难。通常，程序员想要提供几种不同的方法来做一些事情。“也许他们想通过构造函数传递这些依赖关系。但是如果他们更喜欢使用setter呢？我们应该让两者都存在。”通向复杂性的道路就是这样良好的意愿铺好的。

即使你认为它可能会有所帮助，也要努力去增加不必要的复杂性。好的api表现出简单性，而且要保持这种简单性需要付出很大的努力。

提供有用的抽象

接下来，考虑抽象的概念。当你成功地从用户的API中隐藏细节只留下要点时，你就提供了抽象。

这个世界充满了抽象的例子。设备驱动程序抽象处理供应商硬件的细节。线程模型提供了一种抽象，用于处理在OS级别上调度执行。操作系统本身为核心计算机硬件的不同提供了一个抽象概念。甚至你的编程语言也会抽象出编写机器代码的细节。

好的代码提供了抽象，API也不例外。你的API应该隐藏它对用户的详细信息，同时使其对用户有用。如果你的用户需要深入代码或执行来理解，你就提供了一个很差的抽象。

可发现的

简单和好的抽象会让你取得不错的成绩。但是，当你写出一个“可发现”的API时，你将走的更远。这与一个新手在使用你的代码时的效率有很大的关系。

我将选用一个非代码示例作有帮助的同类型比较。从用户体验角度想想看，最初的iPhone革命性的是什么。它有一个屏幕和一个按钮。它的应用程序把东西挂在屏幕的一边，让你发现可以通过左右滑动来提高你的使用频率。与之前的设备不同，这款可发现的设备让即使是最不聪明的用户也能快速的进行操作。

让你的API争取做到这一点。要知道，你的用户在拿起手册或打电话询问之前，他们会进行测试和实验。相应的计划和设计，包括文档和示例，以及自我描述访问点会让API具备可发现性。另外使用一个名为GetLastNameFromOrder（CustomerOrder orderToQuery）的方法可以帮助你达到预期目的。

一致和对称

假如你已经偏离了先前的考虑，那么请检查你的API以保持一致性和对称性。一致性相对容易理解。有时候不要称他们为“用户”或“客户”，用相同的方式命名相同的东西，保持一个共同的风格。从而让你的API是可预测的。

对称性是一个稍微有些微妙的考虑。当我谈到对称时，指的是一种以用户期望的方式关闭开放循环的偏好。例如，如果你有一个用于文件访问的API，它允许你调用Open（string文件名），那么你也应该提供一个Close（string文件名）方法。打开和关闭具有相反的含义，因此，提供两种功能都可以作为操作的关注点来创建对称。调用Close方法是“销毁”，而如果没有关闭方法，会造成很大的混乱。

在API中，你可以通过对向用户公开的内容运用批判的眼光来实现这一特性。仔细阅读校对者的方法，检查一致性和对称性，然后根据需要重命名和修改。

遵循最不惊奇的原则

作为最后的考虑，我想给大家介绍一个聪明的“最小惊奇原则”。这表示“一个系统应该以与该组件的用户可能期望的行为一致的方式运行。也就是说，用户不应该对它的行为感到惊讶。”更坦率地说，不要编写API来让你的用户大吃一惊。

我上面关于对称的例子也可以被认为违反了这一原则。但是让我们稍微改变一下，让它更明显地说明这个原则是什么意思。假设你的文件API有一个开放的（字符串文件名）方法，然后它要求你通过调用Open（）来关闭文件，而且没有参数。而无论何时你调用Close（），因为某些原因它都会发送一封电子邮件给一个叫Bill Smith的人。如果对这个过程做出反应，你就会得到一个“令人惊讶”的因素。

好的API并没有导致用户抓狂的属性，“但是这没有任何意义！”或者“我怎么知道这一点？！”向用户提供一个与它所宣称的功能无关的API，我想没有什么比这更快捷的方式来失去用户的信任了。

把API看作一种产品

简单、有用、可发现、一致、可预测，所有这些不仅描述了良好的API，还描述了良好的产品。这不是偶然的，当你编写API时，你将创建一个产品。不管你是否真的这样想，不管你是否真的把产品卖了，你手上都有一个别人想要用的产品。

作为开发人员，我们很容易忽视这一点。根据知识的偏差，假设我们的API用户是程序员，他们知道我们所知道的，理解我们所理解的，但我们并不认为他们是最终用户或客户。

要克服这种偏差，换位思考是设计好的API的关键思想。所以当你编写下一个API时，把自己放在客户的角度，想象你想要的是什么。

打开APP阅读更多精彩内容