Распространять библиотеку Android в jCenter для использования в gradle

Question

У меня есть проект библиотеки с модулем, который предназначен только для библиотечных классов и представлений. Я искал в интернете, как распространять его в jCenter, чтобы использовать в качестве зависимости gradle, но ничего не работает.

Хотя это еще не сделано, как я могу использовать этот модуль в других проектах?

PS: я использую Android Studio на Windows 10.

Answer 1

Многие учебные пособия и инструкции онлайн устарели или им очень трудно следовать. Я только что научился делать это сам, поэтому я добавляю то, что, надеюсь, будет для вас быстрым решением. Включает в себя следующие пункты

• Начните с вашей библиотеки Android
• Настройте учетную запись Bintray
• Отредактируйте файлы Gradle вашего проекта
• Загрузите свой проект в Bintray
• Свяжите это с jCenter

Библиотека, которой вы хотите поделиться

К настоящему времени у вас, вероятно, уже есть настроенная библиотека. Ради этого примера я сделал новый проект с одним demo-app модуль приложения и один my-library библиотечный модуль в Android Studio.

Вот как это выглядит при использовании представлений Project и Android:

Настройте учетную запись Bintray

В Bintray размещаются репозитории jCenter. Зайдите на Bintray и создайте бесплатный аккаунт.

После входа нажмите Добавить новый репозиторий.

Назовите хранилище maven, (Однако вы можете назвать это как-то иначе, если вы хотите сгруппировать несколько библиотечных проектов вместе. Если вы это сделаете, вам также нужно будет изменить bintrayRepo имя в файле Gradle ниже.)

Выберите Maven в качестве типа хранилища.

Вы можете добавить описание, если хотите. Затем нажмите Создать. Это все, что нам нужно сделать в Bintray на данный момент.

Отредактируйте файлы Gradle

Я собираюсь сделать это как можно более вырезанным и вставленным, но не забудьте отредактировать необходимые детали. Вам не нужно ничего делать с модулем демо-приложения build.gradle файл, только файлы Gradle для проекта и библиотеки.

Проект build.gradle

Добавьте плагины Bintray и Mavin в свой проект build.gradle файл. Вот весь мой файл:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.2'

        // Add these lines (update them to whatever the newest version is)
        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7.3'
        classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
    }
}

allprojects {
    repositories {
        jcenter()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

Новейшая версия для Bintray здесь и Maven здесь.

Библиотека build.gradle

Отредактируйте все, что вам нужно в ext блок ниже.

apply plugin: 'com.android.library'

// change all of these as necessary
ext {
    bintrayRepo = 'maven'  // this is the same as whatever you called your repository in Bintray
    bintrayName = 'my-library' // your bintray package name. I am calling it the same as my library name.

    publishedGroupId = 'com.example'
    libraryName = 'my-library'
    artifact = 'my-library' // I'm calling it the same as my library name

    libraryDescription = 'An example library to make your programming life easy'

    siteUrl = 'https://github.com/example/my-library'
    gitUrl = 'https://github.com/example/my-library.git'

    libraryVersion = '1.0.0'

    developerId = 'myID' // Maven plugin uses this. I don't know if it needs to be anything special.
    developerName = 'My Name'
    developerEmail = '[e-mail]'

    licenseName = 'The MIT License (MIT)'
    licenseUrl = 'https://opensource.org/licenses/MIT'
    allLicenses = ["MIT"]
}

// This next section is your normal gradle settings
// There is nothing special that you need to change here
// related to Bintray. Keep scrolling down.

android {
    compileSdkVersion 25
    buildToolsVersion "25.0.2"

    defaultConfig {
        minSdkVersion 9
        targetSdkVersion 25
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"

    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
        exclude group: 'com.android.support', module: 'support-annotations'
    })
    compile 'com.android.support:appcompat-v7:25.3.1'
    testCompile 'junit:junit:4.12'
}

// Maven section
// You shouldn't need to change anything. It just uses the
// values you set above.

apply plugin: 'com.github.dcendents.android-maven'

group = publishedGroupId // Maven Group ID for the artifact

install {
    repositories.mavenInstaller {
        // This generates POM.xml with proper parameters
        pom {
            project {
                packaging 'aar'
                groupId publishedGroupId
                artifactId artifact

                // Add your description here
                name libraryName
                description libraryDescription
                url siteUrl

                // Set your license
                licenses {
                    license {
                        name licenseName
                        url licenseUrl
                    }
                }
                developers {
                    developer {
                        id developerId
                        name developerName
                        email developerEmail
                    }
                }
                scm {
                    connection gitUrl
                    developerConnection gitUrl
                    url siteUrl

                }
            }
        }
    }
}

// Bintray section
// As long as you add bintray.user and bintray.apikey to the local.properties
// file, you shouldn't have to change anything here. The reason you 
// don't just write them here is so that they won't be publicly visible
// in GitHub or wherever your source control is.

apply plugin: 'com.jfrog.bintray'

version = libraryVersion

if (project.hasProperty("android")) { // Android libraries
    task sourcesJar(type: Jar) {
        classifier = 'sources'
        from android.sourceSets.main.java.srcDirs
    }

    task javadoc(type: Javadoc) {
        source = android.sourceSets.main.java.srcDirs
        classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
    }
} else { // Java libraries
    task sourcesJar(type: Jar, dependsOn: classes) {
        classifier = 'sources'
        from sourceSets.main.allSource
    }
}

task javadocJar(type: Jar, dependsOn: javadoc) {
    classifier = 'javadoc'
    from javadoc.destinationDir
}

artifacts {
    archives javadocJar
    archives sourcesJar
}

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())

bintray {
    user = properties.getProperty("bintray.user")
    key = properties.getProperty("bintray.apikey")

    configurations = ['archives']
    pkg {
        repo = bintrayRepo
        name = bintrayName
        desc = libraryDescription
        websiteUrl = siteUrl
        vcsUrl = gitUrl
        licenses = allLicenses
        publish = true
        publicDownloadNumbers = true
        version {
            desc = libraryDescription
            gpg {
                // optional GPG encryption. Default is false.
                sign = false
                //passphrase = properties.getProperty("bintray.gpg.password")
            }
        }
    }
}

local.properties

Библиотека build.gradle файл выше ссылается на некоторые значения в local.properties файл. Нам нужно добавить их сейчас. Этот файл находится в корне вашего проекта. Это должно быть включено в .gitignore, (Если это не так, добавьте его.) Смысл в том, чтобы указать здесь свое имя пользователя, ключ API и пароль шифрования, чтобы он не был публично виден при управлении версиями.

## This file is automatically generated by Android Studio.
# Do not modify this file -- YOUR CHANGES WILL BE ERASED!
#
# This file should *NOT* be checked into Version Control Systems,
# as it contains information specific to your local configuration.
#
# Location of the SDK. This is only used by Gradle.
# For customization when using a Version Control System, please read the
# header note.
sdk.dir=/home/yonghu/Android/Sdk

# Add these lines (but change the values according to your situation)
bintray.user=myusername
bintray.apikey=1f2598794a54553ba68859bb0bf4c31ff6e71746

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

• bintray.user: Это ваше имя пользователя Bintray.
• bintray.apikey: Перейдите в Edit Profile в меню Bintray и выберите API Key. Скопируйте это отсюда.

Загрузить проект в Bintray

Откройте терминал и перейдите в корневую папку вашего проекта. Или просто используйте терминал в Android Studio.

Введите следующие команды

./gradlew install
./gradlew bintrayUpload

Если все настроено правильно, загрузите вашу библиотеку в Bintray. Если это не удается, то Google решение. (Мне пришлось обновить мой JDK при первой попытке.)

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

Ссылка на jCenter

В вашей библиотеке в Bintray есть кнопка Добавить в jCenter.

Нажмите на нее и отправьте запрос. Если вы получили одобрение (это занимает день или два), то ваша библиотека станет частью jCenter, и разработчики по всему миру смогут добавить вашу библиотеку в свои проекты, просто добавив одну строку в приложение. build.gradle блок зависимостей.

dependencies {
    compile 'com.example:my-library:1.0.0'
}

Поздравляем!

Заметки

• Вы можете добавить шифрование PGP, особенно если вы связываете его с Maven Central. (Однако jCenter заменил Maven Central по умолчанию в Android Studio.) Для получения справки см. это руководство. Но также прочитайте это от Bintray.

Как добавить новую версию

В конечном итоге вы захотите добавить новую версию в вашу библиотеку Bintray/jCenter. Смотрите этот ответ на инструкции о том, как это сделать.

Дальнейшее чтение

• Как распространять свою собственную библиотеку Android через jCenter и Maven Central из Android Studio
• Создание и публикация библиотеки Android