مروری بر منابع برنامه

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

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

پس از اینکه منابع برنامه خود را خارجی‌سازی کردید، می‌توانید با استفاده از شناسه‌های منبع که در کلاس R پروژه شما تولید می‌شوند، به آنها دسترسی داشته باشید. این سند به شما نشان می‌دهد که چگونه منابع را در پروژه اندروید خود گروه‌بندی کنید. همچنین به شما نشان می‌دهد که چگونه منابع جایگزین را برای پیکربندی‌های خاص دستگاه فراهم کنید و سپس از کد برنامه یا سایر فایل‌های XML خود به آنها دسترسی پیدا کنید.

انواع منابع گروهی

هر نوع منبع را در یک زیرشاخه خاص از دایرکتوری res/ پروژه خود قرار دهید. برای مثال، در اینجا سلسله مراتب فایل برای یک پروژه ساده آمده است:

MyProject/
    src/
        MyActivity.java
    res/
        drawable/
            graphic.png
        layout/
            main.xml
            info.xml
        mipmap/
            icon.png
        values/
            strings.xml

دایرکتوری res/ شامل تمام منابع موجود در زیرشاخه‌های خود است: یک منبع تصویر، دو منبع طرح‌بندی، یک دایرکتوری mipmap/ برای آیکون‌های لانچر و یک فایل منبع رشته‌ای. نام‌های دایرکتوری منابع مهم هستند و در جدول ۱ توضیح داده شده‌اند.

نکته: برای اطلاعات بیشتر در مورد استفاده از پوشه‌های mipmap، به بخش «قرار دادن آیکون‌های برنامه در دایرکتوری‌های mipmap» مراجعه کنید.

جدول ۱. دایرکتوری‌های منابع پشتیبانی‌شده در دایرکتوری res/ پروژه.

هشدار: هرگز فایل‌های منبع را مستقیماً درون پوشه res/ ذخیره نکنید. این کار باعث خطای کامپایلر می‌شود.

برای اطلاعات بیشتر در مورد انواع منابع، به نمای کلی انواع منابع مراجعه کنید.

منابعی که در زیرشاخه‌های تعریف‌شده در جدول ۱ ذخیره می‌کنید، منابع پیش‌فرض شما هستند. یعنی این منابع، طراحی و محتوای پیش‌فرض برنامه شما را تعریف می‌کنند. با این حال، انواع مختلف دستگاه‌های اندروید ممکن است به انواع مختلفی از منابع نیاز داشته باشند.

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

منابع جایگزین ارائه دهید

اکثر برنامه‌ها منابع جایگزینی را برای پشتیبانی از پیکربندی‌های خاص دستگاه ارائه می‌دهند. به عنوان مثال، منابع ترسیمی جایگزین را برای تراکم‌های مختلف صفحه نمایش و منابع رشته‌ای جایگزین را برای زبان‌های مختلف در نظر بگیرید. در زمان اجرا، اندروید پیکربندی فعلی دستگاه را تشخیص داده و منابع مناسب را برای برنامه شما بارگذاری می‌کند.

شکل ۱. دو دستگاه که از منابع طرح‌بندی متفاوت بر اساس اندازه صفحه نمایش استفاده می‌کنند.

برای مشخص کردن گزینه‌های خاص پیکربندی برای مجموعه‌ای از منابع، موارد زیر را انجام دهید:

1. یک دایرکتوری جدید در res/ ایجاد کنید که به شکل <resources_name> - <qualifier> نامگذاری شده باشد.
   • <resources_name> نام دایرکتوری منابع پیش‌فرض مربوطه است (که در جدول ۱ تعریف شده است).
   • <qualifier> نامی است که پیکربندی منحصر به فردی را که این منابع برای آن استفاده می‌شوند، مشخص می‌کند (تعریف شده در جدول 2).

   می‌توانید بیش از یک <qualifier> اضافه کنید. هر کدام را با یک خط تیره از هم جدا کنید.

   احتیاط: هنگام افزودن چندین توصیف‌کننده، باید آنها را به همان ترتیبی که در جدول ۲ فهرست شده‌اند، قرار دهید. اگر توصیف‌کننده‌ها به طور نادرست مرتب شده باشند، منابع نادیده گرفته می‌شوند.

2. منابع جایگزین مناسب را در این دایرکتوری جدید ذخیره کنید. فایل‌های منبع باید دقیقاً مشابه فایل‌های منبع پیش‌فرض نامگذاری شوند.

برای مثال، در اینجا برخی از منابع پیش‌فرض و جایگزین آورده شده است:

res/
    drawable/
        icon.png
        background.png
    drawable-hdpi/
        icon.png
        background.png

توصیف‌کننده hdpi نشان می‌دهد که منابع موجود در آن دایرکتوری برای دستگاه‌هایی با صفحه نمایش با تراکم بالا هستند. تصاویر موجود در این دایرکتوری‌های drawable برای تراکم‌های صفحه نمایش خاص اندازه‌گذاری شده‌اند، اما نام فایل‌ها دقیقاً یکسان هستند. به این ترتیب، شناسه منبعی که برای ارجاع به تصویر icon.png یا background.png استفاده می‌کنید، همیشه یکسان است. اندروید با مقایسه اطلاعات پیکربندی دستگاه با توصیف‌کننده‌های موجود در نام دایرکتوری منابع، نسخه‌ای از هر منبع را که به بهترین وجه با دستگاه فعلی مطابقت دارد، انتخاب می‌کند.

احتیاط: هنگام تعریف یک منبع جایگزین، مطمئن شوید که آن منبع را در پیکربندی پیش‌فرض نیز تعریف کرده‌اید. در غیر این صورت، برنامه شما ممکن است هنگام تغییر پیکربندی توسط دستگاه با استثنائات زمان اجرا مواجه شود. به عنوان مثال، اگر یک رشته فقط به values-en و نه values ​​اضافه کنید، برنامه شما ممکن است هنگام تغییر زبان پیش‌فرض سیستم توسط کاربر با استثنای Resource Not Found مواجه شود.

جدول ۲ توصیف‌کننده‌های پیکربندی معتبر را به ترتیب اولویت فهرست می‌کند. می‌توانید با جدا کردن هر توصیف‌کننده با خط تیره، چندین توصیف‌کننده را به نام یک دایرکتوری اضافه کنید. اگر از چندین توصیف‌کننده برای یک دایرکتوری منابع استفاده می‌کنید، باید آنها را به ترتیبی که در جدول فهرست شده‌اند، به نام دایرکتوری اضافه کنید.

جدول ۲. نام‌های توصیف‌کننده پیکربندی.

توجه: همه نسخه‌های اندروید از همه توصیف‌کننده‌ها پشتیبانی نمی‌کنند. استفاده از یک توصیف‌کننده جدید، توصیف‌کننده نسخه پلتفرم را به طور ضمنی اضافه می‌کند تا دستگاه‌های قدیمی‌تر بتوانند آن را نادیده بگیرند. به عنوان مثال، استفاده از توصیف‌کننده w600dp به طور خودکار توصیف‌کننده v13 را شامل می‌شود، زیرا توصیف‌کننده available-width در سطح API 13 جدید بود. برای جلوگیری از هرگونه مشکل، همیشه مجموعه‌ای از منابع پیش‌فرض (مجموعه‌ای از منابع بدون توصیف‌کننده ) را در نظر بگیرید. برای اطلاعات بیشتر، به بخش « ارائه بهترین سازگاری دستگاه با منابع» مراجعه کنید.

قوانین نام واجد شرایط

در اینجا چند قانون در مورد استفاده از نام‌های توصیف‌کننده پیکربندی آمده است:

• شما می‌توانید برای یک مجموعه از منابع، چندین توصیف‌کننده (qualifier) ​​تعیین کنید که با خط تیره از هم جدا شده‌اند. برای مثال، drawable-en-rUS-land برای دستگاه‌های US-English در جهت افقی (landscape) اعمال می‌شود.
• ترتیب قرار گرفتن گزینه‌ها باید مطابق جدول ۲ باشد.
  • اشتباه: drawable-hdpi-port/
  • صحیح: drawable-port-hdpi/
• دایرکتوری‌های منابع جایگزین را نمی‌توان تو در تو تعریف کرد. برای مثال، نمی‌توانید res/drawable/drawable-en/ داشته باشید.
• مقادیر به حروف کوچک و بزرگ حساس نیستند. کامپایلر منابع، نام دایرکتوری‌ها را قبل از پردازش به حروف کوچک تبدیل می‌کند تا از بروز مشکلات در سیستم‌های فایل غیر حساس به حروف کوچک و بزرگ جلوگیری شود. هرگونه استفاده از حروف بزرگ در نام‌ها فقط برای افزایش خوانایی است.
• فقط یک مقدار برای هر نوع توصیف‌گر پشتیبانی می‌شود. برای مثال، اگر می‌خواهید از فایل‌های drawable یکسان برای اسپانیا و فرانسه استفاده کنید، نمی‌توانید دایرکتوری به نام drawable-es-fr/ داشته باشید. در عوض، به دو دایرکتوری منبع، مانند drawable-es/ و drawable-fr/ ، نیاز دارید که شامل فایل‌های مناسب باشند. با این حال، لازم نیست فایل‌ها را در هر دو مکان کپی کنید. در عوض، می‌توانید یک نام مستعار برای یک منبع ایجاد کنید، همانطور که در بخش ایجاد منابع مستعار توضیح داده شده است.

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

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

ایجاد منابع مستعار

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

نکته: همه منابع مکانیزمی برای ایجاد نام مستعار برای منبع دیگر ارائه نمی‌دهند. به طور خاص، animation، menu، raw و سایر منابع نامشخص در دایرکتوری xml/ این ویژگی را ارائه نمی‌دهند.

برای مثال، تصور کنید که یک آیکون برنامه، icon.png ، دارید و به یک نسخه منحصر به فرد از آن برای زبان‌های مختلف نیاز دارید. با این حال، دو زبان، انگلیسی-کانادایی و فرانسوی-کانادایی، باید از یک نسخه استفاده کنند. نیازی نیست که تصویر یکسانی را برای هر دو زبان انگلیسی-کانادایی و فرانسوی-کانادایی در دایرکتوری منبع کپی کنید. در عوض، می‌توانید تصویری را که برای هر دو زبان استفاده می‌شود با نامی غیر از icon.png ، مانند icon_ca.png ، ذخیره کنید و آن را در دایرکتوری پیش‌فرض res/drawable/ قرار دهید. سپس یک فایل icon.xml در res/drawable-en-rCA/ و res/drawable-fr-rCA/ ایجاد کنید که با استفاده از عنصر <bitmap> به منبع icon_ca.png اشاره می‌کند. این به شما امکان می‌دهد فقط یک نسخه از فایل PNG و دو فایل XML کوچک که به آن اشاره می‌کنند را ذخیره کنید. برای جزئیات بیشتر به مثال‌های بخش‌های بعدی مراجعه کنید.

قابل ترسیم

برای ایجاد یک نام مستعار برای یک drawable موجود، از عنصر <drawable> استفاده کنید:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <drawable name="icon">@drawable/icon_ca</drawable>
</resources>

اگر این فایل را با نام icon.xml در یک دایرکتوری منبع جایگزین، مانند res/values-en-rCA/ ذخیره کنید، به منبعی کامپایل می‌شود که می‌توانید به عنوان R.drawable.icon به آن ارجاع دهید، اما در واقع یک نام مستعار برای منبع R.drawable.icon_ca است که در res/drawable/ ذخیره می‌شود.

طرح بندی

برای ایجاد یک نام مستعار برای یک طرح‌بندی موجود، از عنصر <include> که در یک <merge> قرار گرفته است، استفاده کنید:

<?xml version="1.0" encoding="utf-8"?>
<merge>
    <include layout="@layout/main_ltr"/>
</merge>

اگر این فایل را با نام main.xml ذخیره کنید، به منبعی کامپایل می‌شود که می‌توانید به عنوان R.layout.main به آن ارجاع دهید، اما در واقع یک نام مستعار برای منبع R.layout.main_ltr است.

رشته‌ها و سایر مقادیر ساده

برای ایجاد یک نام مستعار برای یک رشته موجود، از شناسه منبع رشته مورد نظر به عنوان مقدار رشته جدید استفاده کنید:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="hello">Hello</string>
    <string name="hi">@string/hello</string>
</resources>

منبع R.string.hi اکنون یک نام مستعار برای R.string.hello است.

سایر مقادیر ساده نیز به همین روش کار می‌کنند، مانند رنگ‌ها:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="red">#f00</color>
    <color name="highlight">@color/red</color>
</resources>

به منابع برنامه خود دسترسی پیدا کنید

Once you provide a resource in your application, you can apply it by referencing its resource ID. All resource IDs are defined in your project's R class, which the aapt tool automatically generates.

When your application is compiled, aapt generates the R class, which contains resource IDs for all the resources in your res/ directory. For each type of resource, there is an R subclass, such as R.drawable for all drawable resources. And for each resource of that type, there is a static integer, for example, R.drawable.icon . This integer is the resource ID that you can use to retrieve your resource.

Although the R class is where resource IDs are specified, you don't need to look there to discover a resource ID. A resource ID is always composed of the following:

• The resource type : each resource is grouped into a "type," such as string , drawable , and layout . For more information about the different types, see Resource types overview .
• The resource name , which is either the filename excluding the extension or the value in the XML android:name attribute, if the resource is a simple value, such as a string.

There are two ways you can access a resource:

• In code: using a static integer from a subclass of your R class, such as:

  R.string.hello

  string is the resource type and hello is the resource name. There are many Android APIs that can access your resources when you provide a resource ID in this format. For more information, see the Access resources in code section.

• In XML: using a special XML syntax that corresponds to the resource ID defined in your R class, such as:

  @string/hello

  string is the resource type and hello is the resource name. You can use this syntax in an XML resource any place where a value is expected that you provide in a resource. For more information, see the Access resources from XML section.

Access resources in code

You can use a resource in code by passing the resource ID as a method parameter. For example, you can set an ImageView to use the res/drawable/myimage.png resource using setImageResource() :

val imageView = findViewById(R.id.myimageview) as ImageView
imageView.setImageResource(R.drawable.myimage)

ImageView imageView = (ImageView) findViewById(R.id.myimageview);
imageView.setImageResource(R.drawable.myimage);

You can also retrieve individual resources using methods in Resources , which you can get an instance of with getResources() .

نحو

Here's the syntax to reference a resource in code:

[<package_name>.]R.<resource_type>.<resource_name>

• <package_name> is the name of the package in which the resource is located (not required when referencing resources from your own package).
• <resource_type> is the R subclass for the resource type.
• <resource_name> is either the resource filename without the extension or the android:name attribute value in the XML element, for simple values.

For more information about each resource type and how to reference them, see Resource types overview .

موارد استفاده

There are many methods that accept a resource ID parameter, and you can retrieve resources using methods in Resources . You can get an instance of Resources using Context.getResources() .

Here are some examples of accessing resources in code:

// Load a background for the current screen from a drawable resource.
window.setBackgroundDrawableResource(R.drawable.my_background_image)

// Set the Activity title by getting a string from the Resources object, because
//  this method requires a CharSequence rather than a resource ID.
window.setTitle(resources.getText(R.string.main_title))

// Load a custom layout for the current screen.
setContentView(R.layout.main_screen)

// Set a slide in animation by getting an Animation from the Resources object.
flipper.setInAnimation(AnimationUtils.loadAnimation(this,
        R.anim.hyperspace_in))

// Set the text on a TextView object using a resource ID.
val msgTextView = findViewById(R.id.msg) as TextView
msgTextView.setText(R.string.hello_message)

// Load a background for the current screen from a drawable resource.
getWindow().setBackgroundDrawableResource(R.drawable.my_background_image) ;

// Set the Activity title by getting a string from the Resources object, because
//  this method requires a CharSequence rather than a resource ID.
getWindow().setTitle(getResources().getText(R.string.main_title));

// Load a custom layout for the current screen.
setContentView(R.layout.main_screen);

// Set a slide in animation by getting an Animation from the Resources object.
flipper.setInAnimation(AnimationUtils.loadAnimation(this,
        R.anim.hyperspace_in));

// Set the text on a TextView object using a resource ID.
TextView msgTextView = (TextView) findViewById(R.id.msg);
msgTextView.setText(R.string.hello_message);

Caution: Don't modify the R.java file by hand. It is generated by the aapt tool when your project is compiled. Any changes are overridden next time you compile.

Access resources from XML

You can define values for some XML attributes and elements using a reference to an existing resource. You often do this when creating layout files, to supply strings and images for your widgets.

For example, if you add a Button to your layout, use a string resource for the button text:

<Button
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:text="@string/submit" />

نحو

Here is the syntax to reference a resource in an XML resource:

@[<package_name>:]<resource_type>/<resource_name>

• <package_name> is the name of the package in which the resource is located (not required when referencing resources from the same package).
• <resource_type> is the R subclass for the resource type.
• <resource_name> is either the resource filename without the extension or the android:name attribute value in the XML element, for simple values.

For more information about each resource type and how to reference them, see Resource types overview .

موارد استفاده

In some cases, you must use a resource for a value in XML, such as to apply a drawable image to a widget, but you can also use a resource in XML any place that accepts a simple value. For example, if you have the following resource file that includes a color resource and a string resource :

<?xml version="1.0" encoding="utf-8"?>
<resources>
   <color name="opaque_red">#f00</color>
   <string name="hello">Hello!</string>
</resources>

You can use these resources in the following layout file to set the text color and text string:

<?xml version="1.0" encoding="utf-8"?>
<EditText xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    android:textColor="@color/opaque_red"
    android:text="@string/hello" />

In this case, you don't need to specify the package name in the resource reference, because the resources are from your own package. To reference a system resource, you need to include the package name, as shown in the following example:

<?xml version="1.0" encoding="utf-8"?>
<EditText xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="fill_parent"
    android:layout_height="fill_parent"
    android:textColor="@android:color/secondary_text_dark"
    android:text="@string/hello" />

Note: Always use string resources, so that your application can be localized for other languages. For information about creating alternative resources (such as localized strings), see Provide alternative resources . For a complete guide to localizing your application for other languages, see Localize your app .

You can even use resources in XML to create aliases. For example, you can create a drawable resource that is an alias for another drawable resource:

<?xml version="1.0" encoding="utf-8"?>
<bitmap xmlns:android="http://schemas.android.com/apk/res/android"
    android:src="@drawable/other_drawable" />

This sounds redundant, but can be very useful when using alternative resource. For more information, see the section about creating alias resources .

Reference style attributes

A style attribute resource lets you reference the value of an attribute in the currently applied theme. Referencing a style attribute lets you customize the look of UI elements by styling them to match standard variations supplied by the current theme, instead of supplying a hardcoded value. Referencing a style attribute essentially says, "Use the style that is defined by this attribute in the current theme."

To reference a style attribute, the name syntax is almost identical to the normal resource format, but instead of the "at" symbol ( @ ), use a question mark ( ? ). The resource type portion is optional. So the reference syntax is as follows:

?[<package_name>:][<resource_type>/]<resource_name>

For example, here's how you can reference an attribute to set the text color to match the secondary text color of the system theme:

<EditText id="text"
    android:layout_width="fill_parent"
    android:layout_height="wrap_content"
    android:textColor="?android:textColorSecondary"
    android:text="@string/hello_world" />

Here, the android:textColor attribute specifies the name of a style attribute in the current theme. Android now uses the value applied to the android:textColorSecondary style attribute as the value for android:textColor in this widget. Because the system resource tool knows that an attribute resource is expected in this context, you do not need to explicitly state the type, which is ?android:attr/textColorSecondary . You can exclude the attr type.

Access original files

While uncommon, you might need access your original files and directories. If you do, then saving your files in res/ won't work for you, because the only way to read a resource from res/ is with the resource ID. Instead, you can save your resources in the assets/ directory.

Files saved in the assets/ directory are not given a resource ID, so you can't reference them through the R class or from XML resources. Instead, you can query files in the assets/ directory like a normal file system and read raw data using AssetManager .

However, if all you require is the ability to read raw data (such as a video or audio file), then save the file in the res/raw/ directory and read a stream of bytes using openRawResource() .

Access platform resources

Android contains a number of standard resources, such as styles, themes, and layouts. To access these resources, qualify your resource reference with the android package name. For example, Android provides a layout resource you can use for list items in a ListAdapter :

listAdapter = ArrayAdapter(this, android.R.layout.simple_list_item_1, myarray)

setListAdapter(new ArrayAdapter<String>(this, android.R.layout.simple_list_item_1, myarray));

In this example, simple_list_item_1 is a layout resource defined by the platform for items in a ListView . You can use this instead of creating your own layout for list items.

Provide the best device compatibility with resources

For your app to support multiple device configurations, it's very important that you always provide default resources for each type of resource that your app uses.

For example, if your app supports several languages, always include a values/ directory (in which your strings are saved) without a language and region qualifier . If you instead put all your string files in directories that have a language and region qualifier, then your app crashes when run on a device set to a language that your strings don't support.

As long as you provide default values/ resources, then your app runs properly, even if the user doesn't understand the language it presents. It's better than crashing.

Likewise, if you provide different layout resources based on the screen orientation, pick one orientation as your default. For example, instead of providing layout resources in layout-land/ for landscape and layout-port/ for portrait, leave one as the default, such as layout/ for landscape and layout-port/ for portrait.

Providing default resources is important not only because your app might run on a configuration you hadn't anticipated, but also because new versions of Android sometimes add configuration qualifiers that older versions don't support. If you use a new resource qualifier, but maintain code compatibility with older versions of Android, then when an older version of Android runs your app, it crashes if you don't provide default resources, because it can't use the resources named with the new qualifier.

For example, if your minSdkVersion is set to 4, and you qualify all of your drawable resources using night mode ( night or notnight , which were added in API level 8), then an API level 4 device can't access your drawable resources and crashes. In this case, you probably want notnight to be your default resources, so exclude that qualifier and put your drawable resources in either drawable/ or drawable-night/ .

In short, to provide the best device compatibility, always provide default resources for the resources your app needs to perform properly. Then create alternative resources for specific device configurations using configuration qualifiers.

There is one exception to this rule: If your app's minSdkVersion is 4 or greater, you don't need default drawable resources when you provide alternative drawable resources with the screen density qualifier. Even without default drawable resources, Android can find the best match among the alternative screen densities and scale the bitmaps as necessary. However, for the best experience on all types of devices, provide alternative drawables for all three types of density.

How Android finds the best-matching resource

When you request a resource for which you provide alternatives, Android selects which alternative resource to use at runtime, depending on the current device configuration. To demonstrate how Android selects an alternative resource, assume the following drawable directories each contain different versions of the same images:

drawable/
drawable-en/
drawable-fr-rCA/
drawable-en-port/
drawable-en-notouch-12key/
drawable-port-ldpi/
drawable-port-notouch-12key/

And assume the following is the device configuration:

Locale = en-GB
Screen orientation = port
Screen pixel density = hdpi
Touchscreen type = notouch
Primary text input method = 12key

By comparing the device configuration to the available alternative resources, Android selects drawables from drawable-en-port .

The system arrives at its decision for which resources to use with the following logic:

Figure 2. Flowchart of how Android finds the best-matching resource.

1. Eliminate resource files that contradict the device configuration.

   The drawable-fr-rCA/ directory is eliminated, because it contradicts the en-GB locale.

   drawable/
   drawable-en/
   drawable-fr-rCA/
   drawable-en-port/
   drawable-en-notouch-12key/
   drawable-port-ldpi/
   drawable-port-notouch-12key/
   

   Exception: Screen pixel density is the one qualifier that is not eliminated due to a contradiction. Even though the screen density of the device is hdpi, drawable-port-ldpi/ isn't eliminated because every screen density is considered to be a match at this point. For information, see Screen compatibility overview .

2. Find the next-highest-precedence qualifier in the list ( table 2 ). (Start with MCC.)
3. Do any of the resource directories include this qualifier?
   • If no, return to step two and look at the next qualifier. In this example, the answer is "no" until the language qualifier is reached.
   • If yes, continue to step four.
4. Eliminate resource directories that don't include this qualifier. In this example, the system next eliminates all the directories that don't include a language qualifier:

   drawable/
   drawable-en/
   drawable-en-port/
   drawable-en-notouch-12key/
   drawable-port-ldpi/
   drawable-port-notouch-12key/
   

   Exception: If the qualifier in question is screen pixel density, Android selects the option that most closely matches the device screen density. In general, Android prefers scaling down a larger original image to scaling up a smaller original image. For more information, see Screen compatibility overview .

5. Repeat steps two, three, and four until only one directory remains. In this example, screen orientation is the next qualifier for which there are any matches. So, resources that don't specify a screen orientation are eliminated:

   drawable-en/
   drawable-en-port/
   drawable-en-notouch-12key/
   

   The remaining directory is drawable-en-port .

Though this procedure is executed for each resource requested, the system optimizes some aspects of it. One such optimization is that once the device configuration is known, it might eliminate alternative resources that can never match. For example, if the configuration language is English, then any resource directory that has a language qualifier set to something other than English is never included in the pool of resources checked (though a resource directory without the language qualifier is still included).

When selecting resources based on the screen size qualifiers, the system uses resources designed for a screen smaller than the current screen if there are no resources that better match. For example, a large-size screen uses normal-size screen resources if necessary.

However, if the only available resources are larger than the current screen, the system doesn't use them and your app crashes if no other resources match the device configuration. This happens, for example, if all layout resources are tagged with the xlarge qualifier, but the device is a normal-size screen.

Note: The precedence of the qualifier (in table 2 ) is more important than the number of qualifiers that exactly match the device. In the preceding example, at step four the last choice on the list includes three qualifiers that exactly match the device (orientation, touchscreen type, and input method), while drawable-en has only one parameter that matches (language). However, language has a higher precedence than these other qualifiers, so drawable-port-notouch-12key is eliminated.