این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

انتقال داده توسط کاربر

اگر لازم است انتقال داده‌ای انجام دهید که ممکن است زمان زیادی طول بکشد، می‌توانید کار JobScheduler ایجاد کنید و آن را به‌عنوان کار انتقال داده آغازشده ازسوی کاربر (UIDT) شناسایی کنید. کارهای UIDT برای انتقال داده‌های طولانی‌تر که توسط کاربر دستگاه آغاز می‌شود، مانند بارگیری فایل از سرور راه دور، درنظر گرفته شده‌اند. کارهای UIDT با Android 14 (سطح میانای برنامه‌سازی کاربردی ۳۴) معرفی شدند.

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

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

کارهای انتقال داده توسط کاربر را برنامه ریزی کنید

برای اجرای کار انتقال داده آغازشده ازسوی کاربر، موارد زیر را انجام دهید:

مطمئن شوید برنامه‌تان JobService و اجازه‌های مرتبط را در مانیفست خود اعلام کرده باشد:

<service android:name="com.example.app.CustomTransferService"
        android:permission="android.permission.BIND_JOB_SERVICE"
        android:exported="false">
        ...
</service>

همچنین، یک زیرکلاس واقعی از JobService برای انتقال داده‌هایتان تعریف کنید:

کاتلین

class CustomTransferService : JobService() {
  ...
}

جاوا

class CustomTransferService extends JobService() {

    ....

}

اجازه RUN_USER_INITIATED_JOBS را در مانیفست اعلام کنید:

<manifest ...>
    <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
    <application ...>
        ...
    </application>
</manifest>

هنگام ساختن شیء JobInfo، روش setUserInitiated() را فراخوانی کنید. (این روش از Android 14 به بعد دردسترس است.) همچنین توصیه می‌کنیم با فراخوانی setEstimatedNetworkBytes() هنگام ایجاد کار، اندازه بار داده را تخمین بزنید.

کاتلین

val networkRequestBuilder = NetworkRequest.Builder()
        // Add or remove capabilities based on your requirements.
        // For example, this code specifies that the job won't run
        // unless there's a connection to the internet (not just a local
        // network), and the connection doesn't charge per-byte.
        .addCapability(NET_CAPABILITY_INTERNET)
        .addCapability(NET_CAPABILITY_NOT_METERED)
        .build()

val jobInfo = JobInfo.Builder(jobId,
              ComponentName(mContext, CustomTransferService::class.java))
        // ...
        .setUserInitiated(true)
        .setRequiredNetwork(networkRequestBuilder)
        // Provide your estimate of the network traffic here
        .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024)
        // ...
        .build()

جاوا

NetworkRequest networkRequest = new NetworkRequest.Builder()
    // Add or remove capabilities based on your requirements.
    // For example, this code specifies that the job won't run
    // unless there's a connection to the internet (not just a local
    // network), and the connection doesn't charge per-byte.
    .addCapability(NET_CAPABILITY_INTERNET)
    .addCapability(NET_CAPABILITY_NOT_METERED)
    .build();

JobInfo jobInfo = JobInfo.Builder(jobId,
        new ComponentName(mContext, CustomTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024)
    // ...
    .build();

درحین اجرای کار، setNotification() را در شیء JobService فراخوانی کنید. فراخوانی setNotification() کاربر را از اجرای کار مطلع می‌کند، هم در «مدیر وظیفه» و هم در ناحیه اعلان نوار وضعیت.

وقتی اجرا کامل شد، jobFinished() را فراخوانی کنید تا به سیستم علامت دهید که کار کامل شده است یا باید دوباره زمان‌بندی شود.

کاتلین

class CustomTransferService: JobService() {
    private val scope = CoroutineScope(Dispatchers.IO)

    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    override fun onStartJob(params: JobParameters): Boolean {
        val notification = Notification.Builder(applicationContext,
                              NOTIFICATION_CHANNEL_ID)
            .setContentTitle("My user-initiated data transfer job")
            .setSmallIcon(android.R.mipmap.myicon)
            .setContentText("Job is running")
            .build()

        setNotification(params, notification.id, notification,
                JobService.JOB_END_NOTIFICATION_POLICY_DETACH)
        // Execute the work associated with this job asynchronously.
        scope.launch {
            doDownload(params)
        }
        return true
    }

    private suspend fun doDownload(params: JobParameters) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false)
    }

    // Called when the system stops the job.
    override fun onStopJob(params: JobParameters?): Boolean {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true // or return false if job should end entirely
    }
}

جاوا

class CustomTransferService extends JobService{
    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    @Override
    public boolean onStartJob(JobParameters params) {
        Notification notification = Notification.Builder(getBaseContext(),
                                        NOTIFICATION_CHANNEL_ID)
                .setContentTitle("My user-initiated data transfer job")
                .setSmallIcon(android.R.mipmap.myicon)
                .setContentText("Job is running")
                .build();

        setNotification(params, notification.id, notification,
                          JobService.JOB_END_NOTIFICATION_POLICY_DETACH)
        // Execute the work associated with this job asynchronously.
        new Thread(() -> doDownload(params)).start();
        return true;
    }

    private void doDownload(JobParameters params) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false);
    }

    // Called when the system stops the job.
    @Override
    public boolean onStopJob(JobParameters params) {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true; // or return false if job should end entirely
    }
}

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

توصیه‌ها

برای اجرای مؤثر کارهای UIDT، موارد زیر را انجام دهید:

محدودیت‌های شبکه و محدودیت‌های اجرای کار را به‌وضوح تعریف کنید تا مشخص شود کار چه زمانی باید اجرا شود.
تکلیف را به‌صورت ناهمگام در onStartJob() اجرا کنید؛ برای مثال، می‌توانید این کار را بااستفاده از روال همکار انجام دهید. اگر تکلیف را به‌صورت ناهمگام اجرا نکنید، کار در رشته اصلی اجرا می‌شود و ممکن است آن را مسدود کند، که می‌تواند باعث بروز خطای ANR شود.
برای جلوگیری از اجرای کار طولانی‌تر از حد لازم، jobFinished() را پس‌از اتمام انتقال، چه موفقیت‌آمیز باشد چه ناموفق، فراخوانی کنید. به‌این‌ترتیب، کار بیشتر از حد لازم اجرا نمی‌شود. برای پی بردن به دلیل توقف کار، روش فراخوانی برگشتی onStopJob() را پیاده‌سازی کنید و JobParameters.getStopReason() را فراخوانی کنید.

سازگاری به عقب

درحال‌حاضر هیچ کتابخانه Jetpack وجود ندارد که از کارهای UIDT پشتیبانی کند. به همین دلیل، توصیه می‌کنیم تغییرتان را با کدی که تأیید می‌کند در Android نسخه ۱۴ یا بالاتر اجرا می‌شود محدود کنید. در نسخه‌های پایین‌تر Android، می‌توانید از پیاده‌سازی سرویس پیش‌زمینه‌ای WorkManager به‌عنوان رویکرد جایگزین استفاده کنید.

در اینجا نمونه‌ای از کد آورده شده است که نسخه سیستم مناسب را بررسی می‌کند:

کاتلین

fun beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context)
    } else {
        scheduleDownloadUIDTJob(context)
    }
}

private fun scheduleDownloadUIDTJob(context: Context) {
    // build jobInfo
    val jobScheduler: JobScheduler =
        context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
    jobScheduler.schedule(jobInfo)
}

private fun scheduleDownloadFGSWorker(context: Context) {
    val myWorkRequest = OneTimeWorkRequest.from(DownloadWorker::class.java)
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

جاوا

public void beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context);
    } else {
        scheduleDownloadUIDTJob(context);
    }
}

private void scheduleDownloadUIDTJob(Context context) {
    // build jobInfo
    JobScheduler jobScheduler =
            (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE);
    jobScheduler.schedule(jobInfo);
}

private void scheduleDownloadFGSWorker(Context context) {
    OneTimeWorkRequest myWorkRequest = OneTimeWorkRequest.from(DownloadWorker.class);
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

کارهای UIDT را متوقف کنید

هم کاربر و هم سیستم می توانند کارهای انتقال آغاز شده توسط کاربر را متوقف کنند.

توسط کاربر، از Task Manager

کاربر می تواند یک کار انتقال داده توسط کاربر را که در Task Manager ظاهر می شود متوقف کند.

در لحظه ای که کاربر Stop را فشار می دهد، سیستم کارهای زیر را انجام می دهد:

فرآیند برنامه شما را فوراً خاتمه می دهد، از جمله سایر مشاغل یا خدمات پیش زمینه در حال اجرا.
برای هیچ کار در حال اجرا، onStopJob() فراخوانی نمی کند.
از برنامه ریزی مجدد مشاغل قابل مشاهده توسط کاربر جلوگیری می کند.

به این دلایل، توصیه می‌شود کنترل‌هایی را در اعلان ارسال شده برای کار ارائه کنید تا امکان توقف و زمان‌بندی مجدد کار را فراهم کنید.

توجه داشته باشید که در شرایط خاص، دکمه Stop در کنار کار در Task Manager ظاهر نمی شود یا اصلاً کار در Task Manager نشان داده نمی شود.

توسط سیستم

برخلاف مشاغل معمولی، کارهای انتقال داده توسط کاربر تحت تاثیر سهمیه App Standby Buckets قرار نمی گیرند. با این حال، در صورت بروز هر یک از شرایط زیر، سیستم همچنان کار را متوقف می کند:

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

هنگامی که کار به دلایلی غیر از حافظه کم دستگاه توسط سیستم متوقف می شود، سیستم onStopJob() را فراخوانی می کند و سیستم در زمانی که سیستم بهینه بداند کار را دوباره امتحان می کند. مطمئن شوید که برنامه شما می‌تواند وضعیت انتقال داده را حفظ کند، حتی اگر onStopJob() فراخوانی نشود، و برنامه شما می‌تواند این حالت را با فراخوانی مجدد onStartJob() بازیابی کند.

شرایط مجاز برای زمان‌بندی کارهای انتقال داده توسط کاربر

برنامه‌ها تنها در صورتی می‌توانند یک کار انتقال داده توسط کاربر را شروع کنند که برنامه در پنجره قابل مشاهده باشد یا شرایط خاصی وجود داشته باشد:

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

اگر قرار باشد کار در زمانی اجرا شود که شرایط لازم برآورده نشده باشد، کار از کار می افتد و کد خطای RESULT_FAILURE را برمی گرداند.

محدودیت هایی که برای کارهای انتقال داده توسط کاربر مجاز است

برای پشتیبانی از کارهایی که در نقاط بهینه اجرا می‌شوند، Android امکان اختصاص دادن محدودیت‌ها را به هر نوع کار ارائه می‌دهد. این محدودیت‌ها از Android 13 دردسترس است.

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

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

این‌ها محدودیت‌های مجاز برای کارهای انتقال داده آغازشده ازسوی کاربر هستند:

setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
setClipData()
setEstimatedNetworkBytes()
setMinimumNetworkChunkBytes()
setPersisted()
setNamespace()
setRequiredNetwork()
setRequiredNetworkType()
setRequiresBatteryNotLow()
setRequiresCharging()
setRequiresStorageNotLow()

تست کردن

لیست زیر مراحلی را در مورد نحوه آزمایش دستی کارهای برنامه خود نشان می دهد:

برای دریافت شناسه شغلی، مقداری را که بر روی کار در حال ساخت تعریف شده است، دریافت کنید.
برای اجرای فوری یک کار یا امتحان مجدد یک کار متوقف شده، دستور زیر را در پنجره ترمینال اجرا کنید:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
برای شبیه سازی سیستم توقف اجباری یک کار (به دلیل سلامت سیستم یا شرایط خارج از سهمیه)، دستور زیر را در پنجره ترمینال اجرا کنید:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

همچنین ببینید

منابع اضافی

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

مطالعه موردی در مورد ادغام UIDT: Google Maps با استفاده از API انتقال داده آغاز شده توسط کاربر، قابلیت اطمینان دانلود را 10 درصد بهبود بخشید.

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

کارهای انتقال داده توسط کاربر را برنامه ریزی کنید

کاتلین

جاوا

کاتلین

جاوا

کاتلین

جاوا

توصیه‌ها

سازگاری به عقب

کاتلین

جاوا

کارهای UIDT را متوقف کنید

توسط کاربر، از Task Manager

توسط سیستم

شرایط مجاز برای زمان‌بندی کارهای انتقال داده توسط کاربر

محدودیت هایی که برای کارهای انتقال داده توسط کاربر مجاز است

تست کردن

همچنین ببینید

منابع اضافی

انتقال داده توسط کاربر