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

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

If you need to perform a data transfer that may take a long time, you can create a JobScheduler job and identify it as a user-initiated data transfer (UIDT) job. UIDT jobs are intended for longer-duration data transfers that are initiated by the device user, such as downloading a file from a remote server. UIDT jobs were introduced with Android 14 (API level 34).

User-initiated data transfer jobs are started by the user. These jobs require a notification, start immediately, and may be able to run for an extended period of time as system conditions allow. You can run several user-initiated data transfer jobs concurrently.

User initiated jobs must be scheduled while the application is visible to the user (or in one of the allowed conditions). After all constraints are met, user initiated jobs can be executed by the OS, subject to system health restrictions. The system may also use the provided estimated payload size to determine how long the job executes.

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

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

مطمئن شوید که برنامه شما 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)
        // ...
        .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)
    // ...
    .build();

در حالی که کار در حال اجرا است، setNotification() در شیء JobService فراخوانی کنید. فراخوانی setNotification() باعث می شود که کاربر از اجرای کار، هم در Task Manager و هم در ناحیه اعلان نوار وضعیت آگاه شود.

هنگامی که اجرا به پایان رسید، 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() callback را اجرا کنید و JobParameters.getStopReason() را فراخوانی کنید.

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

در حال حاضر هیچ کتابخانه Jetpack وجود ندارد که از کارهای UIDT پشتیبانی کند. به همین دلیل، توصیه می‌کنیم که تغییر خود را با کدی انتخاب کنید که تأیید می‌کند روی اندروید 14 یا بالاتر اجرا می‌کنید. در نسخه‌های پایین‌تر اندروید، می‌توانید از پیاده‌سازی سرویس پیش‌زمینه 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

The user can stop a user-initiated data transfer job that appears in the Task Manager.

At the moment that the user presses Stop, the system does the following:

Terminates your app's process immediately, including all other jobs or foreground services running.
Doesn't call onStopJob() for any running jobs.
Prevents user-visible jobs from being rescheduled.

For these reasons, it's recommended to provide controls in the notification posted for the job to allow gracefully stopping and rescheduling the job.

Note that, under special circumstances, the Stop button doesn't appear next to the job in the Task Manager, or the job isn't shown in the Task Manager at all.

توسط سیستم

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

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

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

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

Apps can only start a user-initiated data transfer job if the app is in the visible window, or if certain conditions are met:

If an app can launch activities from the background, it can also launch user-initiated data transfer jobs from the background.
If an app has an activity in the back stack of an existing task on the Recents screen, that alone doesn't allow a user-initiated data transfer job to run.

If the job is scheduled to run at a time when the necessary conditions are not met, the job fails and returns a RESULT_FAILURE error code.

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

To support jobs running at optimal points, Android offers the ability to assign constraints to each job type. These constraints are available as of Android 13.

Note: The following table only compares the constraints that vary between each job type. See JobScheduler developer page or work constraints for all constraints.

The following table shows the different job types that support a given job constraint, as well as the set of job constraints that WorkManager supports. Use the search bar before the table to filter the table by the name of a job constraint method.

These are the constraints allowed with user-initiated data transfer jobs:

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 درصد بهبود بخشید.

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

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

کاتلین

جاوا

کاتلین

جاوا

کاتلین

جاوا

توصیه ها

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

کاتلین

جاوا

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

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

توسط سیستم

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

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

تست کردن

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

منابع اضافی

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