Flutter排名生成插件lexo_rank_generator的使用

LexoRank是一个用于生成字典序排序的Flutter插件，旨在高效地重新排序列表项。

特性

• 轻松生成两个排名之间的字典序排名。
• 可以轻松更改生成排名的长度，使用你喜欢的英文字母。
• 能够生成一个排名列表，用于重新平衡过程或初始排名。
• 提供方法检测排名是否超过某个阈值。

使用方法

1. 生成排名

要生成排名，首先创建一个LexoRank实例并调用getRankBetween方法，并传入定义的第一个和第二个排名。

const lexoRank = LexoRank();
final rank = lexoRank.getRankBetween(firstRank: 'aaaa', secondRank: 'cccc');
print(rank); // 输出：bbbb

第一个排名应低于第二个排名。如果你不确定，可以在创建LexoRank实例时传递reorderPosition参数。

const lexoRank2 = LexoRank(reorderPosition: true);
final result2 = lexoRank2.getRankBetween(firstRank: 'cccc', secondRank: 'aaaa');
print(result2);

2. 生成排名列表

你可以生成一个排名列表：

final itemsRank = lexoRank.generateInitialRank(sizeOfItems: 100);

你可以通过以下参数自定义生成的排名列表：

• sizeOfItems: 需要生成的排名数量。
• rankLength: 指定初始基础排名字母长度，默认为5。
• startRankLetter: 指定生成初始基础排名的起始字母，默认为’a’。
• endRankLetter: 指定生成初始基础排名的结束字母，默认为’z’。

示例：

print('生成从 `a` 到 `z` 的排名');
final itemsRank = lexoRank.generateInitialRank(sizeOfItems: 100);
print('items: $itemsRank');
print('生成的数量: ${itemsRank.length}');
print('\n');

print('生成从 `a` 到 `c` 的排名');
final itemsRank2 = lexoRank.generateInitialRank(
  sizeOfItems: 100,
  startRankLetter: 'a',
  endRankLetter: 'c',
);
print('items2: $itemsRank2');
print('生成的数量2: ${itemsRank2.length}');
print('\n');

print('生成3个字符长度的排名，从 `a` 到 `z`');
final itemsRank3 = lexoRank.generateInitialRank(sizeOfItems: 1000, rankLength: 3);
print('items3: $itemsRank3');
print('生成的数量3: ${itemsRank3.length}');
print('\n');

print('生成3个字符长度的排名，从 `a` 到 `c`');
final itemsRank4 = lexoRank.generateInitialRank(
  sizeOfItems: 1000,
  startRankLetter: 'a',
  endRankLetter: 'c',
  rankLength: 3,
);
print('items4: $itemsRank4');
print('生成的数量4: ${itemsRank4.length}');
print('\n');

3. 检查排名是否超过限制

你可以检查排名列表是否超过了某个限制：

final stats = lexoRank.shouldRebalanced(items, maxRankLength: 5);
print(stats.exceeded);

示例Demo

下面是一个完整的示例代码，展示了如何使用lexo_rank_generator插件：

import 'package:lexo_rank_generator/lexo_rank_generator.dart';

void main() {
  const lexoRank = LexoRank();
  
  // 生成排名
  final rank = lexoRank.getRankBetween(firstRank: 'aaaa', secondRank: 'cccc');
  print('生成的排名: $rank'); // 输出：bbbb
  
  // 使用reorderPosition参数
  const lexoRank2 = LexoRank(reorderPosition: true);
  final rank2 = lexoRank2.getRankBetween(firstRank: 'cccc', secondRank: 'aaaa');
  print('使用reorderPosition生成的排名: $rank2');
  print('排名相同: ${rank == rank2}'); // 输出：false

  // 生成初始排名列表
  print('生成从 `a` 到 `z` 的排名');
  final itemsRank = lexoRank.generateInitialRank(sizeOfItems: 100);
  print('items: $itemsRank');
  print('生成的数量: ${itemsRank.length}');
  print('\n');

  print('生成从 `a` 到 `c` 的排名');
  final itemsRank2 = lexoRank.generateInitialRank(
    sizeOfItems: 100,
    startRankLetter: 'a',
    endRankLetter: 'c',
  );
  print('items2: $itemsRank2');
  print('生成的数量2: ${itemsRank2.length}');
  print('\n');

  print('生成3个字符长度的排名，从 `a` 到 `z`');
  final itemsRank3 = lexoRank.generateInitialRank(sizeOfItems: 1000, rankLength: 3);
  print('items3: $itemsRank3');
  print('生成的数量3: ${itemsRank3.length}');
  print('\n');

  print('生成3个字符长度的排名，从 `a` 到 `c`');
  final itemsRank4 = lexoRank.generateInitialRank(
    sizeOfItems: 1000,
    startRankLetter: 'a',
    endRankLetter: 'c',
    rankLength: 3,
  );
  print('items4: $itemsRank4');
  print('生成的数量4: ${itemsRank4.length}');
  print('\n');
}

问题与贡献

如果你有任何问题、bug或者功能请求，请在我们的GitHub页面上提交issue。

如果你想为插件做出贡献（例如改进文档、解决bug或添加新功能），请考虑提交一个pull request。

这个Markdown文档详细介绍了如何使用`lexo_rank_generator`插件来生成和管理排名，并提供了完整的示例代码帮助你快速上手。