อัปโหลดคลัง

หากต้องการให้สิทธิ์เข้าถึงคลัง คุณต้องเลือกที่เก็บ หน้านี้จะแนะนำข้อควรพิจารณาเกี่ยวกับการเลือกประเภทที่เก็บและแสดงวิธีสร้างการเผยแพร่โดยใช้ปลั๊กอินการเผยแพร่ Maven

ก่อนอัปโหลดไลบรารี โปรดตรวจสอบว่าคุณได้เตรียมไลบรารีสำหรับการเผยแพร่และกำหนดค่าตัวแปรการเผยแพร่หรือฟิกซ์เจอร์ทดสอบที่จำเป็นแล้ว

เลือกประเภทที่เก็บ

ไลบรารีจะเผยแพร่เป็นไฟล์ AAR ไฟล์เหล่านี้มีโค้ดที่คอมไพล์แล้วเป็นไบต์โค้ดและไลบรารีแบบเนทีฟ, Android Manifest และทรัพยากร แพ็กเกจเองไม่ได้ประกาศข้อมูลประจำตัว เวอร์ชัน หรือทรัพยากร Dependency ในไลบรารีอื่นๆ

โดยทั่วไปแล้ว การจัดเตรียม AAR ผ่านที่เก็บข้อมูลเป็นแนวทางปฏิบัติแนะนำที่ดีที่สุด แทนที่จะเผยแพร่ AAR โดยตรง ซึ่งจะช่วยให้ผู้ใช้เข้าใจได้ดีขึ้นว่าไลบรารีมาจากไหน แทนที่จะต้องจัดการกับไฟล์ name.aar ที่ไม่มีรายละเอียดสำคัญ เช่น เวอร์ชัน เมื่ออัปเกรดไลบรารีเป็นเวอร์ชันใหม่ ให้ใช้ที่เก็บเพื่อให้แน่ใจว่ามีการเพิ่มเฉพาะทรัพยากร Dependency ที่จำเป็นของเวอร์ชันใหม่เท่านั้น เพื่อให้ผู้ใช้ไม่ต้องอัปเดตทรัพยากร Dependency ด้วยตนเอง

การใช้ที่เก็บเพื่อเผยแพร่ไลบรารีมีประโยชน์หลายอย่าง ดังนี้

  • Gradle สามารถเพิ่มทรัพยากร Dependency ของไลบรารีลงในกราฟทรัพยากร Dependency โดยอัตโนมัติ
  • Gradle ช่วยให้มั่นใจได้ว่าไลบรารีเวอร์ชันเดียวอยู่ในกราฟทรัพยากร Dependency ซึ่งจะช่วยแก้ปัญหาความขัดแย้งหากไลบรารีของคุณรวมอยู่มากกว่า 1 ครั้งโดยมีเวอร์ชันที่แตกต่างกัน
  • ปลั๊กอิน Android Gradle (AGP) สามารถทำการ Desugaring ได้อย่างมีประสิทธิภาพมากขึ้นหากไลบรารีของคุณใช้ฟีเจอร์ภาษา Java 8 ขึ้นไป ซึ่งจะช่วยลดเวลาในการสร้างสำหรับผู้ใช้
  • ไลบรารีของคุณสามารถใช้การเผยแพร่ตัวแปรและรวมฟีเจอร์ต่างๆ เช่น อุปกรณ์ทดสอบ

การเผยแพร่ AAR โดยตรงไม่ได้ให้ข้อมูลใดๆ แก่ผู้ใช้เกี่ยวกับข้อมูลประจำตัว เวอร์ชัน หรือทรัพยากร Dependency ของไลบรารี เมื่อเผยแพร่ไปยังที่เก็บ การเผยแพร่จะได้รับการจัดการโดยไฟล์แยกต่างหากซึ่งเป็นส่วนหนึ่งของกลไกที่เก็บ สำหรับที่เก็บ Maven จะเป็นไฟล์ POM ดังนั้น เราขอแนะนำอย่างยิ่งให้เผยแพร่ไลบรารีโดยใช้ที่เก็บแทนการเผยแพร่ไฟล์ AAR ด้วยตนเอง

ประเภทของที่เก็บข้อมูล

ที่เก็บมี 3 ประเภท ได้แก่

  • ที่เก็บออนไลน์ฟรี เช่น Maven Central ช่วยให้ทุกคนอัปโหลดและดาวน์โหลดไลบรารีได้
  • ที่เก็บข้อมูลส่วนตัวซึ่งเข้าถึงได้ด้วยการเข้าสู่ระบบจะช่วยให้ควบคุมการเผยแพร่ไลบรารีส่วนตัวได้
  • ที่เก็บข้อมูลในเครื่องแบบโฟลเดอร์ช่วยให้สามารถเผยแพร่ไลบรารีผ่านการดาวน์โหลดด้วยตนเอง

การใช้ที่เก็บในเครื่องแบบโฟลเดอร์จะคล้ายกับการให้ลิงก์ดาวน์โหลด AAR ด้วยตนเองแก่ผู้ใช้หรือการส่ง AAR ทางอีเมล ความแตกต่างหลักคือคุณไม่ได้ส่งเพียง AAR เท่านั้น แต่ยังส่งข้อมูลเพิ่มเติมเกี่ยวกับข้อมูลประจำตัว เวอร์ชัน และทรัพยากร Dependency ด้วย

คุณเผยแพร่ไฟล์ ZIP ของที่เก็บข้อมูลแบบโฟลเดอร์ซึ่งมี AAR และข้อมูลเมตา จากนั้นผู้ใช้จะสามารถแตกเนื้อหาของไฟล์ เพิ่มเนื้อหาลงในโปรเจ็กต์ และชี้ Gradle ไปที่เนื้อหาดังกล่าวได้ จากนั้นผู้ใช้จะประกาศทรัพยากร Dependency ในไลบรารีได้โดยใช้พิกัด Maven ราวกับว่าไลบรารีอยู่ในที่เก็บออนไลน์ และได้รับประโยชน์ทั้งหมดที่กล่าวถึงก่อนหน้านี้

สร้างสื่อเผยแพร่

เผยแพร่โดยใช้ปลั๊กอิน Gradle Maven Publish ปลั๊กอิน Maven Publish ช่วยให้คุณประกาศการเผยแพร่และที่เก็บข้อมูล รวมถึงสร้างงานเพื่อเผยแพร่การเผยแพร่เหล่านี้ไปยังที่เก็บข้อมูลได้ การเผยแพร่เหล่านี้ใช้ อินสแตนซ์ SoftwareComponent ที่ปลั๊กอินซึ่งขับเคลื่อนบิลด์สร้างขึ้น ซึ่งอาจเป็น AGP หรือปลั๊กอิน java-library

โปรดทราบว่าเมื่อเรียกใช้ Maven Publish Plugin กับ AGP ระบบจะไม่สร้างคอมโพเนนต์ซอฟต์แวร์โดยตรงเมื่อใช้ปลั๊กอิน แต่จะสร้างขึ้นในขั้นตอน Callback ของ afterEvaluate() แทน ดังนั้น การเผยแพร่ที่เลือกคอมโพเนนต์ซอฟต์แวร์ต้องได้รับการกำหนดค่าในขั้นตอน afterEvaluate() ด้วย

ข้อมูลโค้ดต่อไปนี้ของไฟล์ build.gradle ระดับโมดูลจะสร้างการเผยแพร่สำหรับตัวแปรที่ระบุซึ่งสร้างขึ้นด้วย singleVariant() หรือ multipleVariants()

ดึงดูด

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"])
      }
    }
  }
}

ในตัวอย่างก่อนหน้านี้ ชื่อของคอมโพเนนต์ (components.release) จะอิงตามชื่อที่กำหนดให้กับ singleVariant() หรือ multipleVariants()

เมื่อประกาศการเผยแพร่แล้ว คุณต้องสร้างที่เก็บเป้าหมาย

เผยแพร่ไปยังที่เก็บในเครื่อง

การเผยแพร่ไปยังที่เก็บในเครื่องคล้ายกับการเผยแพร่ไปยังที่เก็บระยะไกลมาก ยกเว้นการประกาศที่เก็บ อ่านส่วนก่อนหน้าเพื่อดูวิธีเผยแพร่ไปยังที่เก็บระยะไกลเพื่อสร้างการเผยแพร่ที่เผยแพร่ตัวแปรที่คุณเลือก จากนั้นสร้างที่เก็บในเครื่องโดยทำดังนี้

ดึงดูด

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"))
    }
  }
}

ซึ่งจะสร้างงานชื่อ publishReleaseToMyRepoRepository ที่ประกอบด้วยชื่อของสื่อเผยแพร่และชื่อที่เก็บข้อมูล เรียกใช้งานนี้เพื่อสร้างที่เก็บไปยังตำแหน่งที่ระบุ ในตัวอย่างนี้ ระบบจะสร้างที่เก็บภายในโฟลเดอร์บิลด์ของโปรเจ็กต์ภายใต้ไดเรกทอรี repo

หากต้องการสร้างไฟล์ ZIP ของที่เก็บโดยอัตโนมัติ ให้ใช้โค้ดต่อไปนี้

ดึงดูด

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")
}

โค้ดนี้จะสร้างงาน Zip ที่ชื่อว่า generateRepo ซึ่งจะใช้เนื้อหาของงานการเผยแพร่และบีบอัดเนื้อหาดังกล่าว พร้อมทั้งตรวจสอบว่ารายการ ZIP อยู่ในโฟลเดอร์ระดับบนสุดที่ชื่อว่า mylibrary เอาต์พุตจะอยู่ใน build/distributions