รวมประกาศโอเพนซอร์ส

บางครั้งบริการ Google Play มีหรือขึ้นอยู่กับไลบรารีโอเพนซอร์ส เพื่อปฏิบัติตามข้อกำหนดใบอนุญาตของไลบรารีโอเพนซอร์ส คุณในฐานะนักพัฒนาซอฟต์แวร์มีหน้าที่รับผิดชอบในการแสดงประกาศสำหรับไลบรารีโอเพนซอร์สที่แอปของคุณใช้อย่างเหมาะสม

บริการ Google Play มีชุดเครื่องมือที่ออกแบบมาเพื่อช่วยให้นักพัฒนาแอปแสดงประกาศซอฟต์แวร์โอเพนซอร์สของไลบรารีที่ใช้ในแอปของตนได้ง่ายขึ้น หนึ่งในเครื่องมือเหล่านี้คือปลั๊กอิน Gradle ที่รวบรวมคำศัพท์ในใบอนุญาตจากไลบรารีที่รวมไว้ตามที่ประกาศไว้ในไฟล์ POM และสร้างกิจกรรมที่ใช้เพื่อแสดงข้อกำหนดเหล่านี้ได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีที่เครื่องมือค้นหาและข้อมูลใบอนุญาตแพ็กเกจ

เพิ่มปลั๊กอิน Gradle

ในไฟล์บิลด์ระดับราก ให้ทำดังนี้

  1. รวมถึงที่เก็บ Google Maven
  2. เพิ่มปลั๊กอิน oss-licenses ไปยังทรัพยากร Dependency

ข้อมูลโค้ดต่อไปนี้จะแสดงขั้นตอนเหล่านี้

Kotlin DSL

build.gradle.kts

buildscript {
  repositories {
    ...
    google()  // maven { url("https://maven.google.com") } for Gradle <= 3
  }
  dependencies {
    ...
    classpath("com.google.android.gms:oss-licenses-plugin:0.10.6")
  }
}

DSL กรูฟฟี่

build.gradle

buildscript {
  repositories {
    ...
    google()  // maven { url "https://maven.google.com" } for Gradle <= 3
  }
  dependencies {
    ...
    classpath 'com.google.android.gms:oss-licenses-plugin:0.10.6'
  }
}

ในไฟล์บิลด์ระดับแอป ให้ใช้ปลั๊กอินโดยเพิ่มบรรทัดต่อไปนี้ใต้การประกาศปลั๊กอิน com.android.application ที่มีอยู่ที่ด้านบนของไฟล์

Kotlin DSL

app/build.gradle.kts

plugins {
    id("com.android.application")
    id("com.google.android.gms.oss-licenses-plugin")
}

DSL กรูฟฟี่

app/build.gradle

plugins {
    id 'com.android.application'
    id 'com.google.android.gms.oss-licenses-plugin'
}

คุณดูโค้ดสำหรับปลั๊กอินนี้ได้ใน GitHub

เพิ่มไลบรารีลงในแอป

ในส่วน dependencies ของไฟล์บิลด์ระดับแอป ให้เพิ่มทรัพยากร Dependency ในไลบรารี oss-licenses ดังนี้

Kotlin DSL

build.gradle.kts

implementation("com.google.android.gms:play-services-oss-licenses:17.1.0")

DSL กรูฟฟี่

build.gradle

implementation 'com.google.android.gms:play-services-oss-licenses:17.1.0'

แสดงข้อมูลใบอนุญาต

เมื่อสร้างแอป ปลั๊กอิน Gradle จะประมวลผลใบอนุญาตและเพิ่มลงในทรัพยากรของแอป เพื่อให้แสดงใบอนุญาตได้โดยง่าย คุณสามารถเปิดกิจกรรมที่ให้บริการโดยไลบรารี play-services-oss-licenses ในจุดที่เหมาะสมในแอป ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

Kotlin

import com.google.android.gms.oss.licenses.OssLicensesMenuActivity
...

// When the user selects an option to see the licenses:
startActivity(Intent(this, OssLicensesMenuActivity::class.java))

Java

import com.google.android.gms.oss.licenses.OssLicensesMenuActivity;
...

// When the user selects an option to see the licenses:
startActivity(new Intent(this, OssLicensesMenuActivity.class));

เมื่อเปิดตัว กิจกรรมนี้จะแสดงรายการไลบรารีโอเพนซอร์สที่คอมไพล์ไว้ในแอปของคุณ รวมถึงไลบรารีที่เป็นส่วนหนึ่งของบริการ Google Play ดังที่แสดงในรูปที่ 1 ผู้ใช้สามารถแตะชื่อห้องสมุดเพื่อดูข้อมูลใบอนุญาตเพิ่มเติมสำหรับห้องสมุดนั้นๆ

มุมมองรายการที่มีเอลิเมนต์แต่ละรายการที่มีชื่อไลบรารีโอเพนซอร์ส

รูปที่ 1 กิจกรรมเมนูใบอนุญาตแสดงรายการไลบรารีโอเพนซอร์สที่เลือกได้ซึ่งแอปใช้

ตั้งชื่อกิจกรรม

โดยค่าเริ่มต้น กิจกรรมที่แสดงจะมีชื่อว่า "ใบอนุญาตโอเพนซอร์ส" คุณปรับแต่งชื่อกิจกรรมได้โดยเรียกใช้ setActivityTitle() ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

Kotlin

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title))

Java

OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));

ใช้ธีมกับกิจกรรม

คุณสามารถนำธีมไปใช้กับกิจกรรมให้ตรงกับธีมที่ใช้ในกิจกรรมอื่นๆ ของแอป ซึ่งทำได้โดยการรวมกิจกรรมใบอนุญาตโอเพนซอร์สไว้ในองค์ประกอบ <activity> ภายในไฟล์ Manifest ของแอป ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

<application android:theme="@style/AppTheme" ...>
    <activity
        android:name="com.google.android.gms.oss.licenses.OssLicensesMenuActivity"
        android:theme="@style/AppTheme" />
    <activity
        android:name="com.google.android.gms.oss.licenses.OssLicensesActivity"
        android:theme="@style/AppTheme" />
</application>

วิธีกำหนดรายการใบอนุญาต

เวลาคอมไพล์ ปลั๊กอิน Gradle จะสแกนทรัพยากร Dependency ของ POM ของโปรเจ็กต์แอป เมื่อมี POM ของ Maven สำหรับทรัพยากร Dependency ของแอปโดยตรง ปลั๊กอินจะประมวลผลองค์ประกอบ <licenses> แต่ละรายการและฝังลิงก์และชื่อของใบอนุญาตแต่ละรายการในเนื้อหา Android ที่รวมอยู่ในแอป