如何在Dart中打印变量名本身？求类C++的调试实现方案

我之前在C++中通过宏实现了快速调试功能，能直接打印变量名及其对应的值：

code.cpp

#define bug(x) cout << #x << ": " << x << '\n'

int main() {
    int a = 5;
    bug(a);

    int b = 3;
    bug(b);
    
    return 0;
}

输出

a: 5
b: 3

现在希望在Dart中实现同样的效果——直接传入变量，即可打印它的名称和对应值，但始终没找到合适的方案。同时也想了解Dart中更优的调试实践。

我尝试过的方案均不满足需求：

• 搜索到的方案要么仅支持从Map中打印值，要么需要通过reflectable包根据值反查变量名，但我想要的是直接传入变量就能输出其名称。
• 得到的一段Dart代码完全无效：

void bug(var x) {
  print('$x: ${x.toString()}');
}

void main() {
  int x = 5;
  bug(x);
}

这段代码会输出5: 5，完全达不到预期效果。

Dart中实现类似功能的可行方法 #

Dart没有C++那样的宏文本替换能力，但可以通过以下几种方式实现近似效果：

方法1：手动传入变量名（无依赖，简单直接）

通过字符串插值，手动把变量名和变量值一起传入调试函数：

void bug(String varName, dynamic value) {
  print('$varName: $value');
}

void main() {
  int a = 5;
  bug('a', a);
  
  String str = "hello dart";
  bug('str', str);
}

输出

a: 5
str: hello dart

这种方式虽然需要手动写变量名字符串，但胜在无依赖、实现简单，适合快速临时调试。

方法2：扩展函数优化调用体验

给Object类扩展一个打印方法，让调用更简洁：

extension DebugPrint on Object {
  void printWithName(String varName) {
    print('$varName: $this');
  }
}

void main() {
  bool isEnabled = true;
  isEnabled.printWithName('isEnabled');
  
  double price = 9.99;
  price.printWithName('price');
}

输出

isEnabled: true
price: 9.99

方法3：反射实现自动获取变量名（不推荐生产环境）

如果一定要自动获取变量名，可以使用reflectable包，但反射会带来性能开销，且不适用于Flutter等AOT编译场景，同时只能打印类成员变量，无法处理局部变量：

1. 在pubspec.yaml中添加依赖：

dependencies:
  reflectable: ^4.0.0

2. 实现代码：

import 'package:reflectable/reflectable.dart';

class DebugReflector extends Reflectable {
  const DebugReflector() : super(invokingCapability);
}

const debugReflector = DebugReflector();

@debugReflector
class TestClass {
  int numVal = 100;
  String strVal = "reflect test";
  
  void printAllVars() {
    var instanceMirror = debugReflector.reflect(this);
    var declarations = instanceMirror.type.declarations;
    
    for (var key in declarations.keys) {
      if (declarations[key] is VariableDeclarationMirror) {
        print('$key: ${instanceMirror.invokeGetter(key)}');
      }
    }
  }
}

void main() {
  TestClass obj = TestClass();
  obj.printAllVars();
}

输出

numVal: 100
strVal: reflect test

Dart推荐的调试实践 #

1. 使用debugPrint替代print：在Flutter中，debugPrint会自动处理长日志避免截断，且仅在调试模式生效。
2. IDE断点调试：Android Studio/IntelliJ或VS Code的断点调试功能可以直接查看变量值、调用栈，比打印日志更高效直观。
3. 使用专业日志包：比如logger包，支持多日志级别、格式化输出，还能显示日志所在的文件和行号：

import 'package:logger/logger.dart';

var logger = Logger();

void main() {
  int count = 5;
  logger.d('count: $count'); // 调试级别日志
}

4. 使用dart:developer的log函数：可以在DevTools中查看包含调用栈的详细日志信息：

import 'dart:developer';

void main() {
  String userName = "samyak";
  log('userName: $userName');
}

内容的提问来源于stack exchange，提问作者samyakbardiya