1. Обзор
Java — один из столпов мира открытого исходного кода. Почти каждый проект Java использует другие проекты с открытым исходным кодом, поскольку никто не хочет изобретать велосипед. Однако часто случается так, что нам нужна библиотека для ее функциональности, но мы понятия не имеем, как ее использовать. Мы сталкиваемся с такими вещами, как:
- Что не так со всеми этими классами «*Service»?
- Как мне это создать, это требует слишком много зависимостей. Что такое «
защелка
»? - О, я собрал его, но теперь он начинает бросать
IllegalStateException
. Что я делаю не так?
Беда в том, что не все разработчики библиотек думают о своих пользователях. Большинство думает только о функциональности и функциях, но мало кто думает о том, как API будет использоваться на практике, как будет выглядеть и тестироваться пользовательский код.
В этой статье дается несколько советов о том, как избавить наших пользователей от некоторых проблем — и нет, это не с помощью написания документации. Конечно, на эту тему можно было бы написать целую книгу (и было сделано несколько); это некоторые из ключевых моментов, которые я усвоил, работая над несколькими библиотеками.
Я продемонстрирую идеи здесь, используя две библиотеки: charles и jcabi-github.