패키지, 저장소 및 앱 카테고리 검색

fconsole 표지
패키지 상세v2.6.3

fconsole

v-console와 유사한 오버레이 콘솔 로그 목록.

AndroidiOSmacOSWindowsLinux
30일 다운로드
200
좋아요
28
Pub 점수
130

패키지 설치

flutter pub add fconsole

패키지 개요

공개 정보를 바탕으로 생성한 선택 가이드입니다.

FConsole은 v-console과 유사한 오버레이 콘솔 로그 인터페이스를 제공하는 Flutter 애플리케이션용 디버깅 도구입니다. 실시간으로 로그, 오류 및 성능 메트릭을 표시하여 개발 중 디버깅을 더 쉽게 만듭니다. 콘솔은 앱 화면에 접근 가능한 오버레이 형태로 나타나며, 개발자가 컨텍스트를 전환하지 않고도 출력 내용을 확인할 수 있습니다. Android, iOS, macOS, Windows, Linux 등 여러 플랫폼을 지원합니다. FConsole은 즉각적인 피드백과 상호작용 가능한 로깅 기능을 통해 개발자 생산성을 향상시킵니다.

사용 사례

  • 앱 개발 중 실시간 디버깅
  • 런타임 로그 및 오류 모니터링
  • 개발 모드에서의 성능 모니터링
  • 앱 상태 및 로그 빠른 점검
  • 실시간 콘솔 접근을 통해 개발 워크플로우 향상

주요 기능

  • 오버레이 콘솔 인터페이스
  • 실시간 로그 표시 및 필터링
  • 크로스 플랫폼 지원
  • 오류 및 경고 강조
  • 인터랙티브 로그 검사

적합한 대상

  • 활발한 개발 중인 플러터 개발자
  • 실시간 디버깅 도구가 필요한 팀
  • 테스트 중에 자세한 로깅이 필요한 앱
  • 로컬 디버깅 워크플로를 사용하는 개발자
  • 빠른 피드백이 필수적인 프로젝트

고려 사항

  • 생산 사용을 위한 것이 아님
  • 디버그 모드에서는 앱 성능에 약간의 영향을 줄 수 있습니다
  • 오버레이가 테스트 중에 UI에 영향을 줄 수 있습니다
  • 수동 통합 및 설정이 필요합니다
  • 레이아웃 및 스타일링에 대한 사용자 정의 옵션이 제한적

원본 README

연결된 소스 저장소의 README 원문 스냅샷입니다. 최신 내용은 저장소에서 확인하세요.

fconsole

一个用于调试的面板组件,类似微信小程序的 v-console:在页面上创建一个可拖拽的悬浮窗,点击悬浮窗可启用 log 列表面板。

主要功能:

  • 显示悬浮窗,随时打开 Log 页面
  • 可自定义页面插入,项目专属调试页不用藏
  • 使用 FlowLog 可记录流程事件,网络 Log 清晰可见(支持json树状展示)
  • 分享完整 FlowLog 网络请求,一键反馈(甩锅)后端报错

截图

Log Flow Flow Detail

使用

// 同时拦截原生 print 函数和未捕获的异常
void main() => runAppWithFConsole(
      MyApp(),
      delegate: MyCardDelegate(),
      beforeRun: () async {
        WidgetsFlutterBinding.ensureInitialized();
        // Do some init before runApp
      }
    );

然后才可以使用下列方法:

启动悬浮窗

只需要调用顶层方法就可以打开悬浮窗

// 启动悬浮窗
showConsole();
// 隐藏悬浮窗
hideConsole();
自定义页面

很多时候我们都需要插入自定义页面,可以这样做:

/// More code in file: ./example/lib/main.dart
void main() => runAppWithFConsole(
      MyApp(),
      delegate: MyCardDelegate(),
    );

class MyCardDelegate extends FConsoleCardDelegate {
  @override
  List<FConsoleCard> cardsBuilder(DefaultCards defaultCards) {
    return [
      defaultCards.logCard,
      defaultCards.flowCard,
      /// Custom Page by
      FConsoleCard(
        name: "my",
        builder: (ctx) => CustomLogPage(),
      ),
      defaultCards.sysInfoCard,
    ];
  }
}

class CustomLogPage extends StatelessWidget {
  const CustomLogPage({Key key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return Container(
      alignment: Alignment.center,
      child: Text('custom page content'),
    );
  }
}

卡片内无法使用OKToast,若要显示 toast 信息,FConsole提供了一个showMessage方法:

FConsole.showMessage("Copy Success");
拦截原生 print 函数和未捕获的异常

fconsole可以拦截原先的print函数,包括其他库中的print语句和未捕获的throw同样可以被拦截。

拦截后,print将等效于FConsole.log,未捕获的错误将等效于FConsole.error。

要使用此功能,请将runApp替换为runFConsoleApp:

void main() => runFConsoleApp(MyApp());

然后,原生print和throw将被拦截:

// 具体代码见example
SettingRow(
  icon: Icons.warning,
  text: '原生Print',
  right: Container(),
  onTap: () {
    print('${DateTime.now().toIso8601String()}');
  },
),
SettingRow(
  icon: Icons.warning,
  text: '原生Throw',
  right: Container(),
  onTap: () {
    throw '${DateTime.now().toIso8601String()}';
  },
),
添加 log

使用 FConsole 添加 log 非常简单:

// 添加log
FConsole.log("打印了一行log");
FConsole.log("打印了一行log");
FConsole.log("打印了一行log");
FConsole.log("打印了一行log");
// 添加error
FConsole.error("打印了一行error");
FConsole.error("打印了一行error");
FConsole.error("打印了一行error");
FConsole.error("打印了一行error");

然后就可以在 FConsole 内查看 log 记录。

创建 FlowLog(支持JSON)

可以使用FlowLog的形式记录 Log:

FlowLog.of('分享启动').log('用户进入页面 $id');
FlowLog.of('分享启动').log('获取到分享值1 $shareId');
FlowLog.of('分享启动').log('查询分享信息1 成功');
FlowLog.of('分享启动').log('获取到分享值2 $shareId');
FlowLog.of('分享启动').log('查询分享信息2 成功');
FlowLog.of('分享启动').log('获取到分享值3 $shareId');
FlowLog.of('分享启动').log('查询分享信息3 成功');
FlowLog.of('分享启动').log('获取到分享值4 $shareId');
FlowLog.of('分享启动').log(map);// 传入Map/List将会以json形式展示
FlowLog.of('分享启动').error('查询分享信息4错误: $map');
FlowLog.of('分享启动').end();

也可以使用变量来记录

var logger = FlowLog.of('分享启动');
logger.log('用户进入页面 $id');
logger.log('获取到分享值 $shareId');
logger.error('查询分享信息错误: $map');
logger.end();

FlowLog 可以记录用户的一系列行为,在用户出现问题时,通过 Console 信息即可快速定位问题。

FlowLog 的优势在于,在同一页面上的操作可以分开记录,不会互相干扰,例如同时处理两张图片,一张成功而另一张失败,会按 id 形成两个不同的 FlowLog。

FlowLog with Dio

一个很好的实践:使用 FlowLog 记录每一次网络请求

Tips: 使用“Share”可分享完整网络请求,一键反馈(甩锅)后端报错。

extension _GetLogID on RequestOptions {
  String get logId {
    return '[$method]${uri.path}';
  }
}

_http = Dio();
_http!.interceptors.add(InterceptorsWrapper(
  onRequest: (RequestOptions options, handler) {
    var _logger = FlowLog.ofNameAndId(
      options.logId,
      id: '${options.hashCode}',
    );
    _logger.log('开始请求 ${options.method}');
    _logger.log('data:${options.data}');
    _logger.log('params:${options.queryParameters}');
    _logger.log('header:${options.headers.toString()}');
    handler.next(options);
  },
  onResponse: (e, handler) {
    var _logger = FlowLog.ofNameAndId(
      e.requestOptions.logId,
      id: '${e.requestOptions.hashCode}',
    );
    _logger.log('请求结束');
    _logger.log('Http Status Code:${e.statusCode}');
    _logger.log('Response Data:\n${e.data}');
    _logger.end();
    handler.next(e);
  },
  onError: (e, handler) {
    var _logger = FlowLog.ofNameAndId(
      e.requestOptions.logId,
      id: '${e.requestOptions.hashCode}',
    );
    _logger.error('请求错误:$e');
    _logger.end('请求错误结束');
    handler.next(e);
  },
));

카테고리

의존성

의존성 목록 7 개

소스 저장소

이 패키지를 사용하는 프로젝트

아직 데이터가 없습니다.