Flutter开源项目 - appFlowy 真的是 Notion 的替代品? 一周暴涨 star 9k 多!

·  阅读 29070
Flutter开源项目 - appFlowy 真的是 Notion 的替代品? 一周暴涨 star 9k 多!

视频

www.bilibili.com/video/BV1Cr…

git

www.appflowy.io/

github.com/AppFlowy-IO…

也就 1 周 star 9.8k,我以为他是刷的。

目标&特色

  • 目标替代 Notion

  • 数据 100% 自己管理

  • 开源方式提供,你可以自己改

  • 多平台支持

  • 原生体验,估计是用了 flutter 关系

编译运行

    1. git clone
git clone https://github.com/AppFlowy-IO/appflowy.git
复制代码
    1. 安装 rust

cd appflowy/frontend

make install_rust

source $HOME/.cargo/env

make install_cargo_make

cargo make install_targets

复制代码
    1. 切换 flutter dev
flutter channel dev

or

fvm use dev
fvm global dev

复制代码
    1. flutter 启用 desktop
# for windows
flutter config --enable-windows-desktop

# for macos
flutter config --enable-macos-desktop

# for linux
flutter config --enable-linux-desktop
复制代码
    1. 用 vscode 或者其它 idea 打开
open appflowy/frontend
复制代码

代码架构

  • 技术选型

    • flutter: 多端适配

    • rust: ffi 平台接口、服务端

  • flutter 端 frontend/app_flowy

  • 前端业务 rust 层 frontend/rust-lib

  • 共享库 shared-lib shared-lib

  • 后端 rust api backend

参阅技术说明 doc

  • 系统设计说明 doc/APPFLOWY_SYSTEM_DESIGN.md
                        Frontend                                                     FLowySDK
                                                             │                                              ┌─────────┐
                                                             │                                          ┌7─▶│Handler A│
                                                             │                                          │   └─────────┘
                                                             │                             ┌─────────┐  │   ┌─────────┐
┌──────┐    ┌────┐    ┌──────────────┐                       │                        ┌───▶│Module A │──┼──▶│Handler B│
│Widget│─1─▶│Bloc│─2─▶│ Repository A │─3─┐                   │                        │    └─────────┘  │   └─────────┘
└──────┘    └────┘    └──────────────┘   │                   │                        │                 │   ┌─────────┐
                      ┌──────────────┐   │    ┌───────┐    ┌─┴──┐     ┌───────────┐   │    ┌─────────┐  └──▶│Handler C│
                      │ Repository B │───┼───▶│ Event │─4─▶│FFI │─5──▶│Dispatcher │─6─┼───▶│Module B │      └─────────┘
                      └──────────────┘   │    └───────┘    └─┬──┘     └───────────┘   │    └─────────┘
                      ┌──────────────┐   │                   │                        │
                      │ Repository C │───┘                   │                        │    ┌─────────┐
                      └──────────────┘                       │                        └───▶│Module C │
                                                             │                             └─────────┘
                                                             │
                                                             │
复制代码

Here are the event flow:

  1. User click on the Widget(The user interface) that invokes the Bloc actions
  2. Bloc calls the repositories to perform additional operations to handle the actions.
  3. Repository offers the functionalities by combining the event, defined in the FlowySDK.
  4. Events will be passed in the FlowySDK through the FFI interface.
  5. Dispatcher parses the event and generates the specific action scheduled in the FlowySDK runtime.
  6. Dispatcher find the event handler declared by the modules.
  7. Handler consumes the event and generates the response. The response will be returned to the widget through the FFI.

The event flow will be discussed in two parts: the frontend implemented in flutter and the FlowySDK implemented in Rust.

  • linux 编译说明 doc/BUILD_ON_LINUX.md

  • windows 编译说明 doc/BUILD_ON_WINDOWS.md

  • 贡献参与说明 doc/CONTRIBUTING.md

  • DDD 设计说明 doc/DOMAIN_DRIVEN_DESIGN.md

    ┌──────────────────────────────────────────────────┐         ─────────▶
    │                Presentation Layer                │──┐      Dependency
    └──────────────────────────────────────────────────┘  │
                              │                           │
                              ▼                           │
    ┌──────────────────────────────────────────────────┐  │
    │                Application Layer                 │  │
    └──────────────────────────────────────────────────┘  │
                              │                           │
                              ▼                           │
    ┌──────────────────────────────────────────────────┐  │
    │                   Domain Layer                   │◀─┘
    └──────────────────────────────────────────────────┘
                              ▲
                              │
    ┌──────────────────────────────────────────────────┐
    │               Infrastructure Layer               │
    └──────────────────────────────────────────────────┘
复制代码

Presentation Layer:

  • Responsible for presenting information to the user and interpreting user commands.
  • Consists of Widgets and also the state of the Widgets.

Application Layer:

  • Defines the jobs the software is supposed to do. (Shouldn't find any UI code or network code)
  • Coordinates the application activity and delegates work to the next layer down.
  • It doesn't contain any complex business logic but the basic validation on the user input before passing to the other layer.

Domain Layer:

  • Responsible for representing concepts of the business.
  • Manages the business state or delegated to the infrastructure layer.
  • Self contained and it doesn't depend on any other layers. Domain should be well isolated from the other layers.

Infrastructure Layer:

  • Provides generic technical capabilities that support the higher layers. It deals with APIs, persistence and network, etc.
  • Implements the repository interface and hiding the complexity of the Domain layer.
  • 编辑器 doc/EDITOR.md

  • roadmap

trello.com/b/NCyXCXXh/…

看看本地文件在哪里

  • 找到 sqlite

  • 搜索本地
find ~ -iname 'flowy-database.db'

~/Library/Containers/com.appflowy.macos/Data/Documents/flowy/fd3ada7d-7653-4196-90e1-7de0019627bc/flowy-database.db
复制代码

flutter 插件

  • flutter-quill

github.com/singerdmx/f…

富文本编辑器

  • freezed

pub.flutter-io.cn/packages/fr…

数据 model 生成器,支持注解方式

  • flutter_colorpicker

pub.flutter-io.cn/packages/fl…

颜色选取工具

  • styled_widget

pub.flutter-io.cn/packages/st…

简化小组件定义

Icon(OMIcons.home, color: Colors.white)
  .padding(all: 10)
  .decorated(color: Color(0xff7AC1E7), shape: BoxShape.circle)
  .padding(all: 15)
  .decorated(color: Color(0xffE8F2F7), shape: BoxShape.circle)
  .padding(all: 20)
  .card(
    elevation: 10,
    shape: RoundedRectangleBorder(
      borderRadius: BorderRadius.circular(20),
    ),
  )
  .alignment(Alignment.center)
  .backgroundColor(Color(0xffEBECF1));
复制代码
  • get_it

pub.flutter-io.cn/packages/ge…

全局访问你的业务对象,你可以拆分业务和 UI

// 定义

final getIt = GetIt.instance;

void setup() {
  getIt.registerSingleton<AppModel>(AppModel());

// Alternatively you could write it if you don't like global variables
  GetIt.I.registerSingleton<AppModel>(AppModel());
}

// 使用

MaterialButton(
  child: Text("Update"),
  onPressed: getIt<AppModel>().update   // given that your AppModel has a method update
),

复制代码

总结

  • 看到人家的架构,感觉自己弱爆了,我还是先领域分层设计做做干净
  • flutter bloc , rust ffi web protobuf 感觉还是成熟的选择
  • 如果持续更新的话,我也很想看看架构的演变
  • 现阶段估计还是在测试架构设计,应该不会上很多功能

© 猫哥

分类:
前端
标签:
分类:
前端
标签:
收藏成功!
已添加到「」, 点击更改