Статьи

6 шагов для разработки и публикации библиотеки Android

Разработка библиотеки Android с открытым исходным кодом — отличный опыт. У вас есть возможность окупить свою работу за все время использования библиотеки с открытым исходным кодом. Есть много библиотек, которые мы все использовали и которые упростили нашу жизнь разработчика. Кроме того, это отличная возможность для изучения, потому что исходный код является общедоступным, и все другие разработчики могут проверить его и использовать его, и наверняка вы получите некоторые отзывы. Вы, как разработчик, должны быть готовы получать положительные и отрицательные комментарии, мнения, предложения, все это поможет вам стать лучшим разработчиком. Вы получаете за этот захватывающий процесс разработки огромный опыт, выслушивая мнения других разработчиков, комментируя. Так что, если у вас есть идея разработать ее и сделать код открытым исходным кодом, вы выиграете.

В этом посте кратко изложены основные шаги (или то, что я выполнил) при разработке библиотеки Android с открытым исходным кодом .

  • Найди идею
  • Найти хранилище
  • Создать сайт
  • Создать сообщество
  • Опубликовать библиотеку
  • Управляйте своим хранилищем

publish_android_opensource_library

Шаг 1: найти идею

Отправной точкой является нахождение идеи, правильной идеи. Существует множество библиотек с открытым исходным кодом, и у каждого есть свои особенности. Вообще говоря, есть два разных варианта:

  • если у вас есть отличная идея о чем-то, что не охвачено, то вы можете разработать свою библиотеку
  • в противном случае вы можете внести свой вклад в существующую библиотеку и попытаться улучшить ее.

У вас может быть третий вариант: переписать и улучшить существующую библиотеку, добавив некоторые новые функции или используя новые технологии.

Чтобы получить вдохновение, вы можете взглянуть на android-arsenal.com , отличный сайт, который содержит самые важные библиотеки.

Вы можете проверить там, чтобы узнать, является ли ваша идея оригинальной или уже есть такая.

Шаг 2: Найти хранилище

Однажды у вас есть идея, что пришло время найти правильный репозиторий, где хранить код библиотеки . Есть несколько вариантов, мой любимый — Github, потому что он очень прост в использовании и бесплатный.

Учетная запись бесплатна, если вы управляете общедоступным репозиторием, и это тот случай, который мы освещаем. Используя Github, вы можете управлять всем процессом разработки библиотеки . Чтобы не усложнять задачу, достаточно создать две ветви:

  • мастер ветка
  • ветка разработчика

Основная ветвь — это место, где вы храните стабильный код, когда вы « выпускаете » исходный код библиотеки, чтобы другие разработчики могли загрузить и использовать его.

Ветвь dev — это разрабатываемая ветвь, в которой код не стабилен, пока вы не переместите его в основную ветку.

Вот некоторые другие интересные функции, которые помогут вам управлять исходным кодом библиотеки Android, такими как этапы и выпуски .

Шаг 3: Создайте сайт

Этот шаг не является необходимым, но помогает другим разработчикам узнать вашу библиотеку и как ее использовать.

Вы можете опубликовать такую ​​информацию, как вики, используя вики-страницы Github, или у вас есть возможность создать веб-сайт, размещенный на Github .

В этом случае вам нужно создать ветку gh-pages, в которую вы добавляете файлы HTML / scripts. Этот сайт должен содержать соответствующую информацию о библиотеке Android , основных функциях, почему она отличается от других и почему разработчик должен использовать вашу библиотеку.

Также следует добавить информацию о текущем выпуске библиотеки и об исходном коде: как он структурирован и как его изменить.

Не забудьте указать зависимости библиотеки, если она существует .

Шаг 4: Создать сообщество

Выпустив первую версию своей библиотеки, вы должны создать сообщество, чтобы пользователи и другие разработчики могли обсуждать темы, относящиеся к вашей библиотеке, и вы могли получить полезную информацию о новых функциях. Существует несколько способов создания и управления сообществом, мой предпочтительный — использование G +. Создать сообщество G + очень легко, и как только сообщество будет готово, пригласите своих друзей присоединиться к нему. Сообщество G + — отличное место для обсуждения ошибок Android Libray или прослушивания улучшений пользователей.

android_community_opensource

Не забудьте связать сообщество на сайте.

Шаг 5: Опубликуйте библиотеку

Это не тривиальный аспект. Когда вы публикуете библиотеку Android, она становится доступной «всему миру». Процесс публикации библиотеки Android довольно сложен и требует нескольких шагов, но делает библиотеку проще в использовании.

Разработчики не хотят бороться с исходным кодом библиотеки, чтобы он работал. Вы можете оставить его просто как исходный код и разработчиков, которые хотят его использовать, проверить код, импортировать его в свои проекты.

Если вы хотите сделать что-то более продвинутое, вы можете использовать репозиторий Sonatype . Когда библиотека Android находится в репозитории sonatype, на нее можно ссылаться в файле Gradle, например:

1
2
3
4
dependencies {
  compile 'your_id:lib_name:version'
  ....
}

Последний вариант использует Jitpack.io и интересное решение, которое упрощает процесс публикации и может быть легко интегрировано с Github. Вы должны создать релиз Github, и без особой работы библиотека доступна в репозитории maven, чтобы на библиотеку Android можно было ссылаться в файле Gradle.

Шаг 6: Управление хранилищем

Одним из важных шагов является контроль вашего хранилища. Как только библиотека Android станет доступной, и пользователи начнут разрабатывать проекты с ее использованием, в вашей библиотеке могут появиться некоторые ошибки, поэтому другие доброжелательные разработчики начнут исправлять такие ошибки и создают запрос на извлечение в Github.

Один из способов контроля целостности вашего хранилища и предотвращения ошибок компиляции при внесении изменений — использование
Непрерывная интеграция или CI . Инструменты CI — это системы, которые проверяют исходный код библиотеки, проверяя, по-прежнему ли она компилируется или нет после внесения некоторых изменений.

Одним из замечательных инструментов является Travis-ci . Он интегрирован с Github и с помощью той же учетной записи вы можете создать учетную запись. Travis-ci требует, чтобы вы создали файл сборки, используемый для руководства процессом компиляции.

Каждый раз, когда изменяется исходный код в Github, начинается процесс компиляции, и вы узнаете вскоре после результата.

Это мои два цента.

Ссылка: 6 шагов по разработке и публикации библиотеки Android от нашего партнера JCG Франческо Аццолы в блоге Surviving w / Android .