Flutter静态代码检查：让Flutter应用更健壮

2023-11-07 13:39:36

Flutter静态代码检查：提高Flutter代码质量的利器

Flutter作为一个跨平台移动应用开发框架，其优势在于代码跨平台，易于上手。但为了确保Flutter代码的质量，就需要进行代码检查。Flutter静态代码检查是提高Flutter代码质量的利器，它可以帮助我们发现代码中的潜在问题，使代码更加健壮。

使用Flutter analyze进行静态代码检查

一般情况下，在工程文件下配有分析脚本的情况下，可以直接使用flutter analyze命令进行静态检查，这和开发工具Android Studio自带的检查插件的效果是一样的，最终结果会显示在AS下方的Dart Analysis Tab下。检查器会根据项目根目录下的分析配置文件进行检查。

使用Flutter Lint进行静态代码检查

Flutter Lint是一个静态代码检查工具，它可以帮助我们发现Flutter代码中的常见问题，包括代码风格问题、性能问题和安全问题。我们可以通过以下步骤使用Flutter Lint进行静态代码检查：

安装Flutter Lint：

flutter pub global activate lint

在项目根目录下创建.flutter-lintrc文件，并写入以下内容：

linter:
  rules:
    - avoid_function_literals_in_foreach_calls
    - avoid_renaming_method_parameters
    - avoid_return_types_on_setters
    - camel_case_types
    - constant_identifier_names
    - control_flow_in_finally
    - empty_catches
    - empty_constructor_bodies
    - empty_statements
    - hash_and_equals
    - invalid_null_aware_operator
    - invalid_use_of_visible_for_testing_member
    - library_names
    - list_remove_const
    - missing_whitespace_between_adjacent_strings
    - no_adjacent_strings_in_list
    - no_duplicate_case_values
    - no_logic_in_create_state
    - no_runtime_type_checking_as_type_test
    - non_constant_identifier_names
    - only_throw_errors
    - overridden_fields
    - package_api_docs
    - prefer_const_constructors
    - prefer_const_declarations
    - prefer_const_literals_to_create_immutables
    - prefer_final_fields
    - prefer_initializing_formals
    - prefer_inlined_adds
    - prefer_is_not_operator
    - prefer_single_quotes
    - prefer_typing_uninitialized_variables
    - slash_for_doc_comments
    - sort_constructors_first
    - sort_unnamed_constructors_first
    - test_types_in_equals
    - throw_in_finally
    - type_annotate_public_apis
    - unawaited_futures
    - unnecessary_brace_in_string_interps
    - unnecessary_const
    - unnecessary_getters_setters
    - unnecessary_lambdas
    - unnecessary_new
    - unnecessary_null_checks
    - unnecessary_overrides
    - unnecessary_parenthesis
    - unnecessary_this
    - use_function_type_syntax_for_parameters
    - use_rethrow_when_possible
    - void_checks

运行Flutter Lint：

flutter pub run lint

使用Flutter formatter进行代码格式化

Flutter formatter是一个代码格式化工具，它可以帮助我们让Flutter代码更加一致。我们可以通过以下步骤使用Flutter formatter进行代码格式化：

安装Flutter formatter：

flutter pub global activate formatter

在项目根目录下创建.flutter-format文件，并写入以下内容：

version: 2
line_length: 80

运行Flutter formatter：

flutter pub run format

使用Sonarqube进行静态代码检查

Sonarqube是一个开源的代码质量管理工具，它可以帮助我们发现代码中的质量问题，包括代码风格问题、性能问题和安全问题。我们可以通过以下步骤使用Sonarqube进行静态代码检查：

安装Sonarqube：

wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.6.0.57114.zip
unzip sonarqube-9.6.0.57114.zip
mv sonarqube-9.6.0.57114 sonarqube

启动Sonarqube：

cd sonarqube/bin/linux-x86-64
./sonar.sh start

配置Sonarqube：

vi sonarqube/conf/sonar.properties

sonar.web.port=9000
sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonar
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
sonar.login=admin
sonar.password=admin

创建Flutter项目Sonarqube任务：

cd sonarqube/bin/linux-x86-64
./sonar-scanner \
  -Dsonar.projectKey=my-flutter-project \
  -Dsonar.sources=lib \
  -Dsonar.language=dart \
  -Dsonar.dart.sonarLint=true \
  -Dsonar.dart.sonarFormatter=true \
  -Dsonar.dart.flutterVersion=1.22.5