بارگذاری کتابخانه

برای اعطای دسترسی به کتابخانه‌تان، باید مخزنی را انتخاب کنید. این صفحه شما را در ملاحظات مربوط به انتخاب نوع مخزن راهنمایی می‌کند و نحوه ایجاد یک نشریه بااستفاده از افزونه Maven Publish را نشان می‌دهد.

قبل‌از بارگذاری کتابخانه، مطمئن شوید که کتابخانه را برای انتشار آماده کرده‌اید و هرگونه انواع انتشار یا تجهیزات آزمایشی لازم را پیکربندی کرده‌اید.

انتخاب نوع مخزن

کتابخانه‌ها به‌عنوان فایل‌های AAR منتشر می‌شوند. این فایل‌ها حاوی کد کامپایل‌شده به‌صورت بایت‌کد و کتابخانه‌های بومی، مانیفست Android، و منابع است. خود بسته هیچ هویت، نسخه، یا وابستگی به کتابخانه‌های دیگر را اعلام نمی‌کند.

ارائه AAR ازطریق مخزن معمولاً بهترین روش است، به‌جای اینکه AAR را مستقیماً توزیع کنید. این کار به کاربران کمک می‌کند تا درک بهتری از منبع کتابخانه داشته باشند، به‌جای اینکه مجبور باشند با یک فایل name.aar بدون جزئیات مهم، مانند نسخه، سروکار داشته باشند. هنگام ارتقا به نسخه جدیدتر کتابخانه، از مخزن استفاده کنید تا مطمئن شوید که فقط وابستگی‌های لازم نسخه جدیدتر اضافه شده است، تا کاربران مجبور نباشند وابستگی‌ها را به‌طور دستی به‌روز کنند.

استفاده از مخزن برای انتشار کتابخانه مزایای متعددی دارد:

  • Gradle می‌تواند به‌طور خودکار وابستگی‌های کتابخانه‌تان را به نمودار وابستگی اضافه کند.
  • Gradle می‌تواند اطمینان حاصل کند که یک نسخه از کتابخانه شما در نمودار وابستگی وجود دارد و درصورتی‌که کتابخانه شما به‌صورت گذرا بیش‌از یک‌بار با نسخه‌های مختلف گنجانده شده باشد، تداخل‌ها را حل می‌کند.
  • اگر کتابخانه شما از ویژگی‌های زبان Java 8 یا بالاتر استفاده کند، «افزایه Android Gradle»‏ (AGP) می‌تواند شکرزدایی کارآمدتری انجام دهد و زمان ساخت را برای کاربران شما کاهش دهد.
  • کتابخانه شما می‌تواند از انتشار گوناگون استفاده کند و ویژگی‌هایی مانند وسایل آزمایشی را شامل شود.

توزیع مستقیم AAR هیچ اطلاعاتی درباره هویت، نسخه، یا وابستگی‌های کتابخانه‌تان به کاربر ارائه نمی‌دهد. هنگام انتشار در مخزن، توزیع توسط فایل جداگانه‌ای که بخشی از سازوکار مخزن است انجام می‌شود. برای مخازن Maven، این فایل POM است. بنابراین، اکیداً توصیه می‌شود کتابخانه‌ها را بااستفاده از مخازن منتشر کنید تا اینکه فایل‌های AAR را به‌صورت دستی توزیع کنید.

انواع مخزن‌ها

سه نوع مخزن وجود دارد:

  • مخازن آنلاین رایگان، مانند Maven Central، به هر کسی اجازه می‌دهند کتابخانه‌ها را بارگذاری و بارگیری کند.
  • مخزن‌های خصوصی، با دسترسی ازطریق ورود به سیستم، امکان توزیع کنترل‌شده کتابخانه‌های خصوصی را فراهم می‌کنند.
  • مخازن محلی مبتنی بر پوشه امکان توزیع کتابخانه‌ها را ازطریق بارگیری دستی فراهم می‌کنند.

استفاده از مخازن محلی مبتنی بر پوشه بسیار شبیه به ارائه پیوند بارگیری دستی به کاربران برای AAR یا ارسال AAR ازطریق ایمیل است. تفاوت اصلی این است که شما فقط AAR را ارسال نمی‌کنید، بلکه اطلاعات اضافی درباره هویت، نسخه، و وابستگی‌ها را نیز ارسال می‌کنید.

فایل zip مخزن مبتنی بر پوشه حاوی AAR به‌علاوه فراداده را توزیع می‌کنید. سپس کاربران شما می‌توانند محتوای فایل را استخراج کنند، محتوا را به پروژه خود اضافه کنند، و Gradle را به آن ارجاع دهند. از آن به بعد، کاربران می‌توانند بااستفاده از مختصات Maven، وابستگی به کتابخانه را اعلام کنند، گویی کتابخانه در مخزن آنلاین قرار دارد، و از همه مزایای ذکرشده در بالا بهره‌مند شوند.

ایجاد نشریه

بااستفاده از افزایه Gradle Maven Publish منتشر کنید. افزونه Maven Publish به شما امکان می‌دهد انتشارات و مخازن را اعلام کنید و تکالیفی برای انتشار این انتشارات در مخازن ایجاد می‌کند. این انتشارات از نمونه SoftwareComponent که افزونه هدایت‌کننده ساخت ایجاد می‌کند استفاده می‌کنند، که می‌تواند AGP یا افزونه java-library باشد.

توجه داشته باشید که هنگام اجرای افزونه Maven Publish با AGP، مؤلفه‌های نرم‌افزار مستقیماً هنگام اعمال افزونه ایجاد نمی‌شوند. درعوض، این شناسه‌ها درطول مرحله فراخوانی afterEvaluate() ایجاد می‌شوند. بنابراین، سایت خبری‌ای که مؤلفه نرم‌افزار را انتخاب می‌کند باید درطول مرحله afterEvaluate() نیز پیکربندی شود.

تکه‌کد زیر از فایل build.gradle در سطح ماژول، انتشاری برای یک متغیر معین ایجادشده با singleVariant() یا multipleVariants() ایجاد می‌کند:

شیک

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

      afterEvaluate {
        from components.release
      }
    }
  }
}

کاتلین

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

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

در مثال قبلی، نام قطعه (components.release) براساس نامی است که به singleVariant() یا multipleVariants() داده شده است.

وقتی انتشاراتی را اعلام می‌کنید، باید مخزن هدف ایجاد کنید.

انتشار در مخزن محلی

انتشار در مخزن محلی بسیار شبیه به انتشار در مخزن راه دور است، به‌جز اعلام مخزن. بخش قبلی را بخوانید تا با نحوه انتشار در مخزن راه دور برای ایجاد انتشاری که متغیر یا متغیرهای انتخابی شما را منتشر می‌کند آشنا شوید. سپس یک مخزن محلی ایجاد کنید:

شیک

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

کاتلین

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

این کار تکلیفی به‌نام publishReleaseToMyRepoRepository ایجاد می‌کند که شامل نام انتشارات و نام مخزن است. این تکلیف را اجرا کنید تا مخزن در مکان ارائه‌شده تولید شود. در این مثال، مخزن در پوشه ساخت پروژه، تحت دایرکتوری repo تولید می‌شود.

اگر می‌خواهید به‌طور خودکار فایل zip از مخزن ایجاد کنید، این کار را بااستفاده از کد زیر انجام دهید:

شیک

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

کاتلین

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

این کد یک تکلیف Zip به‌نام generateRepo ایجاد می‌کند که محتوای تکلیف انتشار را مصرف می‌کند و آن را فشرده می‌کند، درحالی‌که مطمئن می‌شود ورودی‌های zip در یک پوشه سطح بالا به‌نام mylibrary قرار دارند. برونداد در build/distributions قرار دارد.