BMChineseSort 项目使用教程

BMChineseSort 项目使用教程

BMChineseSort BMChineseSort是一个为模型、字典、字符串数组根据特定中文属性基于tableview分组优化的工具类，基于异步、多线程降低排序时间。 项目地址: https://gitcode.com/gh_mirrors/bm/BMChineseSort

1. 项目目录结构及介绍

BMChineseSort 项目的目录结构如下：

BMChineseSort/
├── BMChineseSort(OC)/
│   ├── BMChineseSort.h
│   ├── BMChineseSort.m
│   └── ...
├── BMChineseSorting(Swift)/
│   ├── BMChineseSorting.swift
│   └── ...
├── BMChineseSorting.xcworkspace/
├── .gitignore
├── LICENSE
└── README.md

目录结构介绍

• BMChineseSort(OC)/: 包含 Objective-C 版本的 BMChineseSort 工具类文件。

  • BMChineseSort.h: 头文件，定义了工具类的接口。
  • BMChineseSort.m: 实现文件，包含了工具类的具体实现。

• BMChineseSorting(Swift)/: 包含 Swift 版本的 BMChineseSort 工具类文件。

  • BMChineseSorting.swift: Swift 版本的工具类实现文件。

• BMChineseSorting.xcworkspace/: Xcode 工作区文件，用于管理和运行项目。

• .gitignore: Git 忽略文件，定义了哪些文件或目录不需要被 Git 追踪。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的说明文档，包含了项目的介绍、使用方法等信息。

2. 项目启动文件介绍

BMChineseSort 项目的启动文件是 BMChineseSorting.xcworkspace。这是一个 Xcode 工作区文件，用于管理和运行项目。通过打开这个文件，你可以启动 Xcode 并开始使用 BMChineseSort 工具类。

启动步骤

1. 打开终端，导航到项目目录。
2. 运行以下命令打开 Xcode 工作区：

   open BMChineseSorting.xcworkspace
   

3. Xcode 启动后，你可以选择运行项目或查看代码。

3. 项目配置文件介绍

BMChineseSort 项目的主要配置文件是 BMChineseSortSetting，它用于配置排序工具的行为和参数。

配置文件介绍

• sortMode: 排序所用的方法，可选值为 1 或 2。

  • 1: 使用 CFStringTransform 方法转换，比较耗时。
  • 2: 使用汉字码表对应的首字母码表，通过编码顺序查找，比较快。

• compareTpye: 仅在 Swift 版本中使用，用于设置比较类型。

  • fullPinyin: 全拼音比较。
  • initial: 首字母比较（默认）。

• logEable: 是否开启打印日志，YES 表示开启，NO 表示关闭。

• needStable: 是否要求排序稳定，以速度为代价的稳定的排序。

• specialCharSectionTitle: 特殊字符最后单独分组所用的分组名称，默认为 "#"。

• specialCharPositionIsFront: 特殊字符所在位置，YES 表示开头，NO 表示结尾。

• ignoreModelWithPrefix: 剔除特定字符开头的对象。

• polyphoneMapping: 多音字映射，用于手动修改多音字的拼音映射。

配置示例

BMChineseSortSetting *setting = [BMChineseSortSetting share];
setting.sortMode = 2; // 使用汉字码表排序
setting.logEable = YES; // 开启日志
setting.polyphoneMapping = @{@"长安": @"CA"}; // 手动映射多音字

通过这些配置，你可以根据项目需求调整 BMChineseSort 工具类的行为。

BMChineseSort BMChineseSort是一个为模型、字典、字符串数组根据特定中文属性基于tableview分组优化的工具类，基于异步、多线程降低排序时间。 项目地址: https://gitcode.com/gh_mirrors/bm/BMChineseSort