🧑‍💻 Add onDataChanged method to handle data changes in the plugin (#16244)

TCOTC · web-flow · commit 9bfe00cf10e5 · 2025-11-25T16:49:22.000+08:00
diff --git a/app/src/config/bazaar.ts b/app/src/config/bazaar.ts
@@ -743,7 +743,8 @@ export const bazaar = {
                                     app.plugins.find((item: Plugin) => {
                                         if (item.name === dataObj.name) {
                                             reloadPlugin(app, {
-                                                upsertPlugins: [dataObj.name],
+                                                upsertCodePlugins: [dataObj.name],
+                                                upsertDataPlugins: [],
                                                 removePlugins: []
                                             });
                                             return true;
diff --git a/app/src/plugin/index.ts b/app/src/plugin/index.ts
@@ -113,6 +113,10 @@ export class Plugin {
         // 卸载
     }
 
+    public onDataChanged() {
+        // 存储数据变更
+    }
+
     public async updateCards(options: ICardData) {
         return options;
     }
diff --git a/app/src/plugin/loader.ts b/app/src/plugin/loader.ts
@@ -210,20 +210,48 @@ export const afterLoadPlugin = (plugin: Plugin) => {
     /// #endif
 };
 
-export const reloadPlugin = async (app: App, data: { upsertPlugins: string[], removePlugins: string[] }) => {
-    data.removePlugins.forEach((item) => {
+export const reloadPlugin = async (app: App, data: { upsertCodePlugins?: string[], upsertDataPlugins?: string[], removePlugins?: string[] } = {}) => {
+    const { upsertCodePlugins = [], upsertDataPlugins = [], removePlugins = [] } = data;
+    const reloadPlugins: string[] = [];
+
+    removePlugins.forEach((item) => {
         uninstall(app, item, true);
     });
-    data.upsertPlugins.forEach((item) => {
-        uninstall(app, item, false);
+
+    upsertCodePlugins.forEach((pluginName) => {
+        reloadPlugins.push(pluginName);
     });
-    loadPlugins(app, data.upsertPlugins).then(() => {
-        app.plugins.forEach(item => {
-            if (data.upsertPlugins.includes(item.name)) {
-                afterLoadPlugin(item);
+
+    upsertDataPlugins.forEach((pluginName) => {
+        const plugin = app.plugins.find(p => p.name === pluginName);
+        // 检查插件是否重写了 onDataChanged 方法（不是基类的默认实现）
+        const hasOverriddenOnDataChanged = plugin && 
+            typeof plugin.onDataChanged === "function" && 
+            plugin.onDataChanged !== Plugin.prototype.onDataChanged;
+        if (hasOverriddenOnDataChanged) {
+            try {
+                plugin.onDataChanged();
+                return;
+            } catch (e) {
+                console.error(`plugin ${pluginName} onDataChanged error:`, e);
             }
-        });
+        }
+        reloadPlugins.push(pluginName);
     });
+
+    reloadPlugins.forEach((item) => {
+        uninstall(app, item, false);
+    });
+    if (reloadPlugins.length > 0) {
+        loadPlugins(app, reloadPlugins).then(() => {
+            app.plugins.forEach(item => {
+                if (reloadPlugins.includes(item.name)) {
+                    afterLoadPlugin(item);
+                }
+            });
+        });
+    }
+
     /// #if !MOBILE
     saveLayout();
     /// #endif
diff --git a/kernel/api/petal.go b/kernel/api/petal.go
@@ -67,10 +67,10 @@ func setPetalEnabled(c *gin.Context) {
 		app = arg["app"].(string)
 	}
 	if enabled {
-		upsertPluginSet := hashset.New(packageName)
-		model.PushReloadPlugin(upsertPluginSet, nil, app)
+		upsertPluginCodeSet := hashset.New(packageName)
+		model.PushReloadPlugin(upsertPluginCodeSet, nil, nil, app)
 	} else {
 		removePluginSet := hashset.New(packageName)
-		model.PushReloadPlugin(nil, removePluginSet, app)
+		model.PushReloadPlugin(nil, nil, removePluginSet, app)
 	}
 }
diff --git a/kernel/model/bazzar.go b/kernel/model/bazzar.go
@@ -257,7 +257,7 @@ func UninstallBazaarPlugin(pluginName, frontend string) error {
 	savePetals(petals)
 
 	removePluginSet := hashset.New(pluginName)
-	pushReloadPlugin(nil, removePluginSet, "")
+	PushReloadPlugin(nil, nil, removePluginSet, "")
 	return nil
 }
 
diff --git a/kernel/model/push_reload.go b/kernel/model/push_reload.go
@@ -38,15 +38,38 @@ import (
 	"github.com/siyuan-note/siyuan/kernel/util"
 )
 
-func PushReloadPlugin(upsertPluginSet, removePluginNameSet *hashset.Set, excludeApp string) {
-	pushReloadPlugin(upsertPluginSet, removePluginNameSet, excludeApp)
-}
+func PushReloadPlugin(upsertCodePluginSet, upsertDataPluginSet, removePluginNameSet *hashset.Set, excludeApp string) {
+	if nil != removePluginNameSet {
+		for _, n := range removePluginNameSet.Values() {
+			pluginName := n.(string)
+			// 如果插件在 removePluginSet 中，从其他集合中移除
+			if nil != upsertCodePluginSet {
+				upsertCodePluginSet.Remove(pluginName)
+			}
+			if nil != upsertDataPluginSet {
+				upsertDataPluginSet.Remove(pluginName)
+			}
+		}
+	}
+	if nil != upsertCodePluginSet {
+		for _, n := range upsertCodePluginSet.Values() {
+			pluginName := n.(string)
+			// 如果插件在 upsertCodePluginSet 中，从 upsertDataPluginSet 中移除
+			if nil != upsertDataPluginSet {
+				upsertDataPluginSet.Remove(pluginName)
+			}
+		}
+	}
 
-func pushReloadPlugin(upsertPluginSet, removePluginNameSet *hashset.Set, excludeApp string) {
-	upsertPlugins, removePlugins := []string{}, []string{}
-	if nil != upsertPluginSet {
-		for _, n := range upsertPluginSet.Values() {
-			upsertPlugins = append(upsertPlugins, n.(string))
+	upsertCodePlugins, upsertDataPlugins, removePlugins := []string{}, []string{}, []string{}
+	if nil != upsertCodePluginSet {
+		for _, n := range upsertCodePluginSet.Values() {
+			upsertCodePlugins = append(upsertCodePlugins, n.(string))
+		}
+	}
+	if nil != upsertDataPluginSet {
+		for _, n := range upsertDataPluginSet.Values() {
+			upsertDataPlugins = append(upsertDataPlugins, n.(string))
 		}
 	}
 	if nil != removePluginNameSet {
@@ -55,22 +78,24 @@ func pushReloadPlugin(upsertPluginSet, removePluginNameSet *hashset.Set, exclude
 		}
 	}
 
-	pushReloadPlugin0(upsertPlugins, removePlugins, excludeApp)
+	pushReloadPlugin0(upsertCodePlugins, upsertDataPlugins, removePlugins, excludeApp)
 }
 
-func pushReloadPlugin0(upsertPlugins, removePlugins []string, excludeApp string) {
-	logging.LogInfof("reload plugins [upserts=%v, removes=%v]", upsertPlugins, removePlugins)
+func pushReloadPlugin0(upsertCodePlugins, upsertDataPlugins, removePlugins []string, excludeApp string) {
+	logging.LogInfof("reload plugins [codeChanges=%v, dataChanges=%v, removes=%v]", upsertCodePlugins, upsertDataPlugins, removePlugins)
 	if "" == excludeApp {
 		util.BroadcastByType("main", "reloadPlugin", 0, "", map[string]interface{}{
-			"upsertPlugins": upsertPlugins,
-			"removePlugins": removePlugins,
+			"upsertCodePlugins": upsertCodePlugins,
+			"upsertDataPlugins": upsertDataPlugins,
+			"removePlugins":     removePlugins,
 		})
 		return
 	}
 
 	util.BroadcastByTypeAndExcludeApp(excludeApp, "main", "reloadPlugin", 0, "", map[string]interface{}{
-		"upsertPlugins": upsertPlugins,
-		"removePlugins": removePlugins,
+		"upsertCodePlugins": upsertCodePlugins,
+		"upsertDataPlugins": upsertDataPlugins,
+		"removePlugins":     removePlugins,
 	})
 }
 
diff --git a/kernel/model/repository.go b/kernel/model/repository.go
@@ -1594,7 +1594,8 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,
 	var upsertTrees int
 	// 可能需要重新加载部分功能
 	var needReloadFlashcard, needReloadOcrTexts, needReloadPlugin bool
-	upsertPluginSet := hashset.New()
+	upsertCodePluginSet := hashset.New() // 插件代码变更 data/plugins/
+	upsertDataPluginSet := hashset.New() // 插件存储数据变更 data/storage/petal/
 	needUnindexBoxes, needIndexBoxes := map[string]bool{}, map[string]bool{}
 	for _, file := range mergeResult.Upserts {
 		upserts = append(upserts, file.Path)
@@ -1617,15 +1618,15 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,
 			needReloadPlugin = true
 			if parts := strings.Split(file.Path, "/"); 3 < len(parts) {
 				if pluginName := parts[3]; "petals.json" != pluginName {
-					upsertPluginSet.Add(pluginName)
+					upsertDataPluginSet.Add(pluginName)
 				}
 			}
 		}
 
 		if strings.HasPrefix(file.Path, "/plugins/") {
 			if parts := strings.Split(file.Path, "/"); 2 < len(parts) {
 				needReloadPlugin = true
-				upsertPluginSet.Add(parts[2])
+				upsertCodePluginSet.Add(parts[2])
 			}
 		}
 
@@ -1655,7 +1656,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,
 			needReloadPlugin = true
 			if parts := strings.Split(file.Path, "/"); 3 < len(parts) {
 				if pluginName := parts[3]; "petals.json" != pluginName {
-					removePluginSet.Add(pluginName)
+					upsertDataPluginSet.Add(pluginName)
 				}
 			}
 		}
@@ -1676,7 +1677,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,
 
 	for _, upsertPetal := range mergeResult.UpsertPetals {
 		needReloadPlugin = true
-		upsertPluginSet.Add(upsertPetal)
+		upsertCodePluginSet.Add(upsertPetal)
 	}
 	for _, removePetal := range mergeResult.RemovePetals {
 		needReloadPlugin = true
@@ -1692,7 +1693,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,
 	}
 
 	if needReloadPlugin {
-		pushReloadPlugin(upsertPluginSet, removePluginSet, "")
+		PushReloadPlugin(upsertCodePluginSet, upsertDataPluginSet, removePluginSet, "")
 	}
 
 	for _, widgetDir := range removeWidgetDirSet.Values() {

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,10 @@ export class Plugin {`
`113`	`113`	`// 卸载`
`114`	`114`	`}`
`115`	`115`
	`116`	`+ public onDataChanged() {`
	`117`	`+ // 存储数据变更`
	`118`	`+ }`
	`119`	`+`
`116`	`120`	`public async updateCards(options: ICardData) {`
`117`	`121`	`return options;`
`118`	`122`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,10 +67,10 @@ func setPetalEnabled(c *gin.Context) {`
`67`	`67`	`app = arg["app"].(string)`
`68`	`68`	`}`
`69`	`69`	`if enabled {`
`70`		`- upsertPluginSet := hashset.New(packageName)`
`71`		`- model.PushReloadPlugin(upsertPluginSet, nil, app)`
	`70`	`+ upsertPluginCodeSet := hashset.New(packageName)`
	`71`	`+ model.PushReloadPlugin(upsertPluginCodeSet, nil, nil, app)`
`72`	`72`	`} else {`
`73`	`73`	`removePluginSet := hashset.New(packageName)`
`74`		`- model.PushReloadPlugin(nil, removePluginSet, app)`
	`74`	`+ model.PushReloadPlugin(nil, nil, removePluginSet, app)`
`75`	`75`	`}`
`76`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -257,7 +257,7 @@ func UninstallBazaarPlugin(pluginName, frontend string) error {`
`257`	`257`	`savePetals(petals)`
`258`	`258`
`259`	`259`	`removePluginSet := hashset.New(pluginName)`
`260`		`- pushReloadPlugin(nil, removePluginSet, "")`
	`260`	`+ PushReloadPlugin(nil, nil, removePluginSet, "")`
`261`	`261`	`return nil`
`262`	`262`	`}`
`263`	`263`
Original file line number	Diff line number	Diff line change
`@@ -1594,7 +1594,8 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,`
`1594`	`1594`	`var upsertTrees int`
`1595`	`1595`	`// 可能需要重新加载部分功能`
`1596`	`1596`	`var needReloadFlashcard, needReloadOcrTexts, needReloadPlugin bool`
`1597`		`- upsertPluginSet := hashset.New()`
	`1597`	`+ upsertCodePluginSet := hashset.New() // 插件代码变更 data/plugins/`
	`1598`	`+ upsertDataPluginSet := hashset.New() // 插件存储数据变更 data/storage/petal/`
`1598`	`1599`	`needUnindexBoxes, needIndexBoxes := map[string]bool{}, map[string]bool{}`
`1599`	`1600`	`for _, file := range mergeResult.Upserts {`
`1600`	`1601`	`upserts = append(upserts, file.Path)`
`@@ -1617,15 +1618,15 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,`
`1617`	`1618`	`needReloadPlugin = true`
`1618`	`1619`	`if parts := strings.Split(file.Path, "/"); 3 < len(parts) {`
`1619`	`1620`	`if pluginName := parts[3]; "petals.json" != pluginName {`
`1620`		`- upsertPluginSet.Add(pluginName)`
	`1621`	`+ upsertDataPluginSet.Add(pluginName)`
`1621`	`1622`	`}`
`1622`	`1623`	`}`
`1623`	`1624`	`}`
`1624`	`1625`
`1625`	`1626`	`if strings.HasPrefix(file.Path, "/plugins/") {`
`1626`	`1627`	`if parts := strings.Split(file.Path, "/"); 2 < len(parts) {`
`1627`	`1628`	`needReloadPlugin = true`
`1628`		`- upsertPluginSet.Add(parts[2])`
	`1629`	`+ upsertCodePluginSet.Add(parts[2])`
`1629`	`1630`	`}`
`1630`	`1631`	`}`
`1631`	`1632`
`@@ -1655,7 +1656,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,`
`1655`	`1656`	`needReloadPlugin = true`
`1656`	`1657`	`if parts := strings.Split(file.Path, "/"); 3 < len(parts) {`
`1657`	`1658`	`if pluginName := parts[3]; "petals.json" != pluginName {`
`1658`		`- removePluginSet.Add(pluginName)`
	`1659`	`+ upsertDataPluginSet.Add(pluginName)`
`1659`	`1660`	`}`
`1660`	`1661`	`}`
`1661`	`1662`	`}`
`@@ -1676,7 +1677,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,`
`1676`	`1677`
`1677`	`1678`	`for _, upsertPetal := range mergeResult.UpsertPetals {`
`1678`	`1679`	`needReloadPlugin = true`
`1679`		`- upsertPluginSet.Add(upsertPetal)`
	`1680`	`+ upsertCodePluginSet.Add(upsertPetal)`
`1680`	`1681`	`}`
`1681`	`1682`	`for _, removePetal := range mergeResult.RemovePetals {`
`1682`	`1683`	`needReloadPlugin = true`
`@@ -1692,7 +1693,7 @@ func processSyncMergeResult(exit, byHand bool, mergeResult *dejavu.MergeResult,`
`1692`	`1693`	`}`
`1693`	`1694`
`1694`	`1695`	`if needReloadPlugin {`
`1695`		`- pushReloadPlugin(upsertPluginSet, removePluginSet, "")`
	`1696`	`+ PushReloadPlugin(upsertCodePluginSet, upsertDataPluginSet, removePluginSet, "")`
`1696`	`1697`	`}`
`1697`	`1698`
`1698`	`1699`	`for _, widgetDir := range removeWidgetDirSet.Values() {`