بنية المعلومات

طرح الإصدار 8.0 من نظام التشغيل Android بنية معلومات جديدة لتطبيق "الإعدادات" بهدف تبسيط طريقة تنظيم الإعدادات وتسهيل على المستخدمين العثور بسرعة على الإعدادات لتخصيص أجهزة Android. قدّم الإصدار 9 من Android بعض التحسينات لتوفير المزيد من وظائف "الإعدادات" وتسهيل عملية التنفيذ.

الأمثلة والمصدر

يتم حاليًا تنفيذ معظم الصفحات في "الإعدادات" باستخدام الإطار الجديد. إليك مثال جيد: DisplaySettings: packages/apps/Settings/src/com/android/settings/DisplaySettings.java

في ما يلي مسارات الملفات للمكونات المهمة:

  • ‫CategoryKey: packages/SettingsLib/src/com/android/settingslib/drawer/CategoryKey.java
  • DashboardFragmentRegistry: packages/apps/Settings/src/com/android/settings/dashboard/DashboardFragmentRegistry.java
  • DashboardFragment: packages/apps/Settings/src/com/android/settings/dashboard/DashboardFragment.java
  • AbstractPreferenceController: frameworks/base/packages/SettingsLib/src/com/android/settingslib/core/AbstractPreferenceController.java
  • BasePreferenceController (تم طرحه في Android 9): packages/apps/Settings/src/com/android/settings/core/BasePreferenceController.java

التنفيذ

ننصح الشركات المصنّعة للأجهزة بتكييف بنية معلومات الإعدادات الحالية وإدراج صفحات إعدادات إضافية حسب الحاجة لاستيعاب ميزات خاصة بالمشرِكين. يمكن أن يكون نقل الإعدادات المفضّلة من صفحة قديمة (تم تنفيذها باستخدام SettingsPreferencePage) إلى صفحة جديدة (تم تنفيذها باستخدام DashboardFragment) عملية معقّدة. من المحتمل أنّه لم يتم تنفيذ الإعداد المفضّل من الصفحة القديمة باستخدام PreferenceController.

لذلك، عند نقل الإعدادات المفضّلة من صفحة قديمة إلى صفحة جديدة، عليك إنشاء ملف برمجي PreferenceController ونقل الرمز إلى وحدة التحكّم قبل إنشاء مثيل له في DashboardFragment الجديد. يتم وصف واجهات برمجة التطبيقات التي يحتاج إليهاPreferenceController في أسمائها ومستندة في Javadoc.

ننصحك بشدة بإضافة اختبار وحدة لكل PreferenceController. إذا تم إرسال التغيير إلى AOSP، يجب إجراء اختبار وحدات. للحصول على مزيد من المعلومات عن كيفية كتابة الاختبارات المستندة إلى Robolectric، اطّلِع علىملف readmepackages/apps/Settings/tests/robotests/README.md.

بنية المعلومات على غرار المكوّنات الإضافية

يتم تنفيذ كل عنصر من عناصر الإعدادات كإعداد مفضّل. يمكن نقل الإعدادات المفضّلة بسهولة من صفحة إلى أخرى.

لتسهيل نقل إعدادات متعددة، وفّر نظام التشغيل Android 8.0 شريحة مضيفة على غرار المكوّن الإضافي تحتوي على عناصر الإعدادات. يتم تمثيل عناصر الإعدادات كعناصر تحكّم على غرار المكوّنات الإضافية. وبالتالي، يتم إنشاء صفحة الإعدادات من خلال شريحة مضيفة واحدة وعناصر تحكّم متعددة في الإعدادات.

DashboardFragment

DashboardFragment هو مضيف عناصر التحكّم في الإعدادات المفضّلة على غرار المكوّنات الإضافية. يرث المقتطف من PreferenceFragment ويحتوي على عناصر ربط ل توسيع كلّ من قوائم الإعدادات المفضّلة الثابتة وقوائم الإعدادات المفضّلة الديناميكية وتعديلها.

الإعدادات المفضّلة الثابتة

يتم تحديد قائمة الإعدادات المفضّلة الثابتة في ملف XML باستخدام العلامة <Preference>. يستخدم تنفيذ DashboardFragment طريقة getPreferenceScreenResId() لتحديد ملف XML الذي يحتوي على القائمة الثابتة للإعدادات المفضّلة التي سيتم عرضها.

الخيارات المفضّلة الديناميكية

يمثّل العنصر الديناميكي مربّع شاشة يتضمّن هدفًا يؤدي إلى activity خارجي أو داخلي. يؤدي الإجراء عادةً إلى صفحة إعدادات مختلفة. على سبيل المثال، عنصر الإعداد "Google" في الصفحة الرئيسية لإعدادات Google هو عنصر ديناميكي. يتم تعريف العناصر الديناميكية في AndroidManifest (المُناقشة أدناه) ويتم تحميلها من خلال FeatureProvider (يُعرَّف على أنّه DashboardFeatureProvider).

إنّ الإعدادات الديناميكية أكثر استهلاكًا للطاقة من الإعدادات التي يتم ضبطها بشكلٍ ثابت، لذا على المطوّرين عادةً تنفيذ الإعدادات على أنّها ثابتة. ومع ذلك، يمكن أن يكون الإعداد الديناميكي مفيدًا في أيٍّ من الحالات التالية:

  • لا يتم تنفيذ الإعداد مباشرةً في تطبيق "الإعدادات" (مثل إدخال إعداد ينفذه تطبيقات المصنّع الأصلي للجهاز أو مشغّل شبكة الجوّال).
  • من المفترض أن يظهر الإعداد في صفحة "الإعدادات" الرئيسية.
  • إذا كان لديك نشاط حاليًا للإعداد ولا تريد تنفيذ الإعداد الثابت الإضافي

لضبط "نشاط" كإعداد ديناميكي، اتّبِع الخطوات التالية:

  • ضَع علامة على النشاط باعتباره إعدادًا ديناميكيًا عن طريق إضافة فلتر أهداف إلى النشاط.
  • أخبِر تطبيق "الإعدادات" بالفئة التي ينتمي إليها. الفئة هي ثابتة، وتكون محدّدة في CategoryKey.
  • اختياري: أضِف نصًا موجزًا عند عرض الإعداد.

في ما يلي مثال مأخوذ من تطبيق "الإعدادات" على جهاز DisplaySettings. 

<activity android:name="Settings$DisplaySettingsActivity"
                   android:label="@string/display_settings"
                   android:icon="@drawable/ic_settings_display">
             <!-- Mark the activity as a dynamic setting -->
              <intent-filter>
                     <action android:name="com.android.settings.action.IA_SETTINGS" />
              </intent-filter>
             <!-- Tell Settings app which category it belongs to -->
              <meta-data android:name="com.android.settings.category"
                     android:value="com.android.settings.category.ia.homepage" />
             <!-- Add a summary text when the setting is displayed -->
              <meta-data android:name="com.android.settings.summary"
                     android:resource="@string/display_dashboard_summary"/>
             </activity>

في وقت العرض، سيطلب المقتطف قائمة بالإعدادات المفضّلة من كلّ من ملف XML الساكن والإعدادات الديناميكية المحدّدة في AndroidManifest. سواءً تم تعريف PreferenceController في رمز Java أو في XML، تدِير DashboardFragment منطق معالجة كلّ إعداد من خلال PreferenceController (الموضّح أدناه). وبعد ذلك، يتم عرضها في واجهة المستخدم كقائمة مختلطة.

PreferenceController

هناك اختلافات بين تنفيذ PreferenceController في Android 9 وAndroid 8.x، كما هو موضّح في هذا القسم.

PreferenceController في إصدار Android 9

يحتوي PreferenceController على كل المنطق للتفاعل مع الإعدادات المفضّلة، بما في ذلك العرض والتحديث والفهرسة في البحث وما إلى ذلك.

يتم تعريف واجهة PreferenceController على النحو التالي: BasePreferenceController. على سبيل المثال، اطّلِع على الرمز في packages/apps/Settings/src/com/android/settings/core/ BasePreferenceController.java.

هناك عدة فئات فرعية من BasePreferenceController، وكل منها مرتبط بأسلوب واجهة مستخدم معيّن يتيحه تطبيق "الإعدادات" تلقائيًا. على سبيل المثال، يحتوي TogglePreferenceController على واجهة برمجة تطبيقات ترتبط مباشرةً بكيفية تفاعل المستخدم مع واجهة مستخدم الإعدادات المفضّلة المستندة إلى التبديل.

تتضمّن BasePreferenceController واجهات برمجة تطبيقات مثل getAvailabilityStatus() وdisplayPreference() handlePreferenceTreeClicked(), وما إلى ذلك. تتوفّر مستندات تفصيلية لكل واجهة برمجة تطبيقات في فئة الواجهة.

يتمثل أحد القيود المفروضة على تنفيذ BasePreferenceController (و فئاتها الفرعية، مثل TogglePreferenceController) في أنّه يجب أن يتطابق توقيع المنشئ مع أيٍّ مما يلي:

  • public MyController(Context context, String key) {}
  • public MyController(Context context) {}

أثناء تثبيت إعداد مفضّل على المقتطف، توفّر لوحة البيانات طريقة ل إرفاق PreferenceController قبل وقت العرض. في وقت التثبيت، يتم ربط وحدة التحكّم بالجزء حتى يتم إرسال جميع الأحداث ذات الصلة في المستقبل إلى وحدة التحكّم.

يحتفظ DashboardFragment بقائمة PreferenceController على الشاشة. في العنصر المجزّأ onCreate()، يتمّ استدعاء جميع وحدات التحكّم لطريقة getAvailabilityStatus()، وإذا كانت تعرض قيمة صحيحة، يتمّ استدعاء displayPreference() لمعالجة منطق العرض. getAvailabilityStatus() من المهم أيضًا إخبار إطار عمل "الإعدادات"getAvailabilityStatus() بالعناصر المتوفّرة أثناء البحث.

PreferenceController في إصدارات Android 8.x

يحتوي PreferenceController على كل المنطق للتفاعل مع الإعدادات المفضّلة، بما في ذلك العرض والتحديث والفهرسة في البحث وما إلى ذلك.

وفقًا للتفاعلات مع الإعدادات المفضّلة، تتضمّن واجهة PreferenceController واجهات برمجة التطبيقات isAvailable() و displayPreference() وhandlePreferenceTreeClicked() وما إلى ذلك. يمكن العثور على مستندات تفصيلية حول كل واجهة برمجة تطبيقات في فئة الواجهة.

أثناء تثبيت إعداد مفضّل على المقتطف، توفّر لوحة البيانات طريقة ل إرفاق PreferenceController قبل وقت العرض. في وقت التثبيت، يتم ربط وحدة التحكّم بالجزء حتى يتم إرسال جميع الأحداث ذات الصلة في المستقبل إلى وحدة التحكّم.

يحتفظ DashboardFragment بقائمة PreferenceControllers على الشاشة. في onCreate() للّقطة، يتمّ استدعاء جميع عناصر التحكّم لإجراء isAvailable()، وإذا كانت تُعرِض قيمة صحيحة، يتمّ استدعاء displayPreference() لمعالجة منطق العرض.

استخدام DashboardFragment

نقل إعداد مفضّل من الصفحة "أ" إلى الصفحة "ب"

إذا كانت الإعدادات المفضّلة مُدرَجة بشكل ثابت في ملف XML للإعدادات المفضّلة للصفحة الأصلية، اتّبِع إجراء النقل الثابت لإصدار Android المُستخدَم أدناه. بخلاف ذلك، اتّبِع إجراءات نقل البيانات الديناميكية لإصدار Android.

نقل البيانات الثابتة في Android 9

  1. ابحث عن ملفات XML المفضّلة للصفحة الأصلية والوجهة الصفحة. يمكنك العثور على هذه المعلومات من خلال getPreferenceScreenResId() في الصفحة.
  2. أزِل الإعدادات المفضّلة من ملف XML للصفحة الأصلية.
  3. أضِف الإعداد المفضّل إلى ملف XML للصفحة المقصودة.
  4. أزِل PreferenceController لهذا الخيار المفضّل من تنفيذ Java للصفحة الأصلية. ويكون عادةً بتنسيق createPreferenceControllers(). قد يتمّ الإعلان عن وحدة التحكّم في ملف XML مباشرةً.

    ملاحظة: قد لا يتضمّن الخيار المفضّل رمز PreferenceController.

  5. أنشئ مثيلًا للعنصر PreferenceController في createPreferenceControllers() للصفحة المقصودة. إذا تم تعريف PreferenceController في ملف XML للصفحة القديمة، حدِّده في ملف XML للصفحة الجديدة أيضًا.

التنقّل الديناميكي في Android 9

  1. ابحث عن الفئة التي تستضيف الصفحة الأصلية والصفحة المقصودة. يمكنك الاطّلاع على هذه المعلومات في DashboardFragmentRegistry.
  2. افتح ملف AndroidManifest.xml الذي يحتوي على الإعداد الذي تحتاج إلى نقله وابحث عن إدخال "النشاط" الذي يمثّل هذا الإعداد.
  3. اضبط قيمة البيانات الوصفية للنشاط لسمة com.android.settings.category على مفتاح فئة الصفحة الجديدة.

النقل الثابت في إصدارات Android 8.x

  1. ابحث عن ملفات XML للإعدادات المفضّلة للصفحة الأصلية والصفحة المقصودة.
    2. يمكنك العثور على هذه المعلومات من خلال طريقة getPreferenceScreenResId() للصفحة.
  2. أزِل الإعدادات المفضّلة في ملف XML للصفحة الأصلية.
  3. أضِف الإعداد المفضّل إلى ملف XML للصفحة المقصودة.
  4. أزِل العلامة PreferenceController لهذا الخيار المفضّل في تطبيق Java للصفحة الأصلية. ويكون عادةً في getPreferenceControllers().

    5. ملاحظة: من الممكن ألا يكون للإعداد المفضّل قيمة PreferenceController.

  5. أنشئ مثيلًا للعنصر PreferenceController في getPreferenceControllers() للصفحة المقصودة.

النقل الديناميكي في إصدارات Android 8.x

  1. ابحث عن الفئة التي تستضيف الصفحة الأصلية والصفحة المقصودة. يمكنك العثور على هذه المعلومات في DashboardFragmentRegistry.
  2. افتح ملف AndroidManifest.xml الذي يحتوي على الإعداد الذي تحتاج إلى نقله وابحث عن إدخال "النشاط" الذي يمثّل هذا الإعداد.
  3. غيِّر قيمة البيانات الوصفية للنشاط com.android.settings.category، وأضِف القيمة التي تشير إلى مفتاح فئة الصفحة الجديدة.

إنشاء إعداد مفضّل جديد في صفحة

إذا كانت الإعدادات المفضّلة مُدرَجة بشكل ثابت في ملف XML للإعدادات المفضّلة للصفحة الأصلية، اتّبِع الإجراء الثابت أدناه. بخلاف ذلك، اتّبِع الإجراء الديناميكي.

إنشاء إعداد مفضّل ثابت

  1. ابحث عن ملفات XML للإعدادات المفضّلة للصفحة. يمكنك العثور على هذه المعلومات من الطريقة getPreferenceScreenResId() للصفحة.
  2. أضِف عنصر Preference جديدًا في ملف XML. تأكَّد من أنّه يحتوي على android:key فريد.
  3. حدِّد PreferenceController لهذا الخيار المفضّل في طريقة getPreferenceControllers() للصفحة.
    • في الإصدار 8.x من Android والإصدار 9 اختياريًا، أنشئ مثيلًا لـ PreferenceController لهذا الخيار المفضّل في createPreferenceControllers() الصفحة.

      إذا كان هذا الخيار المفضّل متوفّرًا في مواضع أخرى، من المحتمل أن يكون هناك PreferenceController له. يمكنك إعادة استخدام PreferenceController بدون إنشاء نموذج جديد.

    • بدءًا من Android 9، يمكنك اختيار إدراج العنصر PreferenceController في ملف XML بجانب الإعدادات المفضّلة. مثلاً: 
      <Preference
        android:key="reset_dashboard"
        android:title="@string/reset_dashboard_title"
        settings:controller="com.android.settings.system.ResetPreferenceController"/>

إنشاء إعداد مفضّل ديناميكي

  1. ابحث عن الفئة التي تستضيف الصفحة الأصلية والصفحة المقصودة. يمكنك العثور على هذه المعلومات في DashboardFragmentRegistry.
  2. إنشاء نشاط جديد في AndroidManifest
  3. أضِف البيانات الوصفية اللازمة إلى "النشاط" الجديد لتحديد الإعداد. اضبط قيمة ال metadata لـ com.android.settings.category على القيمة نفسها التي تم تحديدها في الخطوة 1.

إنشاء صفحة جديدة

  1. أنشئ جزءًا جديدًا يرث من DashboardFragment.
  2. حدِّد فئتها في DashboardFragmentRegistry.

    ملاحظة: هذه الخطوة اختيارية. إذا لم تكن بحاجة إلى أيّ إعدادات مفضّلة ديناميكية في هذه الصفحة، ليس عليك تقديم مفتاح فئة.

  3. اتّبِع الخطوات لإضافة الإعدادات المطلوبة لهذه الصفحة. لمزيد من المعلومات، يُرجى الاطّلاع على قسم التنفيذ.

التحقُّق

  • يمكنك إجراء اختبارات Robolectric في "الإعدادات". يجب اجتياز جميع الاختبارات الحالية والجديدة.
  • أنشئ تطبيق "الإعدادات" وثبِّته، ثم افتح يدويًا الصفحة التي يتم تعديلها. من المفترض أن يتم تعديل الصفحة على الفور.