Flutter现代命名风格插件nameof_modern的使用

Flutter现代命名风格插件nameof_modern的使用

标题

Nameof Modern

内容

在某些情况下，项目需要访问编程语言实体的名字，如方法、属性、构造函数等。不幸的是，今天Flutter没有为这个目的设计的反射机制。但是有代码生成！这个包使用代码生成来帮助访问类、方法等实体的名字。这个包是原始包nameof的更新版。nameof_modern完全基于nameof代码，感谢nameof作者❤️。nameof_modern进行了更新，并且包含了最新的功能以确保新2024和未来项目的正常运行。这个包是新的，并且在社区的帮助下我们正在改进它❤️。

🗒️重要提示: 这个包是基于nameof包创建的。nameof是一个为Dart类成员（如字段、属性、方法和构造函数）生成名称的生成器。nameof_modern完全基于nameof代码，感谢nameof作者❤️。

安装指南

为了使用nameof_modern，你需要你的典型build_runner代码生成设置。 首先，安装build_runner和nameof_modern，并将其添加到你的pubspec.yaml文件中：

• 如果你正在创建一个Flutter项目：

  $ flutter pub add nameof_annotation_modern
  $ flutter pub add --dev build_runner
  $ flutter pub add --dev nameof_modern
  

• 如果你正在创建一个Dart项目：

  $ dart pub add nameof_annotation_modern
  $ dart pub add --dev build_runner
  $ dart pub add --dev nameof_modern
  

这将安装三个包：

• build_runner，用于运行代码生成器的工具
• nameof_modern，代码生成器
• nameof_annotation，包含nameof_modern注解的包。

运行代码生成器

要运行代码生成器，请执行以下命令：

dart run build_runner build

对于Flutter项目，你也可以运行：

flutter pub run build_runner build

请注意，像大多数代码生成器一样，nameof_modern需要你导入注解（nameof_annotation_modern）并使用part关键字在文件顶部。

例如，一个想要使用nameof_modern的文件将从以下开始：

import 'package:nameof_annotation_modern/nameof_annotation_modern.dart';

part 'my_file.nameof.dart';

使用nameof_modern

简单使用

例如我们有一个类Movie。为了生成这个类的名字，你需要告诉生成器一些指令使用nameof_modern注解：

@nameof
class Movie {
  final String title;
  final String description;
  final int year;
  final String coverUrl;

  Movie(this.title, this.description, this.year, this.coverUrl);
}

然后你需要运行生成器。

它将生成以下代码：

/// Container for names of elements belonging to the [Movie] class
abstract class NameofMovie {
  static const String className = 'Movie';

  static const String constructor = '';

  static const String fieldTitle = 'title';
  static const String fieldDescription = 'description';
  static const String fieldYear = 'year';
  static const String fieldCoverUrl = 'coverUrl';
}

然后在你的代码中使用它：

print(NameofMovie.fieldTitle);
print(NameofMovie.fieldDescription);
print(NameofMovie.fieldYear);
print(NameofMovie.fieldCoverUrl);

很简单！

你也可以为抽象类和混入使用nameof注解。

模型覆盖

你可以通过使用覆盖设置和@NameofIgnore注解非常精确地设置模型成员的覆盖。例如，下面两种配置将导致相同的输出。

• 第一种配置：

  [@Nameof](/user/Nameof)(coverage: Coverage.excludeImplicit)
  class Movie {
    final String title;
    final String description;
    @nameofKey
    final int year;
    @nameofKey
    final String coverUrl;
  
    Movie(this.title, this.description, this.year, this.coverUrl);
  }
  

• 第二种配置：

  [@Nameof](/user/Nameof)(coverage: Coverage.includeImplicit)
  class Movie {
    @nameofIgnore
    final String title;
    @nameofIgnore
    final String description;
  
    final int year;
  
    final String coverUrl;
    
    @nameofIgnore
    Movie(this.title, this.description, this.year, this.coverUrl);
  }
  

  输出：

  /// Container for names of elements belonging to the [Movie] class
  abstract class NameofMovie {
    static const String className = 'Movie';
  
    static const String fieldYear = 'year';
    static const String fieldCoverUrl = 'coverUrl';
  }
  

  注意coverage设置，@nameofKey和@nameofIgnore注解。 如果你不设置覆盖，则生成器将默认使用includeImplicit设置。

覆盖名称

如果你想覆盖元素的名称，可以这样做！ 代码：

@nameof
class Ephemeral {
  @NameofKey(name: 'AbRaCadabra')
  String get flushLight => 'Purple';
}

生成器输出：

/// Container for names of elements belonging to the [Ephemeral] class
abstract class NameofEphemeral {
  static const String className = 'Ephemeral';

  static const String constructor = ''

  static const String propertyGetFlushLight = 'AbRaCadabra'
}

如你所见，属性被重命名了。输出中的名称是AbRaCadabra而不是flushLight。

名称目标

@NameofKey注解应用于公共字段、方法、属性和构造函数。

配置

nameof提供了多种自定义生成代码的方法。例如，你可能希望更改模型的覆盖行为。

要实现这一点，有两种可能性：

更改特定模型的行为

如果你想只针对一个特定的类自定义生成代码，可以通过注解设置来实现：

[@Nameof](/user/Nameof)(coverage: Coverage.excludeImplicit
class Employee {...}

更改整个项目的整体行为

相反，如果你不想对单个类进行修改，你可能希望同时对所有nameof模型进行修改。

你可以通过自定义名为build.yaml的文件来实现这一点。这个文件应该放在你的pubspec.yaml文件旁边：

project_folder/
  pubspec.yaml
  build.yaml
  lib/

在那里，你可以通过编写：

targets:
  $default:
    builders:
      nameof:
        options:
          coverage: includeImplicit