ข้อมูลอ้างอิงแอตทริบิวต์ของเครื่องมือ

แม้ว่า Jetpack Compose จะจัดการเครื่องมือเวลาออกแบบ UI ใน Kotlin โดยตรง แต่เนมสเปซ tools: ก็ยังคงจำเป็นสำหรับการกำหนดค่าระดับโปรเจ็กต์ ไฟล์ XML มาตรฐานของ Android เช่น AndroidManifest.xml และ res/raw/keep.xml ใช้แอตทริบิวต์ tools: เพื่อจัดการคำเตือน Lint และกำหนดค่าเครื่องมือลดขนาดทรัพยากร

เมื่อคุณสร้างแอป เครื่องมือสร้างจะนำแอตทริบิวต์เหล่านี้ออกเพื่อไม่ให้ส่งผลต่อขนาด APK หรือลักษณะการทำงานของรันไทม์

หากต้องการใช้แอตทริบิวต์เหล่านี้ ให้เพิ่มเนมสเปซ tools ลงในองค์ประกอบรูทของไฟล์ XML แต่ละไฟล์ที่คุณต้องการใช้แอตทริบิวต์ดังกล่าว ดังที่แสดงที่นี่

<RootTag xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools" >

แอตทริบิวต์การจัดการข้อผิดพลาด

แอตทริบิวต์ต่อไปนี้ช่วยระงับข้อความเตือนของ Lint

tools:ignore

ใช้สำหรับ: องค์ประกอบใดก็ได้

ใช้โดย: Lint

แอตทริบิวต์นี้ยอมรับรายการที่คั่นด้วยคอมมาของรหัสปัญหาเครื่องมือวิเคราะห์ซอร์สโค้ดที่คุณต้องการให้เครื่องมือละเว้นในองค์ประกอบนี้หรือองค์ประกอบสืบทอดใดๆ

ตัวอย่างเช่น คุณสามารถบอกให้เครื่องมือละเว้นข้อผิดพลาด MissingTranslation ได้ดังนี้

<string name="show_all_apps" tools:ignore="MissingTranslation">All</string>

tools:targetApi

ใช้สำหรับ: องค์ประกอบใดก็ได้

ใช้โดย: Lint

แอตทริบิวต์นี้ทำงานเหมือนกับคำอธิบายประกอบ @TargetApi ในโค้ด Java หรือคำอธิบายประกอบ @RequiresApi ในโค้ด Kotlin ซึ่งช่วยให้คุณระบุระดับ API (เป็นจำนวนเต็มหรือชื่อเวอร์ชัน) ที่รองรับองค์ประกอบนี้ได้

ซึ่งจะบอกเครื่องมือ Lint ว่าคุณเชื่อว่าองค์ประกอบนี้และองค์ประกอบย่อยใดๆ จะใช้ในระดับ API ที่ระบุหรือสูงกว่าเท่านั้น ซึ่งจะหยุดไม่ให้ Lint เตือนคุณหากองค์ประกอบหรือแอตทริบิวต์ขององค์ประกอบไม่พร้อมใช้งานในระดับ API ที่คุณระบุเป็น minSdkVersion

ตัวอย่างเช่น คุณอาจใช้แอตทริบิวต์นี้เนื่องจากคุณประกาศ <service> ใน AndroidManifest.xml ที่ใช้ประเภทบริการที่ทำงานอยู่เบื้องหน้าซึ่งใช้ได้เฉพาะในระดับ API 34 ขึ้นไป แต่ minSdkVersion ของโปรเจ็กต์ต่ำกว่า

<service
    android:name=".playback.MediaPlaybackService"
    android:foregroundServiceType="mediaPlayback"
    xmlns:tools="http://schemas.android.com/tools"
    tools:targetApi="34" />

tools:locale

เหมาะสำหรับ: <resources>

ใช้โดย: Lint, เครื่องมือแก้ไข Android Studio

ซึ่งจะบอกเครื่องมือว่าภาษาหรือภาษาท้องถิ่นเริ่มต้นสำหรับทรัพยากรในองค์ประกอบ <resources> ที่ระบุคืออะไร เพื่อหลีกเลี่ยงคำเตือนจากเครื่องมือตรวจตัวสะกด มิเช่นนั้น เครื่องมือจะถือว่าภาษาเป็นภาษาอังกฤษ

ค่าต้องเป็นตัวระบุภาษาที่ถูกต้อง

ตัวอย่างเช่น คุณสามารถเพิ่มโค้ดนี้ลงในไฟล์ values/strings.xml เริ่มต้นเพื่อระบุว่าภาษาที่ใช้สำหรับสตริงเริ่มต้นคือภาษาสเปน ไม่ใช่ภาษาอังกฤษ

<resources xmlns:tools="http://schemas.android.com/tools"
    tools:locale="es">

แอตทริบิวต์การลดขนาดทรัพยากร

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

หากต้องการเปิดใช้การลดขนาดทรัพยากร ให้ตั้งค่าพร็อพเพอร์ตี้ shrinkResources เป็น true ในไฟล์ build.gradle ควบคู่ไปกับ minifyEnabled สำหรับการลดขนาดโค้ด

เช่น

ดึงดูด

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

Kotlin

android {
    ...
    buildTypes {
        getByName("release") {
            isShrinkResources = true
            isMinifyEnabled = true
            proguardFiles(
                getDefaultProguardFile("proguard-android.txt"),
                "proguard-rules.pro"
            )
        }
    }
}

tools:shrinkMode

เหมาะสำหรับ: <resources>

ใช้โดย: เครื่องมือสร้างที่มีการลดขนาดทรัพยากร

แอตทริบิวต์นี้ช่วยให้คุณระบุได้ว่าเครื่องมือสร้างควรใช้สิ่งต่อไปนี้หรือไม่

  • โหมดปลอดภัย: เก็บรักษาทรัพยากรทั้งหมดที่มีการอ้างอิงอย่างชัดเจนและอาจมีการอ้างอิงแบบไดนามิกด้วยการเรียกใช้ Resources.getIdentifier
  • โหมดเข้มงวด: เก็บเฉพาะทรัพยากรที่มีการอ้างอิงอย่างชัดเจนในโค้ดหรือในทรัพยากรอื่นๆ

ค่าเริ่มต้นคือการใช้โหมดปลอดภัย (shrinkMode="safe") หากต้องการใช้โหมดเข้มงวดแทน ให้เพิ่ม shrinkMode="strict" ลงในแท็ก <resources> ดังที่แสดงที่นี่

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:shrinkMode="strict" />

เมื่อเปิดใช้โหมดเข้มงวด คุณอาจต้องใช้ tools:keep เพื่อเก็บทรัพยากรที่ถูกนำออกแต่คุณต้องการเก็บไว้ และใช้ tools:discard เพื่อนำทรัพยากรออกอย่างชัดเจนยิ่งขึ้น

ดูข้อมูลเพิ่มเติมได้ที่ลดขนาดทรัพยากร

tools:keep

เหมาะสำหรับ: <resources>

ใช้โดย: เครื่องมือสร้างที่มีการลดขนาดทรัพยากร

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

หากต้องการใช้ ให้สร้างไฟล์ XML ในไดเรกทอรีทรัพยากร (เช่น res/raw/keep.xml) ที่มีแท็ก <resources> และระบุทรัพยากรแต่ละรายการที่จะเก็บไว้ในแอตทริบิวต์ tools:keep เป็นรายการที่คั่นด้วยคอมมา คุณสามารถใช้อักขระดอกจันเป็นไวลด์การ์ดได้

เช่น

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/used_1,@layout/used_2,@layout/*_3" />

ดูข้อมูลเพิ่มเติมได้ที่ลดขนาดทรัพยากร

tools:discard

เหมาะสำหรับ: <resources>

ใช้โดย: เครื่องมือสร้างที่มีการลดขนาดทรัพยากร

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

หากต้องการใช้ ให้สร้างไฟล์ XML ในไดเรกทอรีทรัพยากร (เช่น res/raw/keep.xml) ที่มีแท็ก <resources> และระบุทรัพยากรแต่ละรายการที่จะทิ้งในแอตทริบิวต์ tools:discard เป็นรายการที่คั่นด้วยคอมมา คุณสามารถใช้อักขระดอกจันเป็นไวลด์การ์ดได้

เช่น

<?xml version="1.0" encoding="utf-8"?>
<resources xmlns:tools="http://schemas.android.com/tools"
    tools:discard="@layout/unused_1" />

ดูข้อมูลเพิ่มเติมได้ที่ลดขนาดทรัพยากร

แหล่งข้อมูลเพิ่มเติม

ดูเนื้อหา