Flutter界面度量与适配插件flutterando_metrics的使用

Flutterando Metrics 是一个帮助你识别和修复 Dart 和 Flutter 代码问题的工具包。这些问题包括潜在的运行时错误、违反最佳实践以及样式问题。Flutterando Metrics 包含超过70个内置规则来验证你的代码是否符合各种预期，并且你可以根据具体需求自定义这些规则。

安装

要安装 flutterando_metrics 插件，可以使用以下命令：

$ dart pub add --dev flutterando_metrics

# 或者对于 Flutter 项目
$ flutter pub add --dev flutterando_metrics

基本配置

在 analysis_options.yaml 文件中添加配置，并重新加载 IDE 以使分析器发现插件配置。

基本配置示例

analyzer:
  plugins:
    - flutterando_metrics

flutterando_metrics:
  metrics:
    cyclomatic-complexity: 20
    number-of-parameters: 4
    maximum-nesting-level: 5
  metrics-exclude:
    - test/**

更多关于配置的信息可以在 官方网站 上找到。

使用方法

CLI 工具

该包可以用作 CLI 工具，并支持多个命令：

分析命令示例

报告代码度量和反模式违规：

$ dart run flutterando_metrics:metrics analyze lib

# 或者对于 Flutter 项目
$ flutter pub run flutterando_metrics:metrics analyze lib

结果可以以多种格式输出，例如：控制台、GitHub、Codeclimate、HTML、JSON。

检查不必要的可空参数

检查函数、方法、构造函数中的不必要可空参数：

$ dart run flutterando_metrics:metrics check-unnecessary-nullable lib

# 或者对于 Flutter 项目
$ flutter pub run flutterando_metrics:metrics check-unnecessary-nullable lib

结果可以以控制台或 JSON 格式输出。

检查未使用的文件

检查未使用的 .dart 文件：

$ dart run flutterando_metrics:metrics check-unused-files lib

# 或者对于 Flutter 项目
$ flutter pub run flutterando_metrics:metrics check-unused-files lib

结果可以以控制台或 JSON 格式输出。

检查未使用的本地化内容

检查未使用的本地化类成员，例如：

class ClassWithLocalization {
  String get title {
    return Intl.message(
      'Hello World',
      name: 'title',
      desc: 'Title for the Demo application',
      locale: localeName,
    );
  }
}

执行命令：

$ dart run flutterando_metrics:metrics check-unused-l10n lib

# 或者对于 Flutter 项目
$ flutter pub run flutterando_metrics:metrics check-unused-l10n lib

结果可以以控制台或 JSON 格式输出。

检查未使用的代码

检查未使用的 .dart 文件中的代码：

$ dart run flutterando_metrics:metrics check-unused-code lib

# 或者对于 Flutter 项目
$ flutter pub run flutterando_metrics:metrics check-unused-code lib

结果可以以控制台或 JSON 格式输出。

示例 Demo

下面是一个简单的 Flutter 项目示例，展示了如何集成和使用 flutterando_metrics：

pubspec.yaml

name: flutterando_metrics_demo
description: A demo project to showcase flutterando_metrics.

environment:
  sdk: ">=2.17.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter

dev_dependencies:
  flutterando_metrics: ^latest_version

lib/main.dart

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutterando Metrics Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutterando Metrics Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}

analysis_options.yaml

analyzer:
  plugins:
    - flutterando_metrics

flutterando_metrics:
  metrics:
    cyclomatic-complexity: 20
    number-of-parameters: 4
    maximum-nesting-level: 5
  metrics-exclude:
    - test/**

运行以下命令来分析代码：

$ dart run flutterando_metrics:metrics analyze lib