如何创build我自己的Java库(API)?
我在Java中创build了一个程序,我devise了一个方法,让我们希望它们出现在getter方法中,我可以在启动持有这些方法的类后轻松地调用它们。
问题是,我需要让这个应用程序(包含getter方法)像一个API,以便我可以给我的应用程序开发人员使用我的function(getter方法),如果他们需要他们,只有他们需要的是添加这个文件(我认为API完成后显示为.jar文件)。
我怎样才能使我的代码可以与其他应用程序重用? 这与.dll类似,我想。
非常感谢 ;)
创build一个JAR。 然后包括JAR。 该JAR中的任何类都将可用。 只要确保你保护你的代码,如果你给出了一个API。 不要将任何方法/属性暴露给不应该使用的最终用户。
编辑:作为对您的评论的回应,请确保在打包JAR时不包含源代码。 只包含类文件。 这是你能做的最好的事情。
为了可以用作API,你的类应该:
- 使用一个独特的软件包(理想情况下遵循惯例,即您拥有的域作为前缀的反面)。 这可以防止命名冲突
- 只有这些类别和方法
public
或protected
,打算供他人使用。 这使它更容易使用。 - 有广泛的Javadoc评论。
- 作为JAR文件提供 – 理想情况下,将二进制分发的JAR,源代码和javadoc文件分开。
您需要将您的应用程序打包为一个jar文件。 您可以使用ant jar任务来创buildjar文件,也可以使用jar命令。
对于ant任务看这个链接 。
为了创build它,请手动查看此链接 。
确保您为所有公共和受保护的类和方法编写和发布javadoc。
有几种方法可以暴露您的代码。 创build一个jar和分发这可能是最简单的,因为其他开发人员将只需要包括你的jar。 但是,如果您正在谈论访问您的代码的“任何人”,则Web服务可能更有意义,因为您可以提供对数据的访问权限,而无需提供所有必需的代码。 你提到提供对你的getter的访问 – 如果你只是创build了一个拥有getter的类,其他开发者可以使用它们,但是它们将如何被填充? 如果您的应用程序是自包含的,它获取必要的数据并提供getter,那么应该可以工作,但是如果您正在讨论的是如何从正在运行的应用程序提供对数据的访问,那么Web服务更有意义,因为您的应用程序可以检索数据并通过可公开访问的方法提供访问。
您最有可能也想要创build接口,以便开发人员可以对接口进行编码,并且可以更改内部工作而不影响它们。 其他人使用的任何API都应该被广泛地logging下来。
创buildjar:
jar cf <jar_name> <sources>
那么,取决于你的IDE。 我使用Netbeans,所以我只是打build立项目,中提琴! 在指定的目录中创build一个jar文件。 现在,这只是编译。 所有人需要做的就是下载你的.jar文件,如果在Netbeans中,右键单击库,添加jar /文件夹,然后select下载的文件。