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

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

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

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

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

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

To run a user initiated data-transfer job, do the following:

Make sure your app has declared the JobService and associated permissions in its manifest:

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

Also, define a concrete subclass of JobService for your data transfer:

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

Declare the RUN_USER_INITIATED_JOBS permission in the manifest:

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

Call the setUserInitiated() method when building a JobInfo object. (This method is available beginning with Android 14.) We also recommend that you offer a payload size estimate by calling setEstimatedNetworkBytes() while creating your job.

Kotlin

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()

Java

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();

While the job is being executed, call setNotification() on the JobService object. Calling setNotification() makes the user aware that the job is running, both in the Task Manager and in the status bar notification area.

When execution is complete, call jobFinished() to signal to the system that the job is complete, or that the job should be rescheduled.

Kotlin

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
    }
}

Java

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
    }
}

Periodically update the notification to keep the user informed of the job's status and progress. If you cannot determine the transfer size ahead of scheduling the job, or need to update the estimated transfer size, use the new API, updateEstimatedNetworkBytes() to update the transfer size after it becomes known.

Recommendations

To run UIDT jobs effectively, do the following:

Clearly define network constraints and job execution constraints to specify when the job should be executed.
Execute the task asynchronously in onStartJob(); for example, you can do this by using a coroutine. If you don't run the task asynchronously, the work runs on the main thread and might block it, which can cause an ANR.
To avoid running the job longer than necessary, call jobFinished() when the transfer finishes, whether it succeeds or fails. That way, the job doesn't run longer than necessary. To discover why a job was stopped, implement the onStopJob() callback method and call JobParameters.getStopReason().

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

There is currently no Jetpack library that supports UIDT jobs. For this reason, we recommend that you gate your change with code that verifies that you're running on Android 14 or higher. On lower Android versions, you can use WorkManager's foreground service implementation as a fallback approach.

Here's an example of code that checks for the appropriate system version:

Kotlin

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)
}

Java

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 نشان داده نمی شود.

توسط سیستم

Unlike regular jobs, user-initiated data transfer jobs are unaffected by App Standby Buckets quotas. However, the system still stops the job if any of the following conditions occur:

A developer-defined constraint is no longer met.
The system determines that the job has run for longer than necessary to complete the data transfer task.
The system needs to prioritize system health and stop jobs due to increased thermal state.
The app process is killed due to low device memory.

When the job is stopped by the system for reasons other than low device memory, the system calls onStopJob(), and the system retries the job at a time that the system deems to be optimal. Make sure that your app can persist the data transfer state even if onStopJob() isn't called, and that your app can restore this state when onStartJob() is called again.

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

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

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

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

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

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

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

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

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

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

تست کردن

The following list shows some steps on how to test your app's jobs manually:

To get the job ID, get the value that is defined upon the job being built.
To run a job immediately, or to retry a stopped job, run the following command in a terminal window:
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
To simulate the system force-stopping a job (due to system health or out-of-quota conditions), run the following command in a terminal window:
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

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

منابع اضافی

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

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

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

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

Kotlin

Java

Kotlin

Java

Kotlin

Java

Recommendations

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

Kotlin

Java

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

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

توسط سیستم

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

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

تست کردن

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

منابع اضافی

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