⚡️ Improve selection callers between picker and viewer (#327)

AlexV525 · web-flow · commit 339ac927a6aa · 2022-06-03T11:33:23.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ that can be found in the LICENSE file. -->
 
 # Changelog
 
+## 7.3.1
+
+### Improvements
+
+- Improve selection callers between picker and viewer. (#327)
+
 ## 7.3.0
 
 Migrate to Flutter 3, drop supports for previous Flutter versions.
diff --git a/example/lib/constants/page_mixin.dart b/example/lib/constants/page_mixin.dart
@@ -39,7 +39,7 @@ mixin ExamplePageMixin<T extends StatefulWidget> on State<T> {
   Future<void> selectAssets(PickMethod model) async {
     final List<AssetEntity>? result = await model.method(context, assets);
     if (result != null) {
-      assets = List<AssetEntity>.from(result);
+      assets = result.toList();
       if (mounted) {
         setState(() {});
       }
@@ -56,7 +56,7 @@ mixin ExamplePageMixin<T extends StatefulWidget> on State<T> {
 
   void onResult(List<AssetEntity>? result) {
     if (result != null && result != assets) {
-      assets = List<AssetEntity>.from(result);
+      assets = result.toList();
       if (mounted) {
         setState(() {});
       }
diff --git a/example/lib/customs/pickers/directory_file_asset_picker.dart b/example/lib/customs/pickers/directory_file_asset_picker.dart
@@ -343,7 +343,7 @@ class FileAssetPickerProvider extends AssetPickerProvider<File, Directory> {
 
   @override
   void unSelectAsset(File item) {
-    final List<File> set = List<File>.from(selectedAssets);
+    final List<File> set = selectedAssets.toList();
     set.removeWhere((File f) => f.path == item.path);
     selectedAssets = set;
   }
@@ -1185,10 +1185,10 @@ class FileAssetPickerViewerProvider extends AssetPickerViewerProvider<File> {
   FileAssetPickerViewerProvider(List<File> super.assets);
 
   @override
-  void unSelectAssetEntity(File entity) {
-    final List<File> set = List<File>.from(currentlySelectedAssets);
-    set.removeWhere((File f) => f.path == entity.path);
-    currentlySelectedAssets = List<File>.from(set);
+  void unSelectAsset(File item) {
+    final List<File> list = currentlySelectedAssets.toList()
+      ..removeWhere((File f) => f.path == item.path);
+    currentlySelectedAssets = list;
   }
 }
 
@@ -1388,34 +1388,31 @@ class FileAssetPickerViewerBuilderDelegate
 
   @override
   Widget build(BuildContext context) {
-    return WillPopScope(
-      onWillPop: syncSelectedAssetsWhenPop,
-      child: Theme(
-        data: themeData,
-        child: AnnotatedRegion<SystemUiOverlayStyle>(
-          value: themeData.brightness == Brightness.dark
-              ? SystemUiOverlayStyle.light
-              : SystemUiOverlayStyle.dark,
-          child: Material(
-            color: Colors.black,
-            child: Stack(
-              children: <Widget>[
-                Positioned.fill(
-                  child: PageView.builder(
-                    physics: const BouncingScrollPhysics(),
-                    controller: _pageController,
-                    itemCount: previewAssets.length,
-                    itemBuilder: assetPageBuilder,
-                    onPageChanged: (int index) {
-                      currentIndex = index;
-                      pageStreamController.add(index);
-                    },
-                  ),
+    return Theme(
+      data: themeData,
+      child: AnnotatedRegion<SystemUiOverlayStyle>(
+        value: themeData.brightness == Brightness.dark
+            ? SystemUiOverlayStyle.light
+            : SystemUiOverlayStyle.dark,
+        child: Material(
+          color: Colors.black,
+          child: Stack(
+            children: <Widget>[
+              Positioned.fill(
+                child: PageView.builder(
+                  physics: const BouncingScrollPhysics(),
+                  controller: _pageController,
+                  itemCount: previewAssets.length,
+                  itemBuilder: assetPageBuilder,
+                  onPageChanged: (int index) {
+                    currentIndex = index;
+                    pageStreamController.add(index);
+                  },
                 ),
-                appBar(context),
-                if (selectedAssets != null) bottomDetailBuilder(context),
-              ],
-            ),
+              ),
+              appBar(context),
+              if (selectedAssets != null) bottomDetailBuilder(context),
+            ],
           ),
         ),
       ),
@@ -1521,9 +1518,9 @@ class FileAssetPickerViewerBuilderDelegate
         behavior: HitTestBehavior.opaque,
         onTap: () {
           if (isSelected) {
-            provider?.unSelectAssetEntity(asset);
+            provider?.unSelectAsset(asset);
           } else {
-            provider?.selectAssetEntity(asset);
+            provider?.selectAsset(asset);
           }
         },
         child: AnimatedContainer(
@@ -1557,9 +1554,11 @@ class FileAssetPickerViewerBuilderDelegate
       value: isSelected,
       onChanged: (bool? value) {
         if (isSelected) {
-          provider?.unSelectAssetEntity(asset);
+          provider?.unSelectAsset(asset);
+          selectorProvider?.unSelectAsset(asset);
         } else {
-          provider?.selectAssetEntity(asset);
+          provider?.selectAsset(asset);
+          selectorProvider?.selectAsset(asset);
         }
       },
       materialTapTargetSize: MaterialTapTargetSize.shrinkWrap,
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -1,6 +1,6 @@
 name: wechat_assets_picker_demo
 description: The demo project for the wechat_assets_picker package.
-version: 7.3.0+17
+version: 7.3.1+18
 publish_to: none
 
 environment:
diff --git a/lib/src/constants/config.dart b/lib/src/constants/config.dart
@@ -14,8 +14,8 @@ import 'enums.dart';
 class AssetPickerConfig {
   const AssetPickerConfig({
     this.selectedAssets,
-    this.maxAssets = 9,
-    this.pageSize = 80,
+    this.maxAssets = defaultMaxAssetsCount,
+    this.pageSize = defaultAssetsPerPage,
     this.gridThumbnailSize = defaultAssetGridPreviewSize,
     this.pathThumbnailSize = defaultPathThumbnailSize,
     this.previewThumbnailSize,
diff --git a/lib/src/constants/constants.dart b/lib/src/constants/constants.dart
@@ -5,6 +5,9 @@
 import 'package:flutter/painting.dart';
 import 'package:photo_manager/photo_manager.dart';
 
+const int defaultAssetsPerPage = 80;
+const int defaultMaxAssetsCount = 9;
+
 /// Default theme color from WeChat.
 const Color defaultThemeColorWeChat = Color(0xff00bc56);
 
diff --git a/lib/src/delegates/asset_picker_viewer_builder_delegate.dart b/lib/src/delegates/asset_picker_viewer_builder_delegate.dart
@@ -235,7 +235,8 @@ abstract class AssetPickerViewerBuilderDelegate<Asset, Path> {
       ValueNotifier<int>(selectedCount);
 
   void unSelectAsset(Asset entity) {
-    provider?.unSelectAssetEntity(entity);
+    provider?.unSelectAsset(entity);
+    selectorProvider?.unSelectAsset(entity);
     if (!isSelectedPreviewing) {
       selectedAssets?.remove(entity);
     }
@@ -248,7 +249,8 @@ abstract class AssetPickerViewerBuilderDelegate<Asset, Path> {
     if (maxAssets != null && selectedCount >= maxAssets!) {
       return;
     }
-    provider?.selectAssetEntity(entity);
+    provider?.selectAsset(entity);
+    selectorProvider?.selectAsset(entity);
     if (!isSelectedPreviewing) {
       selectedAssets?.add(entity);
     }
@@ -285,6 +287,7 @@ abstract class AssetPickerViewerBuilderDelegate<Asset, Path> {
 
   /// Sync selected assets currently with asset picker provider.
   /// 在预览中当前已选的图片同步到选择器的状态
+  @Deprecated('The method is not used by the package anymore')
   Future<bool> syncSelectedAssetsWhenPop() async {
     if (provider?.currentlySelectedAssets != null) {
       selectorProvider?.selectedAssets = provider!.currentlySelectedAssets;
@@ -971,35 +974,32 @@ class DefaultAssetPickerViewerBuilderDelegate
 
   @override
   Widget build(BuildContext context) {
-    return WillPopScope(
-      onWillPop: syncSelectedAssetsWhenPop,
-      child: Theme(
-        data: themeData,
-        child: AnnotatedRegion<SystemUiOverlayStyle>(
-          value: themeData.appBarTheme.systemOverlayStyle ??
-              (themeData.effectiveBrightness.isDark
-                  ? SystemUiOverlayStyle.light
-                  : SystemUiOverlayStyle.dark),
-          child: Material(
-            color: themeData.colorScheme.onSecondary,
-            child: Stack(
-              children: <Widget>[
-                Positioned.fill(child: _pageViewBuilder(context)),
-                if (isWeChatMoment && hasVideo) ...<Widget>[
-                  momentVideoBackButton(context),
-                  PositionedDirectional(
-                    end: 16,
-                    bottom: context.bottomPadding + 16,
-                    child: confirmButton(context),
-                  ),
-                ] else ...<Widget>[
-                  appBar(context),
-                  if (selectedAssets != null ||
-                      (isWeChatMoment && hasVideo && isAppleOS))
-                    bottomDetailBuilder(context),
-                ],
+    return Theme(
+      data: themeData,
+      child: AnnotatedRegion<SystemUiOverlayStyle>(
+        value: themeData.appBarTheme.systemOverlayStyle ??
+            (themeData.effectiveBrightness.isDark
+                ? SystemUiOverlayStyle.light
+                : SystemUiOverlayStyle.dark),
+        child: Material(
+          color: themeData.colorScheme.onSecondary,
+          child: Stack(
+            children: <Widget>[
+              Positioned.fill(child: _pageViewBuilder(context)),
+              if (isWeChatMoment && hasVideo) ...<Widget>[
+                momentVideoBackButton(context),
+                PositionedDirectional(
+                  end: 16,
+                  bottom: context.bottomPadding + 16,
+                  child: confirmButton(context),
+                ),
+              ] else ...<Widget>[
+                appBar(context),
+                if (selectedAssets != null ||
+                    (isWeChatMoment && hasVideo && isAppleOS))
+                  bottomDetailBuilder(context),
               ],
-            ),
+            ],
           ),
         ),
       ),
diff --git a/lib/src/provider/asset_picker_provider.dart b/lib/src/provider/asset_picker_provider.dart
@@ -21,13 +21,13 @@ import '../internal/singleton.dart';
 /// and how to get the thumbnail data of a path.
 abstract class AssetPickerProvider<Asset, Path> extends ChangeNotifier {
   AssetPickerProvider({
-    this.maxAssets = 9,
-    this.pageSize = 320,
+    this.maxAssets = defaultMaxAssetsCount,
+    this.pageSize = defaultAssetsPerPage,
     this.pathThumbnailSize = defaultPathThumbnailSize,
     List<Asset>? selectedAssets,
   }) {
-    if (selectedAssets?.isNotEmpty ?? false) {
-      _selectedAssets = List<Asset>.from(selectedAssets!);
+    if (selectedAssets != null && selectedAssets.isNotEmpty) {
+      _selectedAssets = selectedAssets.toList();
     }
   }
 
@@ -172,7 +172,7 @@ abstract class AssetPickerProvider<Asset, Path> extends ChangeNotifier {
     if (value == _currentAssets) {
       return;
     }
-    _currentAssets = List<Asset>.from(value);
+    _currentAssets = value.toList();
     notifyListeners();
   }
 
@@ -185,7 +185,7 @@ abstract class AssetPickerProvider<Asset, Path> extends ChangeNotifier {
     if (value == _selectedAssets) {
       return;
     }
-    _selectedAssets = List<Asset>.from(value);
+    _selectedAssets = value.toList();
     notifyListeners();
   }
 
@@ -212,15 +212,15 @@ abstract class AssetPickerProvider<Asset, Path> extends ChangeNotifier {
     if (selectedAssets.length == maxAssets || selectedAssets.contains(item)) {
       return;
     }
-    final List<Asset> set = List<Asset>.from(selectedAssets);
+    final List<Asset> set = selectedAssets.toList();
     set.add(item);
     selectedAssets = set;
   }
 
   /// Un-select asset.
   /// 取消选中资源
   void unSelectAsset(Asset item) {
-    final List<Asset> set = List<Asset>.from(selectedAssets);
+    final List<Asset> set = selectedAssets.toList();
     set.remove(item);
     selectedAssets = set;
   }
@@ -344,7 +344,7 @@ class DefaultAssetPickerProvider
       page: page,
       size: pageSize,
     );
-    _currentAssets = List<AssetEntity>.of(list);
+    _currentAssets = list.toList();
     _hasAssetsToDisplay = currentAssets.isNotEmpty;
     notifyListeners();
   }
@@ -355,7 +355,7 @@ class DefaultAssetPickerProvider
       page: currentAssetsListPage,
       size: pageSize,
     );
-    final List<AssetEntity> assets = List<AssetEntity>.of(list);
+    final List<AssetEntity> assets = list.toList();
     if (assets.isNotEmpty && currentAssets.contains(assets[0])) {
       return;
     }
diff --git a/lib/src/provider/asset_picker_viewer_provider.dart b/lib/src/provider/asset_picker_viewer_provider.dart
@@ -2,17 +2,26 @@
 // Use of this source code is governed by an Apache license that can be found
 // in the LICENSE file.
 
-import 'package:flutter/material.dart';
+import 'package:flutter/widgets.dart';
+
+import '../constants/constants.dart';
 
 /// [ChangeNotifier] for assets picker viewer.
 /// 资源选择查看器的 provider model.
 class AssetPickerViewerProvider<A> extends ChangeNotifier {
   /// Copy selected assets for editing when constructing.
   /// 构造时深拷贝已选择的资源集合，用于后续编辑。
-  AssetPickerViewerProvider(List<A>? assets) {
-    _currentlySelectedAssets = List<A>.from(assets ?? <A>[]);
+  AssetPickerViewerProvider(
+    List<A>? assets, {
+    this.maxAssets = defaultMaxAssetsCount,
+  }) {
+    _currentlySelectedAssets = (assets ?? <A>[]).toList();
   }
 
+  /// Maximum count for asset selection.
+  /// 资源选择的最大数量
+  final int maxAssets;
+
   /// Selected assets in the viewer.
   /// 查看器中已选择的资源
   late List<A> _currentlySelectedAssets;
@@ -32,17 +41,29 @@ class AssetPickerViewerProvider<A> extends ChangeNotifier {
 
   /// Select asset.
   /// 选中资源
-  void selectAssetEntity(A entity) {
-    final List<A> set = List<A>.from(currentlySelectedAssets);
-    set.add(entity);
-    currentlySelectedAssets = List<A>.from(set);
+  void selectAsset(A item) {
+    if (currentlySelectedAssets.length == maxAssets ||
+        currentlySelectedAssets.contains(item)) {
+      return;
+    }
+    final List<A> newList = _currentlySelectedAssets.toList()..add(item);
+    currentlySelectedAssets = newList;
   }
 
   /// Un-select asset.
   /// 取消选中资源
-  void unSelectAssetEntity(A entity) {
-    final List<A> set = List<A>.from(currentlySelectedAssets);
-    set.remove(entity);
-    currentlySelectedAssets = List<A>.from(set);
+  void unSelectAsset(A item) {
+    if (currentlySelectedAssets.isEmpty ||
+        !currentlySelectedAssets.contains(item)) {
+      return;
+    }
+    final List<A> newList = _currentlySelectedAssets.toList()..remove(item);
+    currentlySelectedAssets = newList;
   }
+
+  @Deprecated('Use selectAsset instead')
+  void selectAssetEntity(A entity) => selectAsset(entity);
+
+  @Deprecated('Use unSelectAsset instead')
+  void unselectAssetEntity(A entity) => unSelectAsset(entity);
 }
diff --git a/lib/src/widget/asset_picker_viewer.dart b/lib/src/widget/asset_picker_viewer.dart
diff --git a/pubspec.yaml b/pubspec.yaml
