Flutter数据多条件排序插件multi_sort的使用

multi_sort #

一个快速且强大的Flutter包，可以帮助你一次性根据一个或多个属性对对象列表进行排序。

为什么选择multi_sort？#

假设你有一个手机列表，并希望根据其规格（如RAM、存储、价格、摄像头等）同时进行排序，类似于Microsoft Excel中的排序功能。

例如，假设我有以下手机列表：

List<Phone> items = [
    Phone("real me 6", 6, 18999, 128),
    Phone("real me 6", 8, 19999, 128),
    Phone("real Note 8", 7, 16999, 128),
    Phone("oppo a9", 4, 13999, 128),
    Phone("real me 6 pro", 6, 17999, 64),
    Phone("Oppo 5as", 2, 8999, 32),
    Phone("Real me 5i", 4, 10999, 64),
    Phone("Poco x2", 6, 18500, 128),
];

在按RAM优先排序，然后按存储排序后，结果将是：

[
    Phone("real me 6", 8, 19999, 128),
    Phone("real Note 8", 7, 16999, 128),
    Phone("real me 6", 6, 18999, 128),
    Phone("Poco x2", 6, 18500, 128),
    Phone("real me 6 pro", 6, 17999, 64),
    Phone("oppo a9", 4, 13999, 128),
    Phone("Oppo 5as", 2, 8999, 32),
    Phone("Real me 5i", 4, 10999, 64),
]

通过这个Flutter插件，你可以非常方便地实现这种偏好排序/多重排序/多级排序。

安装 #

1. 添加依赖项

在你的pubspec.yaml文件中添加以下内容：

dependencies:
  multi_sort: ^3.0.0

2. 安装依赖项

从命令行安装依赖项：

使用Flutter命令：

$ flutter pub get

或者，如果你的编辑器支持，可以直接通过IDE安装。

3. 导入插件

在Dart代码中导入插件：

import 'package:multi_sort/multi_sort.dart';

使用说明 #

初始化

List<dynamic> list; // 要排序的列表
List<bool> criteria; // 排序规则（true为升序，false为降序）
List<String> preference; // 排序优先级列表

排序列表

list.multisort(criteria, preference);

示例代码 #

以下是完整的示例代码：

import 'package:flutter/material.dart';
import "package:multi_sort/multi_sort.dart";

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: ExampleApp(),
    );
  }
}

class ExampleApp extends StatefulWidget {
  ExampleApp({Key key}) : super(key: key);

  @override
  _ExampleAppState createState() => _ExampleAppState();
}

/// 定义一个Item类
class Items {
  String name;
  int ram;
  int price;
  int storage;
  Items(this.name, this.ram, this.price, this.storage);

  /// 将对象映射为Map
  Map<String, dynamic> _toMap() {
    return {'name': name, 'price': price, 'ram': ram, 'storage': storage};
  }

  /// 获取对象的属性值
  dynamic get(String propertyName) {
    var _mapRep = _toMap();
    if (_mapRep.containsKey(propertyName)) {
      return _mapRep[propertyName];
    }
    throw ArgumentError('属性未找到');
  }
}

class _ExampleAppState extends State<ExampleApp> {
  // 定义一个Items列表
  List<Items> items = [
    Items("real me 6", 6, 18999, 128),
    Items("real me 6", 8, 19999, 128),
    Items("real Note 8", 7, 16999, 128),
    Items("oppo a9", 4, 13999, 128),
    Items("real me 6 pro", 6, 17999, 64),
    Items("Oppo 5as", 2, 8999, 32),
    Items("Real me 5i", 4, 10999, 64),
    Items("Poco x2", 6, 18500, 128),
  ];

  // 临时列表用于排序
  List<Items> sortingList = [];

  // 排序规则列表
  List<bool> criteria = [false, false];

  // 排序优先级列表
  List<String> preference = ['ram', 'storage'];

  @override
  void initState() {
    super.initState();
    setState(() {
      sortingList = items;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text("排序示例"),
      ),
      body: Column(
        children: [
          _buttons(), // 排序按钮
          ListView.builder(
            shrinkWrap: true,
            itemCount: sortingList.length,
            itemBuilder: (BuildContext context, int i) {
              return Card(
                child: Row(
                  mainAxisAlignment: MainAxisAlignment.spaceBetween,
                  children: [
                    Text(sortingList[i].name), // 名称
                    Text(sortingList[i].price.toString()), // 价格
                    Text(sortingList[i].ram.toString()), // RAM
                    Text(sortingList[i].storage.toString()), // 存储
                  ],
                ),
              );
            },
          ),
        ],
      ),
    );
  }

  Widget _buttons() {
    return ElevatedButton(
      onPressed: () {
        setState(() {
          /// 使用MultiSort进行排序
          sortingList.multisort(criteria, preference);
        });
      },
      child: Text('按优先级排序'),
    );
  }
}

许可证 #

multi_sort 的许可证为 MIT 许可证。

MIT License

Copyright (c) 2020 Deependra Chansoliya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.