Flutter代码规范与约定插件glory_convention_lint的使用

GloryConventionLint-Flutter

GloryConventionLint是支持IDE Android Studio/Visual Studio Code的Flutter代码规范检查插件。

Setup

添加插件到pubspec.yaml

$ flutter pub add --dev glory_convention_lint

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

dev_dependencies:
  glory_convention_lint: ^1.0.0
  custom_lint: ^0.2.5

添加分析器插件到analysis_options.yaml

在analysis_options.yaml文件中添加以下内容：

analyzer:
  plugins:
    - custom_lint

规范

模型规范

模型类名规范

确保模型类名以Model结尾。

// 正确
class ProductModel {}

// 错误
class ProductModel {}

模型文件名规范

模型文件名必须以_model.dart结尾。

// 正确
product_model.dart

// 错误
product.dart
productmodel.dart

模型注解规范

在模型类前添加@JsonSerializable()注解。

// 正确
@JsonSerializable()
class ProductModel {
  int? id;
}

// 错误
class ProductModel {
  int? id;
}
@JsonSerializable()

建议模型字段使用可空类型

建议模型字段使用可空类型，例如String?而不是String。

// 正确
class Product {
  String? name;
  Product({this.name});
}

// 错误
class Product {
  String name;
  Product({this.name});
}

服务规范

服务类名规范

确保服务类名以Services结尾。

// 正确
class GiftServices{}
class ProductServices{}

// 错误
class Gift{}
class ProductService{} // 单数而非复数

服务文件名规范

服务文件名必须以service.dart结尾。

// 正确
gift_services.dart
product_services.dart

// 错误
product_service.dart // 单数而非复数
ProductRequest.dart

服务注解规范

在服务类前添加@RestApi()注解。

// 正确
@RestApi() // 添加了RestApi注解
abstract class ProductServices {}

// 错误
// 忘记添加RestApi注解
abstract class ProductServices {}

枚举规范

枚举类名规范

确保枚举类名以Enum结尾。

// 正确
enum AvatarEnum {}

// 错误
enum EnumAvatar {}

枚举文件名规范

确保枚举文件名以_enum.dart结尾。

// 正确
gift_enum.dart
product_enum.dart

// 错误
ProductEnum.dart

请求规范

请求类名规范

请求类名总是以Request结尾，并且必须使用PascalCase。

// 正确
class GiftRequest{}
class ProductRequest{}

// 错误
class Gift{}
class product_request{}

请求文件名规范

请求文件名必须以_request结尾，并且必须使用snake_case。

// 正确
product_request.dart

// 错误
ProductRequest.dart

请求文件必须放在request目录下。

|- data
  |- network
    |- request

响应规范

响应类名规范

响应类名总是以Response结尾，并且必须使用PascalCase。

// 正确
class GiftResponse{}
class ProductResponse{}

// 错误
class Gift{}
class product_response{}

响应文件名规范

响应文件名必须以_response结尾，并且必须使用snake_case。

// 正确
product_response.dart

// 错误
ProductResponse.dart

响应文件必须放在response目录下。

|- data
  |- network
    |- response

其他规范

命名规范

单个文件只包含一个类的规范

避免在一个文件中声明多个类。最好每个文件只声明一个类，以减少混淆。

// 正确
-- test.dart --
class One {}

// 错误
-- test.dart --
class One {}
class Two {}

静态常量语言变量规范

变量应声明为静态常量。

// 正确
class One {
  static const variableOne = "Value";
}

// 错误
class One {
  String variableOne = "Value";
}

基础响应导入规范

BaseResponse和BaseListResponse必须从rollingglory_codebase导入。

当应用程序通过API调用与后端通信时，我们通常会收到两种类型的响应：单个对象和多个对象。这两种类型都需要在服务文件中实现，服务文件实际上是一个抽象类，包含了获取数据所需的一组方法。

// 正确
class One {
  Future<BaseListResponse<Episode>> getEpisodes();
  Future<BaseResponse<Episode>> getEpisodeDetail();
}

// 错误
class One {
  Future<Episode> myMethod();
}

一个类只有一个语言变量规范

确保表示语言的变量被分开，一个类应该只有一个变量。

// 正确
-- languages/id_lang.dart --
Map<String, String> id = {};

-- languages/en_lang.dart --
Map<String, String> en = {};

// 错误
-- languages.dart --
Map<String, String> id = {};
Map<String, String> en = {};