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

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

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

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

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

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

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

مطمئن شوید که برنامه شما 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() را فراخوانی کنید. (این متد از اندروید ۱۴ به بعد در دسترس است.) همچنین توصیه می‌کنیم هنگام ایجاد job خود، با فراخوانی setEstimatedNetworkBytes() تخمینی از اندازه payload ارائه دهید.

کاتلین

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

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

目前还没有支持 UIDT 作业的 Jetpack 库。因此，我们建议您使用代码来限制更改，以验证您是否在 Android 14 或更高版本上运行。在较低的 Android 版本中，您可以将 WorkManager 的前台服务实现用作回退方法。

以下是检查相应系统版本的代码示例：

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

توسط سیستم

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

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

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

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

只有当应用处于可见窗口中或满足特定条件时，应用才能启动用户发起的数据传输作业：

如果应用可以从后台启动 activity，则也可以从后台启动用户发起的数据传输作业。
如果应用在最近用过屏幕上现有任务的返回堆栈中有 activity，单靠这一点并不允许运行用户发起的数据传输作业。

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 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 درصد بهبود بخشید.

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

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

کاتلین

جاوا

کاتلین

جاوا

کاتلین

جاوا

توصیه‌ها

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

Kotlin

Java

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

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

توسط سیستم

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

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

تست کردن

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

منابع اضافی

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