יצירת ספק של תוכן stub
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מסגרת מתאם הסנכרון תוכננה לפעול עם נתוני מכשירים שמנוהלים באמצעות
של ספק תוכן מאובטח מאוד. מסיבה זו, ה-framework של מתאם הסנכרון מצפה
שאפליקציה שמשתמשת ב-framework כבר הגדירה ספק תוכן לנתונים המקומיים שלה.
אם במסגרת מתאם הסנכרון מנסה להפעיל את מתאם הסנכרון, ובאפליקציה אין
ספק התוכן, מתאם הסנכרון קורס.
אם אתם מפתחים אפליקציה חדשה שמעבירה נתונים משרת למכשיר,
מומלץ מאוד לאחסן את הנתונים המקומיים בספק תוכן. מלבד החשיבות שלהם,
מתאמי סנכרון, ספקי תוכן מציעים מגוון יתרונות אבטחה ובמיוחד
שמיועד לטיפול באחסון נתונים במערכות Android. למידע נוסף על יצירת תוכן
ספק תוכן, ראה יצירת ספק תוכן.
עם זאת, אם אתם כבר מאחסנים נתונים מקומיים בצורה אחרת, עדיין אפשר להשתמש בסנכרון
כדי לטפל בהעברת נתונים. כדי לעמוד בדרישה של מסגרת מתאם הסנכרון עבור
ספק תוכן, עליך להוסיף ספק תוכן stub לאפליקציה. ספק stub מיישם את
המחלקה של ספק התוכן, אבל כל השיטות הנדרשות מחזירה null
או 0
. אם
הוספת ספק stub, אחר כך אפשר להשתמש במתאם סנכרון כדי להעביר נתונים מכל אמצעי אחסון
על המנגנון שבחרתם.
אם כבר יש לך ספק תוכן באפליקציה, אין צורך בספק תוכן stub.
במקרה כזה, אפשר לדלג על השיעור הזה ולהמשיך לשיעור
יצירת מתאם סנכרון. אם אין לך עדיין
של ספק התוכן הזה, בשיעור הזה תלמדו איך להוסיף ספק תוכן stub שמאפשר לכם
מחברים את מתאם הסנכרון ל-framework.
הוספת ספק של תוכן stub
כדי ליצור ספק תוכן stub של האפליקציה, צריך להרחיב את הכיתה
ContentProvider
ולאתר את השיטות הנדרשות. הבאים
בקטע הזה מוסבר איך ליצור את ספק ה-stub:
Kotlin
/*
* Define an implementation of ContentProvider that stubs out
* all methods
*/
class StubProvider : ContentProvider() {
/*
* Always return true, indicating that the
* provider loaded correctly.
*/
override fun onCreate(): Boolean = true
/*
* Return no type for MIME type
*/
override fun getType(uri: Uri): String? = null
/*
* query() always returns no results
*
*/
override fun query(
uri: Uri,
projection: Array<String>,
selection: String,
selectionArgs: Array<String>,
sortOrder: String
): Cursor? = null
/*
* insert() always returns null (no URI)
*/
override fun insert(uri: Uri, values: ContentValues): Uri? = null
/*
* delete() always returns "no rows affected" (0)
*/
override fun delete(uri: Uri, selection: String, selectionArgs: Array<String>): Int = 0
/*
* update() always returns "no rows affected" (0)
*/
override fun update(
uri: Uri,
values: ContentValues,
selection: String,
selectionArgs: Array<String>
): Int = 0
}
Java
/*
* Define an implementation of ContentProvider that stubs out
* all methods
*/
public class StubProvider extends ContentProvider {
/*
* Always return true, indicating that the
* provider loaded correctly.
*/
@Override
public boolean onCreate() {
return true;
}
/*
* Return no type for MIME type
*/
@Override
public String getType(Uri uri) {
return null;
}
/*
* query() always returns no results
*
*/
@Override
public Cursor query(
Uri uri,
String[] projection,
String selection,
String[] selectionArgs,
String sortOrder) {
return null;
}
/*
* insert() always returns null (no URI)
*/
@Override
public Uri insert(Uri uri, ContentValues values) {
return null;
}
/*
* delete() always returns "no rows affected" (0)
*/
@Override
public int delete(Uri uri, String selection, String[] selectionArgs) {
return 0;
}
/*
* update() always returns "no rows affected" (0)
*/
public int update(
Uri uri,
ContentValues values,
String selection,
String[] selectionArgs) {
return 0;
}
}
הצהרה על הספק במניפסט
מסגרת מתאם הסנכרון מאמתת שלאפליקציה שלך יש ספק תוכן על ידי בדיקה
האפליקציה הצהירה על ספק בקובץ המניפסט של האפליקציה. כדי להצהיר על ספק ה-stub ב
מניפסט, צריך להוסיף רכיב <provider>
עם המאפיינים הבאים:
-
android:name="com.example.android.datasync.provider.StubProvider"
-
מציין את השם המוגדר במלואו של המחלקה שבה מוטמע ספק תוכן ה-stub.
-
android:authorities="com.example.android.datasync.provider"
-
רשות URI שמזהה את ספק תוכן ה-stub. הגדרת הערך הזה כערך של האפליקציה
שם חבילה עם המחרוזת ' .provider' שצורפו אליה. למרות שהצהרת על
ספק ה-stub של המערכת, שום דבר לא מנסה לגשת לספק עצמו.
-
android:exported="false"
-
המדיניות קובעת אם אפליקציות אחרות יכולות לגשת לספק התוכן. לתוכן המשני שלך
הספק, צריך להגדיר את הערך ל-
false
, כי אין צורך לאפשר לאפליקציות אחרות לראות
הספק. הערך הזה לא משפיע על האינטראקציה בין מסגרת מתאם הסנכרון
וספק התוכן.
-
android:syncable="true"
-
מגדיר דגל שמציין שניתן לסנכרן את הספק. אם מגדירים את הסימון הזה בתור
true
, אין צורך לקרוא ל-setIsSyncable()
בקוד שלך. הדגל מאפשר למסגרת של מתאם הסנכרון ליצור נתונים
מועברות אצל ספק התוכן, אבל ההעברות מתבצעות רק אם עושים זאת באופן מפורש.
בקטע הקוד הבא מוסבר איך להוסיף את
רכיב <provider>
לקובץ המניפסט של האפליקציה:
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.android.network.sync.BasicSyncAdapter"
android:versionCode="1"
android:versionName="1.0" >
<application
android:allowBackup="true"
android:icon="@drawable/ic_launcher"
android:label="@string/app_name"
android:theme="@style/AppTheme" >
...
<provider
android:name="com.example.android.datasync.provider.StubProvider"
android:authorities="com.example.android.datasync.provider"
android:exported="false"
android:syncable="true"/>
...
</application>
</manifest>
אחרי שיצרתם את יחסי התלות הנדרשים על ידי מסגרת מתאם הסנכרון, תוכלו
תיצור את הרכיב שמכסה את הקוד להעברת נתונים. הרכיב הזה נקרא
למתאם הסנכרון. בשיעור הבא תלמדו איך להוסיף את הרכיב הזה לאפליקציה.
דוגמאות התוכן והקוד שבדף הזה כפופות לרישיונות המפורטים בקטע רישיון לתוכן. Java ו-OpenJDK הם סימנים מסחריים או סימנים מסחריים רשומים של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-27 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-27 (שעון UTC)."],[],[],null,["# Create a stub content provider\n\nThe sync adapter framework is designed to work with device data managed by the flexible and\nhighly secure content provider framework. For this reason, the sync adapter framework expects\nthat an app that uses the framework has already defined a content provider for its local data.\nIf the sync adapter framework tries to run your sync adapter, and your app doesn't have a\ncontent provider, your sync adapter crashes.\n\n\nIf you're developing a new app that transfers data from a server to the device, you should\nstrongly consider storing the local data in a content provider. Besides their importance for\nsync adapters, content providers offer a variety of security benefits and are specifically\ndesigned to handle data storage on Android systems. To learn more about creating a content\nprovider, see [Creating a Content Provider](/guide/topics/providers/content-provider-creating).\n\n\nHowever, if you're already storing local data in another form, you can still use a sync\nadapter to handle data transfer. To satisfy the sync adapter framework requirement for a\ncontent provider, add a stub content provider to your app. A stub provider implements the\ncontent provider class, but all of its required methods return `null` or `0`. If you\nadd a stub provider, you can then use a sync adapter to transfer data from any storage\nmechanism you choose.\n\n\nIf you already have a content provider in your app, you don't need a stub content provider.\nIn that case, you can skip this lesson and proceed to the lesson\n[Creating a Sync Adapter](/training/sync-adapters/creating-sync-adapter). If you don't yet have a\ncontent provider, this lesson shows you how to add a stub content provider that allows you to\nplug your sync adapter into the framework.\n\nAdd a stub content provider\n---------------------------\n\n\nTo create a stub content provider for your app, extend the class\n[ContentProvider](/reference/android/content/ContentProvider) and stub out its required methods. The following\nsnippet shows you how to create the stub provider: \n\n### Kotlin\n\n```kotlin\n/*\n * Define an implementation of ContentProvider that stubs out\n * all methods\n */\nclass StubProvider : ContentProvider() {\n /*\n * Always return true, indicating that the\n * provider loaded correctly.\n */\n override fun onCreate(): Boolean = true\n\n /*\n * Return no type for MIME type\n */\n override fun getType(uri: Uri): String? = null\n\n /*\n * query() always returns no results\n *\n */\n override fun query(\n uri: Uri,\n projection: Array\u003cString\u003e,\n selection: String,\n selectionArgs: Array\u003cString\u003e,\n sortOrder: String\n ): Cursor? = null\n\n /*\n * insert() always returns null (no URI)\n */\n override fun insert(uri: Uri, values: ContentValues): Uri? = null\n\n /*\n * delete() always returns \"no rows affected\" (0)\n */\n override fun delete(uri: Uri, selection: String, selectionArgs: Array\u003cString\u003e): Int = 0\n\n /*\n * update() always returns \"no rows affected\" (0)\n */\n override fun update(\n uri: Uri,\n values: ContentValues,\n selection: String,\n selectionArgs: Array\u003cString\u003e\n ): Int = 0\n}\n```\n\n### Java\n\n```java\n/*\n * Define an implementation of ContentProvider that stubs out\n * all methods\n */\npublic class StubProvider extends ContentProvider {\n /*\n * Always return true, indicating that the\n * provider loaded correctly.\n */\n @Override\n public boolean onCreate() {\n return true;\n }\n /*\n * Return no type for MIME type\n */\n @Override\n public String getType(Uri uri) {\n return null;\n }\n /*\n * query() always returns no results\n *\n */\n @Override\n public Cursor query(\n Uri uri,\n String[] projection,\n String selection,\n String[] selectionArgs,\n String sortOrder) {\n return null;\n }\n /*\n * insert() always returns null (no URI)\n */\n @Override\n public Uri insert(Uri uri, ContentValues values) {\n return null;\n }\n /*\n * delete() always returns \"no rows affected\" (0)\n */\n @Override\n public int delete(Uri uri, String selection, String[] selectionArgs) {\n return 0;\n }\n /*\n * update() always returns \"no rows affected\" (0)\n */\n public int update(\n Uri uri,\n ContentValues values,\n String selection,\n String[] selectionArgs) {\n return 0;\n }\n}\n```\n\nDeclare the provider in the manifest\n------------------------------------\n\n\nThe sync adapter framework verifies that your app has a content provider by checking that your\napp has declared a provider in its app manifest. To declare the stub provider in the\nmanifest, add a [\u003cprovider\u003e](/guide/topics/manifest/provider-element) element with the following attributes:\n\n\n`android:name=\"com.example.android.datasync.provider.StubProvider\"`\n:\n Specifies the fully-qualified name of the class that implements the stub content provider.\n\n\n`android:authorities=\"com.example.android.datasync.provider\"`\n:\n A URI authority that identifies the stub content provider. Make this value your app's\n package name with the string \".provider\" appended to it. Even though you're declaring your\n stub provider to the system, nothing tries to access the provider itself.\n\n\n`android:exported=\"false\"`\n:\n Determines whether other apps can access the content provider. For your stub content\n provider, set the value to `false`, since there's no need to allow other apps to see\n the provider. This value doesn't affect the interaction between the sync adapter framework\n and the content provider.\n\n\n`android:syncable=\"true\"`\n:\n Sets a flag that indicates that the provider is syncable. If you set this flag to\n `true`, you don't have to call [setIsSyncable()](/reference/android/content/ContentResolver#setIsSyncable(android.accounts.Account, java.lang.String, int)) in your code. The flag allows the sync adapter framework to make data\n transfers with the content provider, but transfers only occur if you do them explicitly.\n\n\nThe following snippet shows you how to add the\n[\u003cprovider\u003e](/guide/topics/manifest/provider-element) element to the app manifest: \n\n```xml\n\u003cmanifest xmlns:android=\"http://schemas.android.com/apk/res/android\"\n package=\"com.example.android.network.sync.BasicSyncAdapter\"\n android:versionCode=\"1\"\n android:versionName=\"1.0\" \u003e\n \u003capplication\n android:allowBackup=\"true\"\n android:icon=\"@drawable/ic_launcher\"\n android:label=\"@string/app_name\"\n android:theme=\"@style/AppTheme\" \u003e\n ...\n \u003cprovider\n android:name=\"com.example.android.datasync.provider.StubProvider\"\n android:authorities=\"com.example.android.datasync.provider\"\n android:exported=\"false\"\n android:syncable=\"true\"/\u003e\n ...\n \u003c/application\u003e\n\u003c/manifest\u003e\n```\n\n\nNow that you have created the dependencies required by the sync adapter framework, you can\ncreate the component that encapsulates your data transfer code. This component is called a\nsync adapter. The next lesson shows you how to add this component to your app."]]