Flutter特殊字符处理插件special_characters_handler的使用

Flutter特殊字符处理插件special_characters_handler的使用

Dart的强大且灵活的框架，用于在字符串中管理特殊字符、表情符号和HTML实体。

特性

• 🧹 智能清理特殊字符
• 🔄 转换HTML实体
• 😊 管理表情符号
• BitFields符统一
• ⚡ 性能优化，带有缓存
• 🎯 简单直观的API
• 🔧 高度可配置

安装

在pubspec.yaml文件中添加依赖：

dependencies:
  special_characters_handler: ^1.0.0

快速使用

以下是一个简单的例子展示如何使用插件进行特殊字符处理：

import 'package:special_characters_handler/special_characters_handler.dart';

void main() {
  // 使用简单的字符串扩展方法
  String text = "Héllô "world" 😊";
  String cleaned = text.cleanSpecialCharacters();
  print(cleaned); // 输出: Hello "world"

  // 使用自定义选项
  final options = CleaningOptions(
    removeHtmlEntities: true,
    removeEmojis: true,
    normalizeUnicode: true,
    convertAccents: true,
  );

  String customCleaned = text.cleanSpecialCharacters(options: options);
}

详细功能

1. 自定义配置

你可以通过自定义规则来处理特殊字符：

final handler = SpecialCharactersHandler();

// 添加自定义替换规则
handler.addReplacementRule(ReplacementRule(
  pattern: r'[0-9]+',
  replacement: '#',
  isRegex: true,
));

// 使用特定选项
final options = CleaningOptions(
  removeHtmlEntities: true,
  removeEmojis: false,
  normalizeUnicode: true,
  convertAccents: true,
  removeSpecialChars: true,
  preserveNewlines: true,
);

// 应用处理
String result = handler.clean("Hello 123 😊", options: options);
print(result); // 输出: Hello ### 😊

2. 处理表情符号

提取和删除表情符号：

String text = "Hello 😊 World 🌍";

// 提取表情符号
List<String> emojis = text.extractEmojis();
print(emojis); // 输出: [😊, 🌍]

// 删除表情符号
String noEmojis = text.cleanSpecialCharacters(
  options: CleaningOptions(removeEmojis: true)
);
print(noEmojis); // 输出: Hello  World 

3. 处理HTML实体

将HTML实体转换为普通文本：

String html = ""Hello" & 'World'";
String cleaned = html.cleanSpecialCharacters();
print(cleaned); // 输出: "Hello" & 'World'

4. 性能优化

该框架使用智能缓存系统来优化性能：

final handler = SpecialCharactersHandler();

// 缓存重复调用
String result1 = handler.clean("This is a long text that needs to be cleaned.");
String result2 = handler.clean("This is a long text that needs to be cleaned."); // 使用缓存
print(result1 == result2); // 输出: true

// 获取性能统计信息
Map<String, dynamic> stats = handler.getStats();
print(stats['cacheSize']); // 输出: 缓存大小

完整的API文档

详细的API文档可以在这里查看。

高级配置

全局配置

在配置文件中设置全局参数：

const config = SpecialCharactersConfig(
  maxInputLength: 1000000,
  enableLogging: true,
  cacheSize: 1000,
);

自定义规则

添加自定义替换规则：

final handler = SpecialCharactersHandler();

// 添加简单规则
handler.addReplacementRule(ReplacementRule(
  pattern: '@',
  replacement: 'at',
));

// 添加正则表达式规则
handler.addReplacementRule(ReplacementRule(
  pattern: r'\b\d+\b',
  replacement: '#',
  isRegex: true,
));

贡献

欢迎贡献代码！以下是贡献步骤：

1. Fork 项目
2. 创建一个新分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到远程分支 (git push origin feature/AmazingFeature)
5. 提交Pull Request

测试

运行测试：

dart test