flutter guidelines下载 - flutter guidelines源代码下载

扑朔迷离的指南

你好！本文档包含我对应如何进行发展的政策，程序和标准的个人建议。

项目代码结构

项目代码应与文件夹和逐型文件夹的混合结构结构。

含义在根级别，您的文件夹定义功能。例如：

 |-- common/
|-- authentication/
|-- settings/

Common/Core功能包含默认情况下应在任何功能中可用的类，功能或小部件。

因此，这个想法是要使应用程序的功能除以顶级文件夹。

将每个顶级文件夹视为应用程序的单独飞镖/飞镖包，依赖关系或访问边界。

因此，如果您在通用文件夹中添加一些内容，则必须问自己，将需要99.％的功能吗？

如果您将其视为依赖性，则在您的pubspec.yaml中始终声明共同的依赖性。

因此，在将课程，功能或小部件添加到公共文件夹之前，请问自己：

是PubSpec.yaml中每个功能都需要的东西，还是更多的是可选的？
如果答案是肯定的，那么答案是否，如果答案是否，则比将其提取到另一个文件夹中。

在每个功能文件夹中，您的文件夹按类型定义。

这是将是功能文件夹的一部分的文件夹类型。

 |-- ui/
|-- cubits/
|-- domain_objects/
|-- exceptions/
|-- use_cases
|-- services/
|-- repositories/
|-- data_sources/
|-- dtos/

如果与单个文件有关的一个以上的文件，您可以将它们分组为文件夹，例如文件中的类生成代码。例如：

 |-- authentication/
|---- cubits/
|------ login/
|-------- login_cubit.dart
|-------- login_cubit.freezed.dart
|-------- login_cubit.g.dart

用户界面（UI）

与用户设备接口相关的代码，例如：UI PageBuilders，UI屏幕，UI视图，UI组件。

屏幕

屏幕是填充整个设备显示的用户界面组件，是用户界面视图或组件的容器（按钮，复选框，图像和ECT）。

另外，屏幕是一个特定的应用程序导航目的地。

指南：

屏幕名称和类应与屏幕相结合。
屏幕类应仅与Cubit类互动。
屏幕构建方法应划分为将其更新区域/用例分开的私人小部件。例如：

 class LoginScreen extends StatelessWidget {
  //...fields and constructor...
  @override
  Widget build ( BuildContext context) {
    return Column (
      children : < Widget > [
        _LoginLogo ,
        _LoginForm ,
        _LoginActions ,
        _LoginFooter
      ],
    );
  }
}

// extracted by use case.
class _LoginLogo extends StatelessWidget {}

// extracted by update area.
class _LoginForm extends StatefullWidget {}

// extracted by update area.
class _LoginActions extends StatelesssWidget {}

// extracted by update area.
class _LoginFooter extends StatelessWidget {}

提取到私人小部件后。如果屏幕文件的线路号大于400，则应将私有小部件移至零件文件。部分文件命名屏幕命名约定：$ {屏幕文件的名称} _components.dart。例如：

login_screen.dart

 part 'login_screen_components.dart' ;

class LoginScreen extends StatelessWidget {
  //...fields and constructor...
  @override
  Widget build ( BuildContext context) {
    return Column (
      children : < Widget > [
        _LoginLogo ,
        _LoginForm ,
        _LoginActions ,
        _LoginFooter
      ],
    );
  }
}

// Is kept here because it's does not break the 400 max line rule.
class _LoginLogo extends StatelessWidget {}

login_screen_components.dart

 part of 'login_screen.dart' ;

/// [LoginScreen] 's fields.
class _LoginForm extends StatelessWidget {}

// ************************ Footer ************************

/// [LoginScreen] 's footer.
class _LoginFooter extends StatelessWidget {}

// ************************* ACTIONS *********************************

/// [LoginScreen] 's actions.
class _LoginActions extends StatelessWidget {}

请勿将Cubit传递给屏幕构造函数，而是使用BlocBuilder，Bloclistener或Blocconsumer访问它们。例如：

 class LoginScreen extends StatelessWidget {
  @override
  Widget build ( BuildContext context) {
    return BlocBuilder < LoginCubit , LoginCubitState >(
      // Here cubit is not specified either.
      builder : ( BuildContext context, LoginCubitState state) {},
    );
  }
}

使用私人小部件类代替函数来构建子树，例如：

 class SomeWidget extends StatelessWidget {
  @override
  Widget build ( BuildContext context) {
    //...
  }
}

class _SubTree1 extends StatelessWidget {}

class _SubTree2 extends StatelessWidget {}

class _SubTree3 extends StatelessWidget {}

class _SubTree4 extends StatelessWidget {}

屏幕操作/事件回调应作为屏幕类的一部分。
- 操作/事件回调方法应以前缀开头。
- 操作/事件的名称应与其用例相匹配。例如：

 class LoginScreen extends StatelessWidget {
  @override
  Widget build ( BuildContext context) {
    return Column (
      childreen : < Widget > [
        Button1 (onClick : _openRegisterUser),
        Button2 (onClick : _openLogin),
        Field (onTextChanged : _onUserNameTextChanged),
      ],
    );
  }
  
  void _openRegisterUser () {}
  
  void _openLogin () {}
  
  void _onUserNameTextChanged ( String newText) {}
}

UI视图

视图是一个不填充整个设备显示的用户界面组件，并且是用户界面视图或组件的容器（按钮，复选框，图像和ECT）。

另外，视图不是应用程序导航目的地。

指南：

查看文件名和类应与视图相结合。
查看类仅应与CUBIT类互动。
屏幕构建方法应划分为将其更新区域/用例分开的私人小部件。例如：

肘

Cubits是包含UI业务逻辑的类，Cubit绑定到代表UI状态的状态。

指南建议：

仅涵盖UI所需的业务逻辑。
返回公共行为的期货。
仅与高级类互动，含义：用例。
返回最终动作结果给呼叫者。例如：

 Future < String ?> bookAppointment ( BookingData booking);

Future < bool > login ( String username, String password);

仅使用存储库，服务接口而不是具体实现。
用cubit，示例logincubit的后缀。
Cubit类文件应在该功能的Cubits文件夹下。

Cubit的状态。

CUBIT状态类代表UI的状态与给定时间界定。

指南建议：

使用单个类进行状态或定义基类并为每个状态定义子类。
最终动作结果不应成为国家的一部分。例如：

 class LoginState {
  bool logginSuceeded // avoid this.
}

将类放在同一文件中是定义CUBIT类。

用例

用于在您的域中制作单个业务操作/目标/工作/任务的类。

指南：

用户酶的名称应始终具有一个前缀，该前缀应该是一个动词，它描述了该类所做的工作。例如： class GetCurrentUserUseCase ， class SignInUseCase ；
用户酶的名称应始终具有后缀UseCase ；
Usecase类应始终具有公共函数call() ，其中返回类型是执行用例的结果；
用户酶应该仅访问Repositories ， Services或任何其他high level coordinators ；
用户酶不应访问DataSource或Cubit或与DTO或任何其他低级对象进行交互；
用户酶应在Cubit或其他UseCases中使用。

示例：

 class GetCurrentUserUseCase {
	final UserRepository _repository;
	const GetCurrentUserUseCase ( this ._repository);
	Future < User ?> call () async {
		await _repository. getCurrentUser ();
	}
}

 class AuthenticateMemberUseCase {
  /// Create a [AuthenticateMemberUseCase] .
  const AuthenticateMemberUseCase (
    /* constructor arguments */
  );

  /* ... fields ...*/

  /// Execute the use case.
  Future < TegTask < void >> call ( MemberAuthenticationCredentials credentials) {
    return runTaskSafelyAsync < void >(() async {
      final bool isEmailValid = credentials.email.isEmail;

      if ( ! isEmailValid) {
        throw const TegEmailInvalidException ();
      }
      
      final bool isConnected = await _hostDeviceInternetService. isConnected ();

      if ( ! isConnected) {
        throw const TegInternetUnavailableException ();
      }

      final String ? deviceId = await _hostDeviceInfoRepository. getDeviceId ();

      if (deviceId == null ) {
        throw const TegDeviceIdUnavailableException ();
      }

      final PublicPrivateKeyPair keyPair = await _keyGenerator. generate ();

      final Member member = await _authService. signIn (
        email : credentials.email,
        password : credentials.password,
        deviceId : deviceId,
        publicKey : keyPair.publicKey,
      );

      await _updateCurrentMemberUseCase (
        member : member,
        memberPrivateKey : keyPair.privateKey,
        deviceId : deviceId,
      );

      await _saveMemberAuthenticationCredentialsUseCase (credentials);

      final TegTask < List < Account >> memberAccountsTask = await _getMemberAccountsUseCase ();

      if (memberAccountsTask.failed) {
        throw memberAccountsTask.exception;
      }

      await _updateMemberCurrentAccountUseCase (
        member : member,
        deviceId : deviceId,
        memberPrivateKey : keyPair.privateKey,
        account : memberAccountsTask.result.first,
      );
    });
  }
}

存储库

仅使用CRUD操作提供特定功能或功能范围的CRUD操作的类，例如：

 abstract class BookingRepository {
  Futute < Booking > getBookingById ( String id);

  Future < List < Booking >> getBookings ();

  Future < void > deleteBookingById ( String id);

  Future < void > saveBooking ( Booking booking);
}

指南建议：

带有存储库的后缀类名称。
仅定义功能或功能范围的存储库，然后将其命名。
使用存储库来提供对数据并操纵数据的访问。
存储库应协调数据源之间的访问权限，或者确定例如通过功能标志使用的数据源。例子：

 class DefaultBookingRepository implements BookingRepository {
  final LocalBookingDataSource local;
  final RemoteBookingDataSource remote;

  Future < Booking ?> getBookingById ( String id) async {
    Booking ? savedBooking = await local. getBookingById (id);

    if (savedBooking == null ) {
      Booking ? remoteBooking = await remote. getBookingById (id);

      if (remoteBooking != null ) {
        await local. saveBooking (remoteBooking);
      }
      return remoteBooking;
    }
    return savedBooking;
  }

//...other operations...
}

按类型定义存储库API和具体实现的接口，例如：

界面

 abstract class BookingRepository {}

实施

 class DefaultBookingRepository implements BookingRepository {}

class AnonymousBookingRepository implements BookingRepository {}

class PremiumBookingRepository implements BookingRepository {}

请勿使用工具，与平台相关的库或在存储库中执行网络逻辑，而将其封装在数据源中。
仅在存储库中使用数据源。
仅作为输入原始或域对象和输出域对象接收。
存储库API的实现应命名为“存储库类名称”后缀。
避免使用默认的前缀 +基本存储库名称命名使用SPREM后缀命名存储库。
返回公共API（未来或流）的异步类型。
存储库的实现不应更改其公共API（返回类型，方法参数）。
存储库类文件应在该功能的“存储库”文件夹下。

服务

类别提供特定功能或功能范围的功能的类，例如：

 abstract class AuthenticationService {
  Future < void > authenticate ( String username, String password);

//...other functionalities...
}

abstract class AppointmentService {
  Future < void > register ( Appointment appointment);

//...other functionalities...
}

指南建议。

带有服务的后缀类名称。
仅定义功能或功能范围的服务，然后将其命名。
使用服务提供实施业务逻辑所需的功能。
使用数据源来访问实现功能业务逻辑所需的数据。
请勿使用工具，与平台相关的库或在服务中执行网络逻辑，而请在数据源中实现它。
仅使用服务中的数据源。
仅作为输入原始或域对象和输出域对象接收。
服务API的实现应命名为“服务类名称”后缀。
避免使用默认的后缀命名服务，请使用默认前缀 +基本服务名称命名。
返回公共API（未来或流）的异步类型。
服务的实施不应更改其公共API（返回类型，方法参数）。
服务类文件应在该功能的服务文件夹下。

数据源

类实现对本地或远程数据的数据的访问。例子

 abstract class LocalBookingDataSource {
  Futture < void > saveBooking ( Booking booking);

//...other functionalities...
}

abstract class RemoteBookingDataSource {
  Future <booking> saveBooking ();
}

指南建议：

将数据源的基本类型保留到本地和远程。
名称在库或使用工具之后实现，并将数据源名称作为后缀，例如：

 class SQLiteBookingDataSource implements LocalBookingDataSource {
  //...............Implementation................
}

class RestApiBookingDataSource implements RemoteBookingDataSource {
  //...............Implementation................
}

class MemoryBookingDataSource implements LocalBookingDataSource {
  //...............Implementation................
}

处理数据源中的库或工具错误，然后将其转换为App自定义异常。
仅作为输入原始或域对象和输出域对象或原始接收。
数据源API的实现应以数据源类名称为后缀命名。
返回公共API（未来或流）的异步类型。
数据源的实现不应更改其公共API（返回类型，方法参数）。
数据源类文件应在该功能的数据源文件夹下。

数据传输对象-DTO

数据传输对象 - 用于将数据从一个系统传输到另一个系统。例子

 class ApiRequest {
  //...fields...
}

class ApiResponse {
  //...fields...
}

 class SQLiteTableDefinition {
  //...fields...
}

指南：

使用DTO表示数据库表。
使用DTO表示API请求和响应。
使用DTO实现库所需的数据。例如，要使用持久性库您的数据需要扩展对象或添加更多字段，而是创建DTO。
例如，在DTO类中实现映射器。

 class ApiRequest {
  //...fields...

  factory ApiRequest . fromDO ( DOObject doObject) {
    //...mapper code...
  }

  DOObject toDO () {
    //...mapper code...
  }
}

请勿在DTO中实现保存或获取逻辑，而请在数据源中实现。
DTO类文件应位于功能的DTO文件夹下。

域对象

域对象是业务一部分或其中一部分的数据类表示，它们用于独立于平台，图书馆或工具来执行业务逻辑。

域对象可以代表一个人，地点，事件，业务流程或概念以及发票，产品，交易甚至人的详细信息。

指南：

域对象类名称应与DO相结合。
域对象类仅应包含格式数据字段的数据字段或方法。
域对象类应实现fromjson和Tojson的平等和哈希代码方法。
域对象类字段类型仅应为原始或其他域对象。
域对象类文件应在该功能的domain_objects文件夹下。

如何结构资产

与项目代码结构相同。

首先是功能名称，然后是包含文件的assets文件夹。

例子：

 |-- authentication/
|---- assets/
|------ password_hidden_icon.svg
|------ forget_password_icon.svg
|------ background.png

展开

flutter guidelines

扑朔迷离的指南

项目代码结构

用户界面（UI）

屏幕

UI视图

肘

Cubit的状态。

用例

存储库

服务

数据源

数据传输对象-DTO

域对象

如何结构资产

pixez flutter

ApnaChat Realtime Chat App In Flutter Firebase

flutter_downloader

flutter_3d_controller

flutter_voice_friend

颤动炸弹

chat.petals.dev

GPT Prompt Templates

GPTyped

Google Dorks

shepherd

mongo express

Google Dorks

shepherd

mongo express