Bibliothek hochladen

Wenn Sie Zugriff auf Ihre Bibliothek gewähren möchten, müssen Sie ein Repository auswählen. Auf dieser Seite werden die Überlegungen zur Auswahl eines Repository-Typs erläutert und es wird gezeigt, wie Sie mit dem Maven Publish-Plug-in eine Veröffentlichung erstellen.

Bevor Sie Ihre Bibliothek hochladen, müssen Sie sie für den Release vorbereiten und alle erforderlichen Veröffentlichungsvarianten oder Testvorrichtungen konfigurieren.

Repository-Typ auswählen

Bibliotheken werden als AAR-Dateien veröffentlicht. Diese Dateien enthalten kompilierten Code als Bytecode und native Bibliotheken, ein Android-Manifest und Ressourcen. Das Paket selbst deklariert keine Identität, Version oder Abhängigkeiten von anderen Bibliotheken.

Im Allgemeinen ist es Best Practice, AARs über ein Repository bereitzustellen, anstatt sie direkt zu verteilen. So können Nutzer besser nachvollziehen, woher die Bibliothek stammt, anstatt sich mit einer name.aar-Datei ohne wichtige Details wie die Version auseinandersetzen zu müssen. Wenn Sie ein Upgrade auf eine neuere Version einer Bibliothek durchführen, verwenden Sie ein Repository, um sicherzustellen, dass nur die erforderlichen Abhängigkeiten der neueren Version hinzugefügt werden. So müssen Nutzer Abhängigkeiten nicht manuell aktualisieren.

Die Verwendung eines Repositorys zum Veröffentlichen Ihrer Bibliothek bietet mehrere Vorteile:

  • Gradle kann die Abhängigkeiten Ihrer Bibliothek automatisch dem Abhängigkeitsdiagramm hinzufügen.
  • Gradle kann dafür sorgen, dass nur eine einzige Version Ihrer Bibliothek im Abhängigkeitsdiagramm enthalten ist. Konflikte werden gelöst, wenn Ihre Bibliothek mehr als einmal mit unterschiedlichen Versionen transitiv enthalten ist.
  • Das Android-Gradle-Plug-in (AGP) kann die Entzuckerung effizienter durchführen, wenn Ihre Bibliothek Java 8- oder höhere Sprachfunktionen verwendet. Dadurch werden die Build-Zeiten für Ihre Nutzer verkürzt.
  • In deiner Bibliothek kann die Veröffentlichung von Varianten verwendet werden und sie kann Funktionen wie Test-Fixtures enthalten.

Wenn Sie die AAR-Datei direkt bereitstellen, erhalten Ihre Nutzer keine Informationen zur Identität, Version oder zu den Abhängigkeiten Ihrer Bibliothek. Bei der Veröffentlichung in einem Repository wird die Verteilung von einer separaten Datei übernommen, die Teil des Repository-Mechanismus ist. Bei Maven-Repositories ist dies die POM-Datei. Daher wird dringend empfohlen, Bibliotheken über Repositories zu veröffentlichen, anstatt AAR-Dateien manuell zu verteilen.

Repository-Typen

Es gibt drei Arten von Repositorys:

  • In kostenlosen Online-Repositories wie Maven Central kann jeder Bibliotheken hoch- und herunterladen.
  • Private Repositories, auf die nur nach Anmeldung zugegriffen werden kann, ermöglichen die kontrollierte Verteilung privater Bibliotheken.
  • Lokale, ordnerbasierte Repositories ermöglichen die Verteilung von Bibliotheken per manuellem Download.

Die Verwendung lokaler, ordnerbasierter Repositories ist vergleichbar mit der Bereitstellung eines manuellen Downloadlinks für die AAR-Datei oder dem Senden der AAR-Datei per E-Mail. Der Hauptunterschied besteht darin, dass Sie nicht nur die AAR, sondern auch die zusätzlichen Informationen zu Identität, Version und Abhängigkeiten senden.

Du stellst eine ZIP-Datei des ordnerbasierten Repositorys bereit, die deine AAR-Datei und die Metadaten enthält. Ihre Nutzer können dann den Inhalt der Datei extrahieren, ihrem Projekt hinzufügen und Gradle darauf verweisen. Ab diesem Zeitpunkt können die Nutzer eine Abhängigkeit von der Bibliothek mithilfe von Maven-Koordinaten deklarieren, als ob sich die Bibliothek in einem Online-Repository befinden würde, und von allen oben genannten Vorteilen profitieren.

Publikation erstellen

Veröffentlichen Sie die Bibliothek mit dem Gradle Maven Publish Plugin. Mit dem Maven Publish-Plug-in können Sie Veröffentlichungen und Repositories deklarieren und Aufgaben erstellen, um diese Veröffentlichungen in den Repositories zu veröffentlichen. Diese Veröffentlichungen nutzen eine SoftwareComponent-Instanz, die vom Plug-in erstellt wird, das den Build steuert. Das kann AGP oder das java-library-Plug-in sein.

Wenn Sie das Maven Publish-Plug-in mit dem AGP ausführen, werden die Softwarekomponenten nicht direkt beim Anwenden des Plug-ins erstellt. Sie werden stattdessen während des Callback-Schritts afterEvaluate() erstellt. Daher muss die Publikation, die die Softwarekomponente auswählt, auch während des Schritts afterEvaluate() konfiguriert werden.

Mit dem folgenden Code-Snippet der Datei build.gradle auf Modulebene wird eine Veröffentlichung für eine bestimmte Variante erstellt, die mit singleVariant() oder multipleVariants() erstellt wurde:

Groovy

publishing {
  publications {
    release(MavenPublication) {
      groupId = 'com.my-company'
      artifactId = 'my-library'
      version = '1.0'

      afterEvaluate {
        from components.release
      }
    }
  }
}

Kotlin

publishing {
  publications {
    register<MavenPublication>("release") {
      groupId = "com.my-company"
      artifactId = "my-library"
      version = "1.0"

      afterEvaluate {
        from(components["release"])
      }
    }
  }
}

Im vorherigen Beispiel basiert der Name der Komponente (components.release) auf dem Namen, der entweder singleVariant() oder multipleVariants() zugewiesen wurde.

Nachdem Sie eine Publikation deklariert haben, müssen Sie ein Ziel-Repository erstellen.

In einem lokalen Repository veröffentlichen

Das Veröffentlichen in einem lokalen Repository ähnelt dem Veröffentlichen in einem Remote-Repository, mit Ausnahme der Repository-Deklaration. Im vorherigen Abschnitt erfahren Sie, wie Sie in einem Remote-Repository veröffentlichen, um eine Veröffentlichung zu erstellen, die die ausgewählte(n) Variante(n) veröffentlicht. Erstellen Sie dann ein lokales Repository:

Groovy

publishing {
  publications {
    release(MavenPublication) {
      ...
    }
  }
  repositories {
    maven {
      name = 'myrepo'
      url = layout.buildDirectory.dir("repo")
    }
  }
}

Kotlin

publishing {
  publications {
    register<MavenPublication>("release") {
      ...
    }
  }
  repositories {
    maven {
      name = "myrepo"
      url = uri(layout.buildDirectory.dir("repo"))
    }
  }
}

Dadurch wird eine Aufgabe mit dem Namen publishReleaseToMyRepoRepository erstellt, die aus dem Namen der Veröffentlichung und dem Namen des Repositorys besteht. Führen Sie diese Aufgabe aus, um das Repository am angegebenen Speicherort zu generieren. In diesem Beispiel wird das Repository im Build-Ordner des Projekts im Verzeichnis repo generiert.

Wenn Sie automatisch eine ZIP-Datei des Repositorys generieren möchten, verwenden Sie den folgenden Code:

Groovy

tasks.register('generateRepo', Zip) {
  def publishTask = tasks.named('publishReleasePublicationToMyrepoRepository')
  from publishTask.map { it.getRepository().getUrl() }
  into 'mylibrary'
  archiveFileName.set('mylibrary.zip')
}

Kotlin

tasks.register<Zip>("generateRepo") {
  val publishTask = tasks.named(
    "publishReleasePublicationToMyrepoRepository",
    PublishToMavenRepository::class.java)
  from(publishTask.map { it.repository.url })
  into("mylibrary")
  archiveFileName.set("mylibrary.zip")
}

Mit diesem Code wird eine Zip-Aufgabe namens generateRepo erstellt, die den Inhalt der Veröffentlichungsaufgabe nutzt und komprimiert. Dabei wird darauf geachtet, dass sich die ZIP-Einträge in einem Ordner auf oberster Ebene namens mylibrary befinden. Die Ausgabe befindet sich unter build/distributions.