feat:增加OSS断点下载功能

.gitignore

@@ -28,3 +28,11 @@ migrate_working_dir/
 .dart_tool/
 .packages
 build/
+
+# FVM Version Cache
+.fvm/
+.fvmrc
+.vscode/settings.json
+/android/gradle/wrapper
+android/gradlew
+android/gradlew.bat

android/build.gradle

@@ -25,7 +25,7 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 31
+    compileSdkVersion 34
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
@@ -48,6 +48,7 @@ android {
     dependencies {
         testImplementation 'org.jetbrains.kotlin:kotlin-test'
         testImplementation 'org.mockito:mockito-core:5.0.0'
+        implementation 'com.aliyun.dpa:oss-android-sdk:2.9.19'
     }
 
     testOptions {

android/src/main/kotlin/com/clx/apk_update/ApkUpdatePlugin.kt

 package com.clx.apk_update
 
+import android.app.Activity
 import android.content.Context
 import android.content.Intent
 import android.util.Log
 import androidx.annotation.NonNull
+import com.clx.apk_update.DownloadAppUtil.aliDownload
 
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
 import io.flutter.plugin.common.MethodChannel.MethodCallHandler
-import io.flutter.plugin.common.MethodChannel.Result
+import io.flutter.embedding.engine.plugins.activity.ActivityAware
+import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
+import io.flutter.plugin.common.EventChannel
 import java.io.File
 
 /** ApkUpdatePlugin */
-class ApkUpdatePlugin : FlutterPlugin, MethodCallHandler {
+class ApkUpdatePlugin : FlutterPlugin, MethodCallHandler, EventChannel.StreamHandler,
+    ProgressCallback, ActivityAware {
     /// The MethodChannel that will the communication between Flutter and native Android
     ///
     /// This local reference serves to register the plugin with the Flutter Engine and unregister it
     /// when the Flutter Engine is detached from the Activity
     private lateinit var channel: MethodChannel
+    private lateinit var eventChannel: EventChannel
     private val tag = "ApkUpdatePlugin"
     private lateinit var mContext: Context
+    private var lastTime = 0L
+    private var mEventSink: EventChannel.EventSink? = null
+    private var mActivity: Activity? = null
 
     override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
         mContext = flutterPluginBinding.applicationContext
         channel = MethodChannel(flutterPluginBinding.binaryMessenger, "apk_update")
+        eventChannel = EventChannel(flutterPluginBinding.binaryMessenger, "download_install_event")
         channel.setMethodCallHandler(this)
+        eventChannel.setStreamHandler(this)
     }
 
-    override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
+    override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: MethodChannel.Result) {
         Log.d(tag, "onMethodCall: method = ${call.method} arguments = ${call.arguments}")
-        if (call.method == "installApk") {
-            val path = call.argument<String?>("path")
-            if (path == null || path == "") {
-                Log.d(tag, "onMethodCall: path is null")
-                result.error("error", "path is null", null)
-                return
+        when (call.method) {
+            "installApk" -> {
+                val path = call.argument<String?>("path")
+                if (path == null || path == "") {
+                    Log.d(tag, "onMethodCall: path is null")
+                    result.error("error", "path is null", null)
+                    return
+                }
+                openFile(path)
+            }
+
+            "downloadInstall" -> {
+                val data = call.arguments<Map<String, String>>()
+                val ak = data?.get("ak")
+                val sk = data?.get("sk")
+                val token = data?.get("token")
+                val endpoint = data?.get("endpoint")
+                val bucketName = data?.get("bucketName")
+                val objectKey = data?.get("objectKey")
+                val localPath = data?.get("localPath")
+                if (ak == null || sk == null || token == null || endpoint == null || bucketName == null || objectKey == null || localPath == null) {
+                    result.error("error", "data is null", null)
+                    return
+                }
+                Log.d(
+                    "InstallAPKPlugin",
+                    "setupMethodChannel: $ak $sk $token $endpoint $bucketName $objectKey $localPath"
+                )
+                aliDownload(
+                    mContext,
+                    ak,
+                    sk,
+                    token,
+                    endpoint,
+                    bucketName,
+                    objectKey,
+                    localPath,
+                    this
+                )
+
+            }
+
+            else -> {
+                result.notImplemented()
             }
-            openFile(path)
-        } else {
-            result.notImplemented()
         }
     }
 
+    override fun onListen(arguments: Any?, events: EventChannel.EventSink?) {
+        mEventSink = events
+    }
+
+    override fun onCancel(arguments: Any?) {
+        Log.d("InstallAPKPlugin", "onCancel: ")
+    }
+
     /**
      * 安装 文件（APK）
      */
@@ -59,4 +113,51 @@ class ApkUpdatePlugin : FlutterPlugin, MethodCallHandler {
     override fun onDetachedFromEngine(@NonNull binding: FlutterPlugin.FlutterPluginBinding) {
         channel.setMethodCallHandler(null)
     }
+
+    override fun onProgress(currentSize: Long, totalSize: Long) {
+
+        // 主线程发送 event 每1s 发一次
+        val time = System.currentTimeMillis()
+        if (time - lastTime < 1000) {
+            return
+        }
+        lastTime = time
+        mActivity?.runOnUiThread {
+            mEventSink?.success(
+                mapOf(
+                    "currentSize" to currentSize,
+                    "totalSize" to totalSize
+                )
+            )
+
+        }
+
+    }
+
+    override fun success(path: String) {
+        mActivity?.runOnUiThread {
+            mEventSink?.success(
+                mapOf(
+                    "currentSize" to 1,
+                    "totalSize" to 1,
+                    "isDownloadSuccess" to "1"
+                )
+            )
+
+        }
+        openFile(path)
+    }
+
+    override fun onAttachedToActivity(binding: ActivityPluginBinding) {
+        mActivity = binding.activity
+    }
+
+    override fun onDetachedFromActivityForConfigChanges() {
+    }
+
+    override fun onReattachedToActivityForConfigChanges(binding: ActivityPluginBinding) {
+    }
+
+    override fun onDetachedFromActivity() {
+    }
 }

android/src/main/kotlin/com/clx/apk_update/DownloadApp.kt

+package com.clx.apk_update
+
+import android.content.Context
+import android.util.Log
+import com.alibaba.sdk.android.oss.ClientException
+import com.alibaba.sdk.android.oss.OSSClient
+import com.alibaba.sdk.android.oss.ServiceException
+import com.alibaba.sdk.android.oss.callback.OSSCompletedCallback
+import com.alibaba.sdk.android.oss.callback.OSSProgressCallback
+import com.alibaba.sdk.android.oss.common.auth.OSSCredentialProvider
+import com.alibaba.sdk.android.oss.common.auth.OSSStsTokenCredentialProvider
+import com.alibaba.sdk.android.oss.internal.OSSAsyncTask
+import com.alibaba.sdk.android.oss.model.ResumableDownloadRequest
+import com.alibaba.sdk.android.oss.model.ResumableDownloadResult
+
+
+object DownloadAppUtil {
+
+    const val TAG = "DownloadAppUtil"
+
+    fun aliDownload(
+        context: Context,
+        ak: String,
+        sk: String,
+        token: String,
+        endpoint: String,
+        bucketName: String,
+        objectKey: String,
+        localPath: String,
+        progressCallback: ProgressCallback
+    ) {
+
+        val credentialProvider: OSSCredentialProvider = OSSStsTokenCredentialProvider(ak, sk, token)
+        val oss = OSSClient(context, endpoint, credentialProvider)
+
+
+        // 填写下载到本地文件所在的完整路径。
+        val localFile = "$localPath/$objectKey"
+        Log.d(TAG, "aliDownload: localFile = $localFile")
+        val request = ResumableDownloadRequest(bucketName, objectKey, localFile)
+
+        // 开启断点续传下载功能。
+        request.enableCheckPoint = true
+        request.checkPointFilePath = localPath
+        request.progressListener =
+            OSSProgressCallback<Any?> { _, currentSize, totalSize ->
+                Log.d(TAG, "aliDownload: currentSize = $currentSize totalSize = $totalSize")
+                progressCallback.onProgress(currentSize, totalSize)
+
+            }
+
+        val task: OSSAsyncTask<ResumableDownloadResult> = oss.asyncResumableDownload(
+            request,
+            object : OSSCompletedCallback<ResumableDownloadRequest?, ResumableDownloadResult?> {
+                override fun onSuccess(
+                    request: ResumableDownloadRequest?,
+                    result: ResumableDownloadResult?
+                ) {
+                    Log.d(TAG, "onSuccess: $localFile")
+                    progressCallback.success(localFile)
+                }
+
+                override fun onFailure(
+                    request: ResumableDownloadRequest?,
+                    clientException: ClientException?,
+                    serviceException: ServiceException?
+                ) {
+                    // 请求异常。
+                    clientException?.printStackTrace()
+                    if (serviceException != null) {
+                        // 服务端异常。
+                        Log.e("ErrorCode", serviceException.errorCode)
+                        Log.e("RequestId", serviceException.requestId)
+                        Log.e("HostId", serviceException.hostId)
+                        Log.e("RawMessage", serviceException.rawMessage)
+                    }
+                }
+            })
+
+
+        Log.d(TAG, "aliDownload: task.isCompleted = ${task.isCompleted}")
+
+
+    }
+
+
+}
\ No newline at end of file

android/src/main/kotlin/com/clx/apk_update/ProgressCallback.kt

+package com.clx.apk_update
+
+interface ProgressCallback {
+
+    fun onProgress(currentSize: Long, totalSize: Long)
+
+    fun  success(path:String)
+
+}
\ No newline at end of file

example/android/app/build.gradle

@@ -27,7 +27,7 @@ apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
     namespace "com.clx.apk_update_example"
-    compileSdkVersion flutter.compileSdkVersion
+    compileSdkVersion 34
     ndkVersion flutter.ndkVersion
 
     compileOptions {
@@ -49,7 +49,7 @@ android {
         // You can update the following values to match your application needs.
         // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
         minSdkVersion flutter.minSdkVersion
-        targetSdkVersion flutter.targetSdkVersion
+        targetSdkVersion 31
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

example/lib/main.dart

@@ -36,15 +36,23 @@ class _MyAppState extends State<MyApp> {
             ),
             TextButton(
               onPressed: () {
+                var map = {
+                  'token': "20502a804a784bc1a21681e26aa14cb8",
+                  'objectKey': 'msl.apk',
+                  'bucketName': 'mslapp-download',
+                  'endpoint': 'oss-cn-beijing.aliyuncs.com',
+                  "baseUrl":"https://gateway.testclx.cn"
+                };
                 ApkUpdate().updateApp(
                     url:
-                    "https://gateway.devclx.cn/clx-user/app/version/getSystemVersionByNumber",
+                        "https://gateway.devclx.cn/clx-user/app/version/getSystemVersionByNumber",
                     params: {
                       "versionNumber": 1,
                       "productNo": 1,
                       "productCode": "carrier-driver-app",
                     },
                     onceDay: false,
+                    paramsOSS: map,
                     appleId: "1585610919");
               },
               child: const Text('升级应用(新)'),

lib/apk_update.dart

 import 'package:apk_update/utils/utils.dart';
+import 'package:dio/dio.dart';
 import 'package:flutter/material.dart';
-
 import 'apk_update_platform_interface.dart';
 
 class ApkUpdate {
@@ -16,6 +16,7 @@ class ApkUpdate {
     required String baseUrl,
     required int versionNumber,
     required int productNo,
+    Map<String, dynamic>? paramsOSS,
     bool onceDay = false,
     required String appleId,
     Function()? downloadApkError, // 下载Apk错误
@@ -25,6 +26,7 @@ class ApkUpdate {
       url: "$baseUrl$getSystemVersionByNumber",
       method: Method.get,
       params: {"versionNumber": versionNumber, "productNo": productNo},
+      isOssDownload: paramsOSS != null ? 1 : 0,
       onceDay: onceDay,
       jumpAppStore: () {
         // 跳转AppStore
@@ -49,17 +51,20 @@ class ApkUpdate {
   /// url 全路径
   /// appleId 苹果应用id
   /// params {"versionNumber": 1, "product-code": "carrier-driver-app"}
+  /// paramsOSS {"ak": "ak", "sk": "sk", "token": "token", "objectKey": "objectKey", "endpoint": "endpoint", "bucketName": "bucketName", }
   void updateApp({
     required String url,
     required Map<String, dynamic> params,
     bool onceDay = false,
     required String appleId,
+    Map<String, dynamic>? paramsOSS,
     Function()? downloadApkError, // 下载Apk错误
   }) {
     checkVersion(
       url: url,
       method: Method.post,
       params: params,
+      isOssDownload: paramsOSS != null ? 1 : 0,
       header: {"product-code": params["productCode"]},
       onceDay: onceDay,
       jumpAppStore: () {
@@ -72,6 +77,42 @@ class ApkUpdate {
         debugPrint("===== installApk");
         ApkUpdatePlatform.instance.installApk(path);
       },
+      downloadApk: (String? path) {
+        final dio = Dio();
+        dio
+            .get("${paramsOSS?['baseUrl']}$generateByExt",
+                queryParameters: {
+                  "extension": "apk",
+                  "bucketName": paramsOSS?["bucketName"]
+                },
+                options: Options(headers: {
+                  "token": paramsOSS?['token'],
+                  "product-code": params["productCode"]
+                }))
+            .then((res) {
+          if (res.data == null || res.data['code'] != 0) {
+            debugPrint('获取OSS授权失败');
+            downloadApkError?.call();
+            return;
+          }
+          var map = res.data['data'];
+          // 使用OSS下载
+          var ak = map?['onceAccessKeyId'];
+          var sk = map?["onceAccessKeySecret"];
+          var token = map?["onceSecurityToken"];
+          var objectKey = paramsOSS?["objectKey"];
+          var endpoint = paramsOSS?["endpoint"];
+          var bucketName = paramsOSS?["bucketName"];
+          var localPath = path;
+          if (localPath == null) {
+            // 项目中没有依赖toast，自己项目中实现
+            downloadApkError?.call();
+            return;
+          }
+          ApkUpdatePlatform.instance.downloadApk(
+              ak, sk, token, objectKey, endpoint, bucketName, localPath);
+        });
+      },
       downloadApkError: () {
         // 下载Apk错误
         debugPrint("===== downloadApkError");

lib/apk_update_method_channel.dart

@@ -9,6 +9,9 @@ class MethodChannelApkUpdate extends ApkUpdatePlatform {
   @visibleForTesting
   final methodChannel = const MethodChannel('apk_update');
 
+  @visibleForTesting
+  final eventChannel = const EventChannel('download_install_event');
+
   @override
   void jumpAppStore(String appleId) async {
     methodChannel.invokeMethod<String>('jumpAppStore', {"appleId": appleId});
@@ -18,4 +21,26 @@ class MethodChannelApkUpdate extends ApkUpdatePlatform {
   void installApk(String? path) {
     methodChannel.invokeMethod<String>('installApk', {"path": path});
   }
+
+  @override
+  void downloadApk(String ak, String sk, String token, String objectKey,
+      String endpoint, String bucketName, String localPath) {
+    methodChannel.invokeMethod<String>('downloadInstall', {
+      "ak": ak,
+      "sk": sk,
+      "token": token,
+      "objectKey": objectKey,
+      "endpoint": endpoint,
+      "bucketName": bucketName,
+      "localPath": localPath
+    });
+  }
+
+  @override
+  Stream<Map<String, Object>> addDownloadListener() {
+    return eventChannel
+        .receiveBroadcastStream()
+        .asBroadcastStream()
+        .map<Map<String, Object>>((element) => element.cast<String, Object>());
+  }
 }

lib/apk_update_platform_interface.dart

@@ -31,4 +31,14 @@ abstract class ApkUpdatePlatform extends PlatformInterface {
     throw UnimplementedError('installApk() has not been implemented.');
   }
 
+  //支持断点下载并安装
+  void downloadApk(String ak, String sk, String token, String objectKey,
+      String endpoint, String bucketName, String localPath) {
+    throw UnimplementedError('downloadApk() has not been implemented.');
+  }
+
+  // 添加下载进度监听
+  Stream<Map<String, Object>> addDownloadListener() {
+    throw UnimplementedError('addDownloadListener() has not been implemented.');
+  }
 }

lib/utils/utils.dart

@@ -11,6 +11,8 @@ import 'package:url_launcher/url_launcher.dart';
 // 获取版本号
 const String getSystemVersionByNumber =
     "/user-service/system/version/getSystemVersionByNumber";
+// 获取OSS 下载授权ak sk token
+const String generateByExt = "/msl-document/common/oss/generateByExt";
 const currentDay = "current_day";
 const dateFormat = "yyyy-MM-dd";
 
@@ -19,16 +21,18 @@ const dateFormat = "yyyy-MM-dd";
 /// versionNumber 当前应用versionCode
 /// productNo 产品号
 /// onceDay 一天提示一次(应用首页设置true)
-void checkVersion({
-  required String url,
-  required Method method,
-  Map<String, dynamic>? params,
-  Map<String, dynamic>? header,
-  bool onceDay = false,
-  Function()? jumpAppStore, // 跳转AppStore
-  Function(String? path)? installApk, // 安装Apk
-  Function()? downloadApkError, // 下载Apk错误
-}) async {
+void checkVersion(
+    {required String url,
+    required Method method,
+    Map<String, dynamic>? params,
+    Map<String, dynamic>? header,
+    bool onceDay = false,
+    Function()? jumpAppStore, // 跳转AppStore
+    Function(String? path)? installApk, // 安装Apk
+    Function()? downloadApkError, // 下载Apk错误
+    Function(String? path)? downloadApk, // 使用OSS下载Apk
+    int? isOssDownload //1 使用OSS下载
+    }) async {
   try {
     final Response response = await Dio().request(
       url,
@@ -77,6 +81,8 @@ void checkVersion({
         versionPath: result['versionPath'],
         jumpAppStore: jumpAppStore,
         installApk: installApk,
+        isOssDownload: isOssDownload,
+        downloadApk: downloadApk,
         downloadApkError: downloadApkError,
       ),
     );

lib/widget/update_dialog.dart

+import 'dart:async';
 import 'dart:io';
 
 import 'package:apk_update/utils/image_utils.dart';
@@ -7,6 +8,8 @@ import 'package:flustars_flutter3/flustars_flutter3.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_widget_from_html_core/flutter_widget_from_html_core.dart';
 
+import '../apk_update_platform_interface.dart';
+
 class UpdateDialog extends StatefulWidget {
   final String? title; // 升级版本
   final String? content; // 升级内容
@@ -14,6 +17,8 @@ class UpdateDialog extends StatefulWidget {
   final String? versionPath; // apk 路径
   final Function()? jumpAppStore; // 跳转AppStore
   final Function(String? path)? installApk; // 安装Apk
+  final int? isOssDownload; //1 使用OSS下载
+  final Function(String? path)? downloadApk; // 使用OSS下载Apk
   final Function()? downloadApkError; // 下载Apk错误
 
   const UpdateDialog({
@@ -24,7 +29,9 @@ class UpdateDialog extends StatefulWidget {
     this.versionPath,
     this.jumpAppStore,
     this.installApk,
+    this.downloadApk,
     this.downloadApkError,
+    this.isOssDownload,
   }) : super(key: key);
 
   @override
@@ -33,6 +40,7 @@ class UpdateDialog extends StatefulWidget {
 
 class _UpdateDialogState extends State<UpdateDialog> {
   final CancelToken _cancelToken = CancelToken();
+  StreamSubscription<Map<String, Object>>? _subscription;
   bool _isDownload = false;
   double _value = 0;
 
@@ -41,6 +49,7 @@ class _UpdateDialogState extends State<UpdateDialog> {
     if (!_cancelToken.isCancelled && _value != 1) {
       _cancelToken.cancel();
     }
+    _subscription?.cancel();
     super.dispose();
   }
 
@@ -198,6 +207,27 @@ class _UpdateDialogState extends State<UpdateDialog> {
   ///下载apk
   Future<void> _download() async {
     try {
+      // 2024-11-21 使用OSSSDK下载
+      if (widget.isOssDownload == 1) {
+        setInitDir(initStorageDir: true);
+        await DirectoryUtil.getInstance();
+        DirectoryUtil.createStorageDirSync(category: 'Download');
+        String? path = DirectoryUtil.getStoragePath(category: 'Download');
+        _subscription =
+            ApkUpdatePlatform.instance.addDownloadListener().listen((event) {
+          var count = event['currentSize'] as num;
+          var total = event['totalSize'] as num;
+          var isDownloadSuccess = event['isDownloadSuccess'] == "1";
+          _value = count / total;
+          if (isDownloadSuccess) {
+            _isDownload = false;
+          }
+          setState(() {});
+        });
+
+        widget.downloadApk?.call(path);
+        return;
+      }
       setInitDir(initStorageDir: true);
       await DirectoryUtil.getInstance();
       DirectoryUtil.createStorageDirSync(category: 'Download');