From 6ed2d05a15f814b929624071ddd06ab3a8fbe47c Mon Sep 17 00:00:00 2001 From: Arvin Xu Date: Mon, 22 Jan 2024 23:50:53 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs:=20add=20a=20document=20of?= =?UTF-8?q?=20how=20to=20implement=20a=20complete=20feature=20(#1120)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Create Database.zh-CN.md * Update Database.zh-CN.md * 📝 docs: update docs * Update Database.zh-CN.md --- docs/Development/Database.zh-CN.md | 160 ++++++++++++++++++ .../State-Management-Intro.md | 0 .../State-Management-Intro.zh-CN.md | 18 +- ...ctors.md => State-Management-Selectors.md} | 0 ...md => State-Management-Selectors.zh-CN.md} | 0 5 files changed, 169 insertions(+), 9 deletions(-) create mode 100644 docs/Development/Database.zh-CN.md rename docs/Development/{State-Management => }/State-Management-Intro.md (100%) rename docs/Development/{State-Management => }/State-Management-Intro.zh-CN.md (95%) rename docs/Development/{State-Management/Selectors.md => State-Management-Selectors.md} (100%) rename docs/Development/{State-Management/Selectors.zh-CN.md => State-Management-Selectors.zh-CN.md} (100%) diff --git a/docs/Development/Database.zh-CN.md b/docs/Development/Database.zh-CN.md new file mode 100644 index 0000000000000..3a450585ab6dd --- /dev/null +++ b/docs/Development/Database.zh-CN.md @@ -0,0 +1,160 @@ +以 sessionGroup 的实现为例：[✨ feat: add session group manager](https://github.com/lobehub/lobe-chat/pull/1055) . 介绍完整实现流程。 + + +## 数据库部分 + + +定义一个新的 sessionGroup 表，分 4 步： + +1. 建立数据模型 schema + +schema/sessionGroup.ts + +```ts +import { z } from 'zod'; + +export const DB_SessionGroupSchema = z.object({ + name: z.string(), + sort: z.number(), +}); + +export type DB_SessionGroup = z.infer; + +``` + +2. 创建数据库索引 + +```diff +// ... 前面的一些实现 + +// ************************************** // +// ******* Version 3 - 2023-12-06 ******* // +// ************************************** // +// - Added `plugin` table + +export const dbSchemaV3 = { + ...dbSchemaV2, + plugins: + '&identifier, type, manifest.type, manifest.meta.title, manifest.meta.description, manifest.meta.author, createdAt, updatedAt', +}; + ++ // ************************************** // ++ // ******* Version 4 - 2024-01-21 ******* // ++ // ************************************** // ++ // - Added `sessionGroup` table + ++ export const dbSchemaV4 = { ++ ...dbSchemaV3, ++ sessionGroups: '&id, name, sort, createdAt, updatedAt', +}; + +``` + +3. 在 db 中加入 sessionGroups 表 + +```diff + +import { dbSchemaV1, dbSchemaV2, dbSchemaV3, dbSchemaV4 } from './schemas'; + +interface LobeDBSchemaMap { + files: DB_File; + messages: DB_Message; + plugins: DB_Plugin; ++ sessionGroups: DB_SessionGroup; + sessions: DB_Session; + topics: DB_Topic; +} + +// Define a local DB +export class LocalDB extends Dexie { + public files: LobeDBTable<'files'>; + public sessions: LobeDBTable<'sessions'>; + public messages: LobeDBTable<'messages'>; + public topics: LobeDBTable<'topics'>; + public plugins: LobeDBTable<'plugins'>; ++ public sessionGroups: LobeDBTable<'sessionGroups'>; + + constructor() { + super('LOBE_CHAT_DB'); + this.version(1).stores(dbSchemaV1); + this.version(2).stores(dbSchemaV2); + this.version(3).stores(dbSchemaV3); ++ this.version(4).stores(dbSchemaV4); + + this.files = this.table('files'); + this.sessions = this.table('sessions'); + this.messages = this.table('messages'); + this.topics = this.table('topics'); + this.plugins = this.table('plugins'); ++ this.sessionGroups = this.table('sessionGroups'); + } +} +``` + +5. 定义 Model + +model/sessionGroup.ts + +```ts +import { BaseModel } from '@/database/core'; +import { DB_SessionGroup, DB_SessionGroupSchema } from '@/database/schemas/sessionGroup'; +import { nanoid } from '@/utils/uuid'; + +class _SessionGroupModel extends BaseModel { + constructor() { + super('sessions', DB_SessionGroupSchema); + } + + async create(name: string, sort?: number, id = nanoid()) { + return this._add({ name, sort }, id); + } + + async update(id: string, data: Partial) { + return super._update(id, data); + } +} + +export const SessionModel = new _SessionGroupModel(); +``` + +6. 按需在 Model 中实现功能逻辑 + + +## Service 部分 + +在 sessionService 中实现，关于会话 Session 的领域会更加内聚 + +```ts +class SessionService { + + // ... 前面为 session 的实现 + + // ************************************** // + // *********** SessionGroup *********** // + // ************************************** // + + async createSessionGroup(name: string, sort?: number) { + const item = await SessionGroupModel.create(name, sort); + if (!item) { + throw new Error('session group create Error'); + } + + return item.id; + } + + async batchCreateSessionGroups(groups: SessionGroups) { + return SessionGroupModel.batchCreate(groups); + } + + async removeSessionGroup(id: string, removeChildren?: boolean) { + return SessionGroupModel.delete(id, removeChildren); + } + + async updateSessionGroup(id: string, data: Partial) { + return SessionGroupModel.update(id, data); + } + +} +``` + + diff --git a/docs/Development/State-Management/State-Management-Intro.md b/docs/Development/State-Management-Intro.md similarity index 100% rename from docs/Development/State-Management/State-Management-Intro.md rename to docs/Development/State-Management-Intro.md diff --git a/docs/Development/State-Management/State-Management-Intro.zh-CN.md b/docs/Development/State-Management-Intro.zh-CN.md similarity index 95% rename from docs/Development/State-Management/State-Management-Intro.zh-CN.md rename to docs/Development/State-Management-Intro.zh-CN.md index 9fdd53a37e6c1..5310cb096b45a 100644 --- a/docs/Development/State-Management/State-Management-Intro.zh-CN.md +++ b/docs/Development/State-Management-Intro.zh-CN.md @@ -125,16 +125,16 @@ src/store/session ├── helpers.ts # 辅助函数 └── slices # 各个独立的功能切片    ├── agent # 助理 Slice -    │   ├── action.ts -    │   ├── index.ts -    │   └── selectors.ts +    │   ├── action.ts +    │   ├── index.ts +    │   └── selectors.ts    └── session # 会话 Slice -       ├── action.ts -       ├── helpers.ts -       ├── initialState.ts -       └── selectors -          ├── export.ts -          ├── list.ts +       ├── action.ts +       ├── helpers.ts +       ├── initialState.ts +       └── selectors +          ├── export.ts +          ├── list.ts          └── index.ts ``` diff --git a/docs/Development/State-Management/Selectors.md b/docs/Development/State-Management-Selectors.md similarity index 100% rename from docs/Development/State-Management/Selectors.md rename to docs/Development/State-Management-Selectors.md diff --git a/docs/Development/State-Management/Selectors.zh-CN.md b/docs/Development/State-Management-Selectors.zh-CN.md similarity index 100% rename from docs/Development/State-Management/Selectors.zh-CN.md rename to docs/Development/State-Management-Selectors.zh-CN.md