Как создать свою собственную библиотеку Java (API)?
Я создал программу на Java и разработал ее так, чтобы методы, которые я хочу, чтобы они появлялись (методы-получатели) в основном, я мог легко вызывать их после запуска класса, который содержит эти методы.
Вопрос в том, Мне нужно сделать это приложение (которое содержит методы получения) похожим на API, чтобы я мог дать своему приложению разработчикам возможность использовать мои функции (методы получения), если они им нужны, и только то, что им нужно, это добавить это файл (я думаю, что API после того, как это сделано, показан как файл .jar).
Как я могу сделать так, чтобы я мог сделать свой код многоразовым с другим приложением? Я думаю, что это похоже на .dll.
Большое спасибо;)
3 ответа
Чтобы быть пригодными для использования в качестве API, ваши классы должны:
- Использовать уникальный пакет (в идеале следуя соглашению, т. е. обратный домену, которым вы владеете в качестве префикса). Это предотвращает конфликты имен.
- Имейте только те классы и методы
publicилиprotected, которые предназначены для использования другими. Это упрощает использование. - Наличие обширных комментариев Javadoc.
- Быть доступным в виде JAR-файла — в идеале отдельные JAR-файлы для бинарного дистрибутива, исходного кода и файлов javadoc.
Есть несколько способов раскрыть свой код. Создание jar-файла и его распространение может быть самым простым, так как другим разработчикам нужно будет просто включить ваш jar-файл. Однако, если вы говорите о «любом» доступе к вашему коду, веб-служба может иметь больше смысла, поскольку вы можете предоставить доступ к данным, не предоставляя весь необходимый код. Вы упомянули о предоставлении доступа к своим геттерам — если вы просто создадите класс, в котором есть геттеры, другие разработчики смогут их использовать, но как они будут заполняться? Если ваше приложение является автономным в том смысле, что оно получает необходимые данные и предоставляет геттеры, это должно работать, но если вы говорите о предоставлении доступа к данным из вашего работающего приложения, веб-служба имеет больше смысла, поскольку ваше приложение может извлекать данные и предоставить доступ через общедоступные методы.
Скорее всего, вы также захотите создать интерфейсы, чтобы разработчики могли кодировать интерфейс, а вы могли изменять внутреннюю работу, не влияя на нее. Любой API, который будет использоваться другими, также должен быть подробно задокументирован.
Убедитесь, что вы написали и опубликовали javadocs для всех общедоступных и защищенных классов и методов.