Flutter唯一名称生成插件unique_names_generator的使用

Flutter唯一名称生成插件unique_names_generator的使用

简介

unique_names_generator 是一个 Dart 插件，专门用于生成随机且唯一的名称。它提供了多种内置词典，并支持自定义词典，可以根据需要生成不同风格的名称。

功能特性

• 内置词典：提供多种默认词典，如形容词、动物、颜色、国家、语言、人名和《星球大战》角色等。
• 自定义词典：允许用户添加自己的词典。
• 配置选项：可以通过 Config 对象配置生成器的行为，包括生成的单词数量、分隔符、词典来源和样式等。
• 样式选项：支持生成小写、首字母大写或全大写的名称。

使用方法

配置选项

创建一个 Config 对象来配置生成器的行为，常用的参数包括：

• length：生成的单词数量。
• separator：单词之间的分隔符，默认为下划线 _。
• dictionaries：词典来源，可以选择预定义的词典或添加自定义词典。
• style：生成的名称样式，可选值为 Style.lowerCase、Style.capital 和 Style.upperCase。

样式选项

• Style.lowerCase：生成全部小写的名称。
• Style.capital：生成首字母大写的名称。
• Style.upperCase：生成全部大写的名称。

预定义词典

插件提供了以下预定义词典：

• adjectives：形容词
• animals：动物
• colors：颜色
• countries：国家
• languages：语言
• names：人名
• starWars：《星球大战》角色

示例代码

以下是一个完整的示例代码，展示了如何使用 unique_names_generator 插件生成随机名称：

import 'package:unique_names_generator/unique_names_generator.dart';

void main() {
  try {
    // 创建生成器并配置
    final generator = UniqueNamesGenerator(
      config: Config(
        // 选择要使用的词典
        dictionaries: [adjectives, animals, colors],
        // 设置生成的单词数量
        length: 3,
        // 设置单词之间的分隔符
        separator: '-',
        // 设置生成的名称样式
        style: Style.capital,
      ),
    );

    // 生成随机名称
    final word = generator.generate();
    print(word);  // 输出类似 "Brave-Lion-Blue" 的随机名称
  } on UniqueNamesGeneratorException catch (e) {
    // 捕获并处理异常
    print(e.reason);
  }
}

完整示例 Demo

为了更好地理解如何在 Flutter 项目中使用 unique_names_generator，以下是一个完整的 Flutter Demo 应用程序，展示如何生成并显示随机名称。

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 unique_names_generator 依赖：

dependencies:
  flutter:
    sdk: flutter
  unique_names_generator: ^latest_version

2. 创建主页面

接下来，创建一个简单的 Flutter 页面，点击按钮时生成并显示随机名称。

import 'package:flutter/material.dart';
import 'package:unique_names_generator/unique_names_generator.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Unique Name Generator Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: NameGeneratorPage(),
    );
  }
}

class NameGeneratorPage extends StatefulWidget {
  @override
  _NameGeneratorPageState createState() => _NameGeneratorPageState();
}

class _NameGeneratorPageState extends State<NameGeneratorPage> {
  String _generatedName = '';

  // 创建生成器并配置
  final generator = UniqueNamesGenerator(
    config: Config(
      dictionaries: [adjectives, animals, colors],
      length: 3,
      separator: '-',
      style: Style.capital,
    ),
  );

  // 生成随机名称
  void _generateName() {
    setState(() {
      _generatedName = generator.generate();
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Unique Name Generator'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Generated Name:',
              style: TextStyle(fontSize: 24),
            ),
            SizedBox(height: 20),
            Text(
              _generatedName,
              style: TextStyle(fontSize: 32, fontWeight: FontWeight.bold),
            ),
            SizedBox(height: 40),
            ElevatedButton(
              onPressed: _generateName,
              child: Text('Generate New Name'),
            ),
          ],
        ),
      ),
    );
  }
}

运行效果

运行该应用程序后，您将看到一个带有按钮的页面。点击按钮时，会生成一个新的随机名称并显示在页面上。每次点击按钮都会生成不同的名称，例如：

Brave-Lion-Blue
Fast-Tiger-Red
Clever-Elephant-Green