周末也别闲着，看看Java的API怎么写和怎么用吧

本文主要是介绍周末也别闲着，看看Java的API怎么写和怎么用吧，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1、写API

1.1、Eclipse创建java项目

1.2、创建package包

1.3、创建Java类

1.4、添加代码

添加几个简单的函数，如下所示：

package com.main.iamapi;public class Example {public static void sort(int[] is){for (int i = 0; i < is.length-1; i++) {for (int j = 0; j < is.length-1-i; j++) {if(is[j] > is[j+1]){int temp = is[j];is[j] = is[j+1];is[j+1] = temp;}}}}public static String toString(int[] is){String str = "[";for (int num : is) {if(str.length() != 1){str+=",";}str += num;}str += "]";return str;}public static int maxInTwo(int a, int b){if(a>b)return a;elsereturn b;}public static int minInTwo(int a, int b){if(a<b)return a;elsereturn b;}
}

1.5、导出Jar包

2、使用API

2.1、Eclipse新建Java项目

2.2、新建Java类

我们是想着调用API，因此这个项目不需要导出，就不创建包，直接创建类。

2.3、导入Jar包

导入jar包到该项目的构建路径。

导入后可以看到

2.3、导入包并编写代码

import com.main.iamapi.*;
public class Testapi {public static void main(String[] args) {// TODO Auto-generated method stubSystem.out.println("max value in two numbers is " + Example.maxInTwo(10, 20));System.out.println("min value in two numbers is " + Example.maxInTwo(10, 20));}}

2.4、测试运行

3、API和Jar包的区别

API是一些预先定义函数，目的是用来提供应用程序与开发人员基于某软件或者某硬件得以访问一组例程的能力，并且无需访问源码或无需理解内部工作机制细节。

API可以简单的理解为一个通道或者桥梁，是一个程序和其他程序进行沟通的媒介， 本质上一个函数。要想使用一个API就需要遵循API提供方的规则，比如，数据按照什么格式输入，有哪些必传数据哪些非必传数据等。

一组相关的java类文件（可以是API，也可以是自己写的java文件）经过打包、压缩，就成为了一个jar包，当开发人员需要调用某一个API去实现相关能力的时候，就需要导入特定的jar包使用里面的某些API。

jar包与java驱动类则是同一个事物站在不同的角度起的不同的名字。举例说明，当开发人员需要用java调用某些工具的时候，开发人员只需要加载相关的java驱动类，而java驱动类就是一种jar包，其中可以包含相关API。

api就是一类特殊的java类文件，其中包含 一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力；
jar包就是针对java的文件压缩包（web文件压缩包就是war包）

4、生成API文档

大概理解了API是啥，怎么去制作和调用API之后，肯定会有疑问，拿到jar包，我怎么指导有哪些方法、属性？那么接下来就引出来API文档的问题了。

4.1、直接生成

Eclipse生成javadoc，选择Project菜单下的Generate Javadoc...：

然后下一步选择JRE版本：

选择yes，导出API文档，但控制台会提示如下警告：

也就是说类、函数都没有添加注释，但可以生成doc文档，如下：

4.2、添加注释后生成

需要注意的是普通代码注释为/*XXX*/，而javadoc的注释为/**XXX*/，javadoc注释与普通注释的区别为多一个*(星号)。

我们改一下我们的代码：

package com.main.iamapi;/*** API例子类* @author Luohaitao* */
public class Example {/*** 给数组排序* @param is 被排序的integrate数组* */public static void sort(int[] is){for (int i = 0; i < is.length-1; i++) {for (int j = 0; j < is.length-1-i; j++) {if(is[j] > is[j+1]){int temp = is[j];is[j] = is[j+1];is[j+1] = temp;}}}}/*** 获取数组的字符串表示* @param is 被转换的integrate数组* */public static String toString(int[] is){String str = "[";for (int num : is) {if(str.length() != 1){str+=",";}str += num;}str += "]";return str;}/*** 获取最大值* @param a 第一个比较的数* @param b 第二个比较的数* */public static int maxInTwo(int a, int b){if(a>b)return a;elsereturn b;}/*** 获取最小值* @param a 第一个比较的数* @param b 第二个比较的数* */public static int minInTwo(int a, int b){if(a<b)return a;elsereturn b;}
}

再去生成一下API的帮助文档，提示函数缺少return注释

我们再改一下代码：

package com.main.iamapi;/*** API例子类* @author Luohaitao* */
public class Example {/*** 给数组排序* @param is 被排序的integrate数组* */public static void sort(int[] is){for (int i = 0; i < is.length-1; i++) {for (int j = 0; j < is.length-1-i; j++) {if(is[j] > is[j+1]){int temp = is[j];is[j] = is[j+1];is[j+1] = temp;}}}}/*** 获取数组的字符串表示* @param is 被转换的integrate数组* @return 返回转换后的数字字符串* */public static String toString(int[] is){String str = "[";for (int num : is) {if(str.length() != 1){str+=",";}str += num;}str += "]";return str;}/*** 获取最大值* @param a 第一个比较的数* @param b 第二个比较的数* @return 返回两个数中的大的值* */public static int maxInTwo(int a, int b){if(a>b)return a;elsereturn b;}/*** 获取最小值* @param a 第一个比较的数* @param b 第二个比较的数* @return 返回两个数中的小的值* */public static int minInTwo(int a, int b){if(a<b)return a;elsereturn b;}
}

再去生成一下帮助如下：