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