55 votes

Comment créer ma propre bibliothèque java (API)?

J'ai créé un programme en Java et j'ai conçu de sorte que les méthodes que je veux qu'ils apparaissent (des méthodes de lecture) dans la main, je peux les appeler facilement après initier la classe qui détient ces méthodes.

La question est que, j'ai besoin de faire cette application (qui détient les méthodes de lecture) comme une API afin que je puisse donner mon application pour les développeurs d'utiliser mes fonctions (les méthodes de lecture) si elles en ont besoin, et seulement ce dont ils ont besoin est d'ajouter ce fichier (je pense que l'API après est fait comme montré .fichier jar).

Comment puis-je faire pour que je puisse faire mon code réutilisable avec d'autres applications? Il est similaire à l' .dll, je pense.

Merci beaucoup ;)

57voto

Zack Marrapese Points 7866

Créez un JAR. Incluez ensuite le JAR. Toutes les classes de ce JAR seront disponibles. Assurez-vous simplement de protéger votre code si vous donnez une API. N'exposez aucune méthode / propriété à l'utilisateur final qui ne devrait pas être utilisée.

Modifier: en réponse à votre commentaire, assurez-vous de ne pas inclure la source lorsque vous empaquetez le JAR. N'incluez que les fichiers de classe. C'est le mieux que vous puissiez vraiment faire.

20voto

Michael Borgwardt Points 181658

Pour être utilisable comme une API, vos classes:

  • Utiliser un package unique (idéalement à la suite de la convention, c'est à dire l'inverse d'un domaine que vous possédez en tant que préfixe). Cela empêche les conflits de noms
  • Ont seuls ceux des classes et méthodes d' public ou protected qui sont destinés à être utilisés par d'autres. Cela rend plus facile à utiliser.
  • De vastes commentaires Javadoc.
  • Être disponible en tant que fichier JAR - de préférence dans des Pots séparés pour la distribution binaire, le code source et la javadoc de fichiers.

10voto

CoolBeans Points 11615

Vous devez empaqueter votre application dans un fichier jar. Vous pouvez utiliser la tâche ant jar pour créer des fichiers jar ou vous pouvez utiliser la commande jar.

Pour les tâches de fourmi, regardez ce lien .

Pour le créer manuellement, regardez ce lien .

7voto

Noel M Points 6263

Assurez-vous d'écrire et de publier des javadocs pour toutes vos classes et méthodes publiques et protégées.

4voto

Tai Squared Points 5010

Il existe plusieurs façons vous pouvez exposer votre code. La création d'un pot et de distribution qui peut être le plus facile que d'autres développeurs suffit d'inclure votre bocal. Cependant, si l'on parle de "quelqu'un" l'accès à votre code, un service web peut faire plus de sens que vous pouvez fournir un accès aux données sans fournir tout le code nécessaire. Vous mentionnez fournir l'accès à vos getters - si vous venez de créer une classe qui a des getters, les autres développeurs peuvent utiliser, mais comment vont-ils être remplis? Si votre application est autonome en ce qu'il obtient les données nécessaires et fournit les getters, qui devrait fonctionner, mais si vous parlez de la fourniture d'accès aux données à partir de votre application en cours d'exécution, un service web a plus de sens en tant que votre application peut récupérer les données et de fournir un accès via publiquement accessible méthodes.

Probablement vous voulez créer des interfaces pour permettre aux développeurs de code par rapport à l'interface, et vous pouvez modifier le fonctionnement interne sans les affecter. Une API qui sera utilisé par d'autres devraient être largement documentée.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X