Eclipse中的API Tools：简介

Eclipse中的API Tools：简介2011-11-09 IBM Chris Aniszczyk了解如何使用 Eclipse 管理应用程序的 API

创建 Application Public Interface（API），尤其是管理各个版本的 API 十分困难。了解如何利用 Eclipse 的 PDE API Tools 来简化此过程，并且无缝地将其集成到日常开发中。注意，本文专门针对 Eclipse V3.4：Ganymede。

在详细介绍 Eclipse Plug-in Development Environment（PDE）内的 Application Public Interface（API）工具之前，让我们谈一谈 Eclipse 中的 API 的含义。

什么是 API？

您是否曾经在 Eclipse 中收到以下警告或错误，并且想知道它们的含义是什么？

图 1. 阻止访问

内部包

根据命名约定，能否真正在插件中构成包 API 取决于是否把包导出到 MANIFEST.MF 文件中。如果是，则视为 API。要创建不是 API 的内容，您可以用 x-internal:=true 属性标记导出的包。这将指示 Eclipse 导出的包可供使用，但是被视为内部包。

导致警告的原因很可能是您正在访问不能使用某种形式的 API 公开访问的代码。通常，API 元素都经过良好记录并且有某种规范。另一方面，非 API 元素被视为内部实现详细信息，并且常常不附带发布文档。上图的 Eclipse 通知您访问了这些内部元素。Eclipse 礼貌地警告您正在访问可能更改并且不受官方支持的代码。那么，确切地说 API 是什么？

由于 Eclipse 基于 Java™ 编程语言，因此有四种 API 元素。让我们逐个查看。

API 包至少包含一个 API 类或 API 接口的包。

表 1. Eclipse 平台中的包命名约定

命名约定	示例包
org.eclipse.xyz.*	org.eclipse.ui、 org.eclipse.swt.widgets
org.eclipse.xyz.internal.*	org.eclipse.comp are.internal、 org.eclipse.ui.internal
org.eclipse.xyz.internal.provisional.*	org. eclipse.equinox.internal.provisional.p2.engine

API 类或接口 API 包中的 public 类或接口，或者在某个其他 API 类或接口中声明或继承的 public 或 protected 类或接口成员。 API 方法在 API 类或接口中声明或继承的 public 或 protected 方法或构造函数。 API 字段在 API 类或接口中声明或继承的 public 或 protected 字段。

现在我们已经知道各种各样的 API 元素，让我们讨论 API Tools 及它如何能为您管理这些 API 元素。