Flutter功能未知插件nameof的探索与使用

Flutter功能未知插件nameof的探索与使用

动机

有时需要访问编程语言实体的名称，例如方法、属性、构造函数等。不幸的是，Flutter没有为此目的设计的反射机制。但是有代码生成！通过这个包，你可以轻松访问代码实体的名称。

安装

要使用Nameof，你需要一个典型的build_runner代码生成器设置。首先，在你的pubspec.yaml文件中添加以下依赖项：

对于Flutter项目：

$ flutter pub add nameof_annotation
$ flutter pub add --dev build_runner
$ flutter pub add --dev nameof

对于Dart项目：

$ dart pub add nameof_annotation
$ dart pub add --dev build_runner
$ dart pub add --dev nameof

这将安装三个包：

• build_runner：用于运行代码生成器的工具
• nameof：代码生成器
• nameof_annotation：包含Nameof注解的包

运行生成器

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

dart run build_runner build

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

flutter pub run build_runner build

注意，像大多数代码生成器一样，nameof需要你既导入注解（nameof_annotation），又在文件顶部使用part关键字。因此，一个想要使用nameof的文件将从以下内容开始：

import 'package:nameof_annotation/nameof_annotation.dart';

part 'my_file.nameof.dart';

使用Nameof

简单用法

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

[@nameof](/user/nameof)
class Car {
  final double price;
  final double weight;

  final int year;
  final String model;

  Car(this.price, this.weight, this.year, this.model);

  Car.sedan(double price, double weight, int year)
      : this(price, weight, year, 'Sedan');
}

然后运行生成器。它将生成以下代码：

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

  static const String constructor = '';
  static const String constructorSedan = 'sedan';

  static const String fieldPrice = 'price';
  static const String fieldWeight = 'weight';
  static const String fieldYear = 'year';
  static const String fieldModel = 'model';
}

然后你可以在代码中使用它：

print(NameofCar.fieldPrice);

非常简单！

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

模型覆盖

你可以通过使用覆盖设置和@NameofIgnore注解来精确设置模型成员的覆盖。以下是两个配置示例，它们将生成相同的输出。

第一个配置：

@Nameof(coverage: Coverage.excludeImplicit)
class Itinerary {
  final double longStart;
  final double latStart;

  final double longEnd;
  final double latEnd;

  @nameofKey
  final String name;

  @nameofKey
  final double length;

  Itinerary(this.longStart, this.latStart, this.longEnd, this.latEnd, this.name,
      this.length);
}

第二个配置：

@Nameof(coverage: Coverage.includeImplicit)
class Itinerary {
  @nameofIgnore
  final double longStart;
  
  @nameofIgnore
  final double latStart;

  @nameofIgnore
  final double longEnd;
  
  @nameofIgnore
  final double latEnd;

  final String name;
  final double length;

  @nameofIgnore
  Itinerary(this.longStart, this.latStart, this.longEnd, this.latEnd, this.name,
      this.length);
}

生成的输出：

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

  static const String fieldName = 'name';
  static const String fieldLength = 'length';
}

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

覆盖名称

如果你想覆盖某个元素的名称，你可以这样做：

[@nameof](/user/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目标

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

配置

Nameof提供了多种选项来自定义生成的代码。例如，你可能想要更改模型的覆盖行为。

更改特定模型的行为

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

@Nameof(coverage: Coverage.excludeImplicit)
class Employee {...}

更改整个项目的行为

如果你想将修改应用到所有Nameof模型，可以通过自定义一个名为build.yaml的文件来实现。该文件是一个可选的配置文件，应放置在pubspec.yaml旁边：

project_folder/
  pubspec.yaml
  build.yaml
  lib/

在那里，你可以更改与@Nameof中找到的选项相同的选项：

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

有两种覆盖设置可用：includeImplicit（默认）和excludeImplicit。

完整示例Demo

以下是一个完整的示例，展示了如何在Flutter项目中使用Nameof插件：

1. 创建Flutter项目

   flutter create nameof_demo
   cd nameof_demo
   

2. 添加依赖项 在pubspec.yaml文件中添加以下依赖项：

   dependencies:
     nameof_annotation: ^latest_version
   
   dev_dependencies:
     build_runner: ^latest_version
     nameof: ^latest_version
   

3. 创建模型类 在lib/models/car.dart中创建一个模型类：

   import 'package:nameof_annotation/nameof_annotation.dart';
   
   part 'car.nameof.dart';
   
   [@nameof](/user/nameof)
   class Car {
     final double price;
     final double weight;
   
     final int year;
     final String model;
   
     Car(this.price, this.weight, this.year, this.model);
   
     Car.sedan(double price, double weight, int year)
         : this(price, weight, year, 'Sedan');
   }
   

4. 运行生成器

   flutter pub run build_runner build
   

5. 使用生成的名称 在lib/main.dart中使用生成的名称：

   import 'package:flutter/material.dart';
   import 'models/car.dart';
   
   void main() {
     runApp(MyApp());
   }
   
   class MyApp extends StatelessWidget {
     @override
     Widget build(BuildContext context) {
       return MaterialApp(
         home: Scaffold(
           appBar: AppBar(title: Text('Nameof Demo')),
           body: Center(
             child: Column(
               mainAxisAlignment: MainAxisAlignment.center,
               children: <Widget>[
                 Text('Class Name: ${NameofCar.className}'),
                 Text('Constructor: ${NameofCar.constructor}'),
                 Text('Constructor Sedan: ${NameofCar.constructorSedan}'),
                 Text('Field Price: ${NameofCar.fieldPrice}'),
                 Text('Field Weight: ${NameofCar.fieldWeight}'),
                 Text('Field Year: ${NameofCar.fieldYear}'),
                 Text('Field Model: ${NameofCar.fieldModel}'),
               ],
             ),
           ),
         ),
       );
     }
   }
   

6. 运行应用程序

   flutter run