簡體   English   中英

如何創建自己的java庫(API)?

[英]How to create my own java library(API)?

我用Java創建了一個程序,並且我設計了它以便我希望它們在main中出現(getter方法),我可以在啟動包含這些方法的類之后輕松地調用它們。

問題是,我需要使這個應用程序(包含getter方法)就像一個API,這樣我就可以讓我的應用程序讓開發人員使用我的函數(getter方法),如果他們需要它們,只有它們是什么需要的是添加這個文件(我認為API完成后顯示為.jar文件)。

我怎樣才能使我的代碼可以重復使用其他應用程序? 我認為它類似於.dll。

非常感謝 ;)

創建一個JAR。 然后包括JAR。 該JAR中的任何類都可用。 如果您要提供API,請確保保護您的代碼。 不要向最終用戶公開任何不應使用的方法/屬性。

編輯:在回復您的評論時,請確保在打包JAR時不包含源。 僅包含類文件。 這是你真正做到的最好的。

要用作API,您的類應該:

  • 使用唯一的包(理想情況下遵循約定,即您擁有的域的反向作為前綴)。 這可以防止命名沖突
  • 只有那些旨在供他人使用的publicprotected類和方法。 這使它更容易使用。
  • 有廣泛的Javadoc評論。
  • 可用作JAR文件 - 理想情況下,單獨的JAR用於二進制分發,源代碼和javadoc文件。

您需要將應用程序打包為jar文件。 您可以使用ant jar任務創建jar文件,也可以使用jar命令。

對於ant任務,請查看此鏈接

要手動創建它,請查看此鏈接

確保為所有公共和受保護的類和方法編寫和發布javadoc。

要創建jar:

jar cf <jar_name> <sources>

您可以通過多種方式公開代碼。 創建一個jar並分發可能是最容易的,因為其他開發人員只需要包含你的jar。 但是,如果您正在談論“任何人”訪問您的代碼,那么Web服務可能更有意義,因為您可以提供對數據的訪問而無需提供所有必需的代碼。 你提到提供訪問你的getter - 如果你只是創建一個有getter的類,其他開發人員可以使用它們,但它們將如何填充? 如果您的應用程序是自包含的,它獲取必要的數據並提供getter,那應該可以工作,但如果您正在討論提供從正在運行的應用程序訪問數據的訪問權限,那么Web應用程序可以更有意義,因為您的應用程序可以檢索數據並通過可公開訪問的方法提供訪問。

您最有可能也想創建接口,因此開發人員可以對接口進行編碼,您可以更改內部工作而不會影響它們。 其他人將使用的API也應該被廣泛記錄。

好吧,取決於你的IDE。 我使用Netbeans,所以我只是點擊構建項目,並且中提琴! 在我指定的目錄中創建一個jar文件。 現在,這只是為了編譯。 所有人都必須下載.jar文件,如果在Netbeans中,右鍵單擊庫,添加jar /文件夾,然后選擇下載的文件。

你也可以考慮:

  • 包括一些演示如何使用庫的示例
  • 使用Apache Maven構建jar
  • 將您的jar放在公共maven存儲庫中
  • 在找到/修復錯誤時發布新版本的庫
  • 如果你想隱藏你的實現,你可以用你的混淆包裝你的jar,這樣如果有人反編譯你的類,代碼將難以閱讀

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM