उपयोगकर्ता की ओर से डेटा ट्रांसफ़र करना

如果您需要执行可能需要很长时间的数据传输，可以创建 一个 JobScheduler 作业，并将其标识为用户发起的数据 传输 (UIDT) 作业。UIDT 作业适用于由设备用户发起的持续时间较长的数据传输，例如从远程服务器下载文件。UIDT 作业是在 Android 14（API 级别 34）中引入的。

由用户发起的数据传输作业由用户启动。这些作业需要一个通知，会立即启动，并且可能在系统条件允许的情况下长时间运行。您可以同时运行多个由用户发起的数据传输作业。

必须在应用对用户可见的情况下（或在某个允许的条件下）安排由用户发起的作业。满足所有限制条件后，操作系统可以执行由用户发起的作业，具体取决于系统运行状况限制。系统还可以根据提供的估算载荷大小来确定作业的执行时长。

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क शेड्यूल करना

उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र का टास्क चलाने के लिए, यह तरीका अपनाएं:

1. पक्का करें कि आपके ऐप्लिकेशन ने अपने मेनिफ़ेस्ट में JobService और उससे जुड़ी अनुमतियों के बारे में बताया हो:

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

   इसके अलावा, डेटा ट्रांसफ़र के लिए JobService की कोई ठोस सबक्लास तय करें:

   Kotlin

   class CustomTransferService : JobService() {
     ...
   }

   Java

   class CustomTransferService extends JobService() {
   
       ....
   
   }

2. मेनिफ़ेस्ट में RUN_USER_INITIATED_JOBS अनुमति के बारे में बताएं:

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

3. JobInfo ऑब्जेक्ट बनाते समय, setUserInitiated() तरीके को कॉल करें. (यह तरीका, Android 14 और उसके बाद के वर्शन पर उपलब्ध है.) हमारा सुझाव है कि टास्क बनाते समय, setEstimatedNetworkBytes()को कॉल करके पेलोड के साइज़ का अनुमान दें.

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

4. जब टास्क चल रहा हो, तब setNotification() को JobService ऑब्जेक्ट पर कॉल करें. setNotification() को कॉल करने से, उपयोगकर्ता को पता चलता है कि टास्क चल रहा है. इसकी जानकारी, टास्क मैनेजर और स्टेटस बार के सूचना वाले सेक्शन, दोनों में दिखती है.

   जब टास्क पूरा हो जाए, तो सिस्टम को यह बताने के लिए jobFinished() को कॉल करें कि टास्क पूरा हो गया है या टास्क को फिर से शेड्यूल किया जाना चाहिए.

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

5. उपयोगकर्ता को टास्क की स्थिति और प्रोग्रेस की जानकारी देने के लिए, सूचना को समय-समय पर अपडेट करें. अगर टास्क शेड्यूल करने से पहले, ट्रांसफ़र के साइज़ का पता नहीं लगाया जा सकता या ट्रांसफ़र के अनुमानित साइज़ को अपडेट करना है, तो ट्रांसफ़र का साइज़ पता चलने के बाद उसे अपडेट करने के लिए, नए एपीआई updateEstimatedNetworkBytes() का इस्तेमाल करें.

सुझाव

यूआईडीटी टास्क को असरदार तरीके से चलाने के लिए, यह तरीका अपनाएं:

1. नेटवर्क की पाबंदियों और टास्क के एक्ज़ीक्यूशन की पाबंदियों के बारे में साफ़ तौर पर बताएं, ताकि यह तय किया जा सके कि टास्क कब चलाया जाना चाहिए.

2. onStartJob() में टास्क को एसिंक्रोनस तरीके से चलाएं. उदाहरण के लिए, कोरूटीन का इस्तेमाल करके ऐसा किया जा सकता है. अगर टास्क को एसिंक्रोनस तरीके से नहीं चलाया जाता है, तो टास्क मुख्य थ्रेड पर चलता है और उसे ब्लॉक कर सकता है. इससे ANR की गड़बड़ी हो सकती है.

3. टास्क को ज़रूरत से ज़्यादा समय तक चलने से रोकने के लिए, ट्रांसफ़र पूरा होने पर jobFinished() को कॉल करें. भले ही, ट्रांसफ़र पूरा हुआ हो या नहीं. इससे टास्क, ज़रूरत से ज़्यादा समय तक नहीं चलता. यह जानने के लिए कि कोई टास्क क्यों रोका गया, onStopJob() कॉलबैक तरीके को लागू करें और JobParameters.getStopReason() को कॉल करें.

पिछले वर्शन के गेम खेलने की सुविधा

फ़िलहाल, UIDT जॉब के साथ काम करने वाली कोई Jetpack लाइब्रेरी नहीं है. इसलिए, हमारा सुझाव है कि आप अपने बदलाव को ऐसे कोड से गेट करें जो यह पुष्टि करता हो कि आपका ऐप्लिकेशन Android 14 या इसके बाद के वर्शन पर चल रहा है. 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 जॉब बंद करना

Both the user and the system can stop user-initiated transfer jobs.

उपयोगकर्ता ने टास्क मैनेजर से

उपयोगकर्ता, टास्क मैनेजर में दिखने वाले, उपयोगकर्ता के शुरू किए गए डेटा ट्रांसफ़र जॉब को रोक सकता है.

जब उपयोगकर्ता रोकें बटन दबाता है, तो सिस्टम ये काम करता है:

• आपके ऐप्लिकेशन की प्रोसेस को तुरंत बंद कर देता है. इसमें, चल रही सभी अन्य जॉब या फ़ोरग्राउंड सेवाएं भी शामिल हैं.
• किसी भी चल रही जॉब के लिए onStopJob() को कॉल नहीं करता.
• उपयोगकर्ता को दिखने वाले जॉब को फिर से शेड्यूल होने से रोकता है.

इन वजहों से, हमारा सुझाव है कि जॉब के लिए पोस्ट की गई सूचना में कंट्रोल दें, ताकि जॉब को आसानी से रोका और फिर से शेड्यूल किया जा सके.

ध्यान दें कि कुछ खास मामलों में, टास्क मैनेजर में टास्क के बगल में बंद करें बटन नहीं दिखता. इसके अलावा, ऐसा भी हो सकता है कि टास्क मैनेजर में टास्क न दिखे.

सिस्टम के हिसाब से

与常规作业不同，用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是，如果出现以下任一情况，系统仍会停止作业：

• 不再满足开发者定义的约束条件。
• 系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
• 系统需要优先考虑系统运行状况，并因发热程度上升而停止作业。
• 应用进程因设备内存不足而被终止。

如果系统因设备内存不足以外的原因停止作业，系统会调用 onStopJob()，并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态（即使未调用 onStopJob()），并且您的应用可以在再次调用 onStartJob() 时恢复此状态。

उपयोगकर्ता की ओर से किए जाने वाले डेटा ट्रांसफ़र के टास्क को शेड्यूल करने की अनुमति देने वाली शर्तें

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

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

如果作业安排在未满足必要条件的时间运行，则作业将失败并返回 RESULT_FAILURE 错误代码。

User-Initiated Data Transfer Jobs के लिए अनुमति वाली पाबंदियां

为了支持在最佳时间点运行的作业，Android 提供了为每种作业类型分配约束条件的功能。这些约束条件从 Android 13 开始就已经可用。

注意：下表仅比较了因作业类型而异的约束条件。如需了解所有约束条件，请参阅 JobScheduler 开发者页面或工作约束条件。

下表显示了支持给定作业约束条件的不同作业类型，以及 WorkManager 支持的作业约束条件集。您可以使用表格前的搜索栏按作业约束方法的名称过滤表格。

以下是用户发起的数据传输作业允许使用的约束条件：

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

टेस्ट करना

下面列出了有关如何手动测试应用作业的一些步骤：

• 如需获取作业 ID，请获取在构建作业时定义的值。

• 如需立即运行作业或重试已停止的作业，请在终端窗口中运行以下命令：

  adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID

• 如需模拟系统强行停止作业（由于系统运行状况或超出配额条件），请在终端窗口中运行以下命令：

  adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID

यह भी देखें:

• बैकग्राउंड में होने वाले टास्क के बारे में खास जानकारी
• डेटा ट्रांसफ़र के बैकग्राउंड टास्क के विकल्प

अन्य संसाधन

उपयोगकर्ता के अनुरोध पर होने वाले डेटा ट्रांसफ़र के बारे में ज़्यादा जानने के लिए, यहां दिए गए अतिरिक्त संसाधन देखें:

• यूआईडीटी इंटिग्रेशन पर केस स्टडी: Google Maps ने उपयोगकर्ता की ओर से शुरू किए गए डेटा ट्रांसफ़र एपीआई का इस्तेमाल करके, डाउनलोड की विश्वसनीयता को 10% तक बेहतर बनाया