plugin 注释

Linyuzai · Jul 13, 2024 · f33dae2 · f33dae2
1 parent a284235
commit f33dae2
Show file tree

Hide file tree

Showing 120 changed files with 1,453 additions and 893 deletions.
diff --git a/...core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoadErrorEvent.java b/...core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoadErrorEvent.java
@@ -5,12 +5,15 @@
 import lombok.RequiredArgsConstructor;
 
 /**
- * 插件自动加载事件
+ * 插件自动加载失败事件
  */
 @Getter
 @RequiredArgsConstructor
 public class PluginAutoLoadErrorEvent implements PluginAutoEvent, PluginErrorEvent {
 
+    /**
+     * 插件路径
+     */
     private final String path;
 
     private final Throwable error;

diff --git a/...ugin-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoadEvent.java b/...ugin-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoadEvent.java
@@ -10,6 +10,9 @@
 @Getter
 public class PluginAutoLoadEvent extends AbstractPluginEvent implements PluginAutoEvent {
 
+    /**
+     * 插件路径
+     */
     private final String path;
 
     public PluginAutoLoadEvent(Plugin plugin, String path) {

diff --git a/...-plugin-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoader.java b/...-plugin-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoLoader.java
@@ -1,7 +1,7 @@
 package com.github.linyuzai.plugin.core.autoload;
 
 /**
- * 插件自动加载，可在某些场景下触发自动加载
+ * 插件自动加载
  */
 public interface PluginAutoLoader {
 
@@ -10,14 +10,25 @@ public interface PluginAutoLoader {
      */
     void start();
 
+    /**
+     * 开始监听
+     *
+     * @param load 加载已经存在的插件
+     */
     void start(boolean load);
 
     /**
      * 停止监听
      */
     void stop();
 
+    /**
+     * 添加分组监听
+     */
     void addGroup(String group);
 
+    /**
+     * 获取分组监听状态
+     */
     Boolean getGroupState(String group);
 }
diff --git a/...re/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoUnloadErrorEvent.java b/...re/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoUnloadErrorEvent.java
@@ -5,12 +5,15 @@
 import lombok.RequiredArgsConstructor;
 
 /**
- * 插件自动加载事件
+ * 插件自动卸载失败事件
  */
 @Getter
 @RequiredArgsConstructor
 public class PluginAutoUnloadErrorEvent implements PluginAutoEvent, PluginErrorEvent {
 
+    /**
+     * 插件路径
+     */
     private final String path;
 
     private final Throwable error;

diff --git a/...in-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoUnloadEvent.java b/...in-core/src/main/java/com/github/linyuzai/plugin/core/autoload/PluginAutoUnloadEvent.java
@@ -10,6 +10,9 @@
 @Getter
 public class PluginAutoUnloadEvent extends AbstractPluginEvent implements PluginAutoEvent {
 
+    /**
+     * 插件路径
+     */
     private final String path;
 
     public PluginAutoUnloadEvent(Plugin plugin, String path) {

diff --git a/.../src/main/java/com/github/linyuzai/plugin/core/autoload/WatchServicePluginAutoLoader.java b/.../src/main/java/com/github/linyuzai/plugin/core/autoload/WatchServicePluginAutoLoader.java
@@ -17,7 +17,9 @@
 import java.util.concurrent.ExecutorService;
 
 /**
- * 基于 {@link WatchService} 的插件文件自动加载器
+ * 基于目录监听的插件文件自动加载
+ *
+ * @see WatchService
  */
 @Getter
 @RequiredArgsConstructor
@@ -35,10 +37,16 @@ public class WatchServicePluginAutoLoader implements PluginAutoLoader {
      */
     private final PluginLocation location;
 
+    /**
+     * 目录状态
+     */
     private final Map<String, Boolean> watchStates = new ConcurrentHashMap<>();
 
     private WatchService watchService;
 
+    /**
+     * 是否运行
+     */
     private boolean running = false;
 
     @Override
@@ -59,11 +67,13 @@ public synchronized void start(boolean load) {
 
         executor.execute(this::listen);
 
+        //添加目录监听
         String[] groups = location.getGroups();
         for (String group : groups) {
             addGroup(group);
         }
 
+        //加载已经存在的插件
         if (load) {
             List<String> paths = new ArrayList<>();
             for (String group : groups) {
@@ -90,15 +100,15 @@ public synchronized void start(boolean load) {
     @Override
     public void addGroup(String group) {
         try {
-            String path = location.getLoadedPath(group);
-            registerPath(path);
+            String path = location.getLoadedBasePath(group);
+            registerPath(path, watchService);
             watchStates.put(group, true);
         } catch (Throwable e) {
             watchStates.put(group, true);
         }
     }
 
-    protected void registerPath(String path) throws IOException {
+    protected void registerPath(String path, WatchService watchService) throws IOException {
         Paths.get(path).register(watchService,
                 StandardWatchEventKinds.ENTRY_CREATE,
                 StandardWatchEventKinds.ENTRY_MODIFY,
@@ -136,6 +146,7 @@ public void listen() {
                 try {
                     final WatchKey key = watchService.take();
                     for (WatchEvent<?> event : key.pollEvents()) {
+                        //获得分组
                         String groupPath = key.watchable().toString();
                         String group = location.getGroup(groupPath);
                         if (group == null) {
@@ -159,7 +170,7 @@ public void onNotify(WatchEvent<?> event, String group) {
         if (kind == StandardWatchEventKinds.OVERFLOW) {
             return;
         }
-        String name = event.context().toString();
+        String name = event.context().toString();//文件名
         onNotify(kind, group, name);
     }
 
@@ -179,26 +190,20 @@ public void onNotify(WatchEvent.Kind<?> kind, String group, String name) {
 
     /**
      * 文件创建
-     *
-     * @param path 监听到的事件
      */
     public void onFileCreated(String path) {
         load(path);
     }
 
     /**
      * 文件修改
-     *
-     * @param path 监听到的事件
      */
     public void onFileModified(String path) {
         reload(path);
     }
 
     /**
      * 文件删除
-     *
-     * @param path 监听到的事件
      */
     public void onFileDeleted(String path) {
         unload(path);
@@ -208,6 +213,9 @@ public void onListenError(Throwable e) {
         concept.getLogger().error("Plugin listen error", e);
     }
 
+    /**
+     * 加载插件
+     */
     public void load(String path) {
         try {
             Plugin plugin = concept.load(path);
@@ -217,6 +225,9 @@ public void load(String path) {
         }
     }
 
+    /**
+     * 重新加载插件
+     */
     public void reload(String path) {
         unload(path);
         load(path);
@@ -229,9 +240,7 @@ public void reload(String path) {
     }
 
     /**
-     * 卸载并移除映射关系
-     *
-     * @param path 文件路径
+     * 卸载插件
      */
     public void unload(String path) {
         try {