add remark

Author: xlorne

springboot-starter/src/main/java/com/codingapi/springboot/framework/trigger/Trigger.java

@@ -1,4 +1,7 @@
 package com.codingapi.springboot.framework.trigger;
 
+/**
+ * 触发的DTO对象
+ */
 public interface Trigger {
 }

springboot-starter/src/main/java/com/codingapi/springboot/framework/trigger/TriggerContext.java

@@ -1,12 +1,19 @@
 package com.codingapi.springboot.framework.trigger;
 
 import java.lang.reflect.ParameterizedType;
-import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.CopyOnWriteArrayList;
 
+
+/**
+ * Trigger与Event模式都提供了订阅的功能。
+ *
+ * Trigger模式可以控制触发的规则,例如是否进入触发器,触发器是否在触发以后删除。
+ * Trigger是单独的消息数据不占用Event的通道。由于Event利用了Spring的事件底层,因此在大规模的事件情况下会堵塞spring的事件通道。
+ */
 @SuppressWarnings("all")
 public class TriggerContext{
 
@@ -23,45 +30,69 @@ private TriggerContext(){
         this.triggers = new ConcurrentHashMap<>();
     }
 
-    public void addTrigger(TriggerHandler trigger){
-        Class<? extends Trigger> clazz = getTriggerClass(trigger);
+    /**
+     * 添加触发器
+     * @param handler 触发订阅
+     */
+    public void addTrigger(TriggerHandler handler){
+        Class<? extends Trigger> clazz = getTriggerClass(handler);
         List<TriggerHandler> triggerList =  this.triggers.get(clazz);
         if(triggerList==null){
-            triggerList = new ArrayList<>();
+            triggerList = new CopyOnWriteArrayList<>();
             this.triggers.put(clazz,triggerList);
         }
-        triggerList.add(trigger);
+        triggerList.add(handler);
     }
 
 
-    private Class<? extends Trigger> getTriggerClass(TriggerHandler trigger){
-        ParameterizedType parameterizedType = (ParameterizedType) trigger.getClass().getGenericInterfaces()[0];
+    /**
+     * 获取触发器订阅的Trigger类型
+     * @param handler 触发订阅
+     * @return Trigger类型
+     */
+    private Class<? extends Trigger> getTriggerClass(TriggerHandler handler){
+        ParameterizedType parameterizedType = (ParameterizedType) handler.getClass().getGenericInterfaces()[0];
         return (Class<? extends Trigger>) parameterizedType.getActualTypeArguments()[0];
     }
 
 
+    /**
+     * 执行触发
+     * @param trigger trigger触发
+     */
     public void trigger(Trigger trigger){
         Class<? extends Trigger> clazz = trigger.getClass();
         Iterator<TriggerHandler> iterator = triggers.get(clazz).iterator();
         while (iterator.hasNext()){
             TriggerHandler handler = iterator.next();
             Class<? extends Trigger> triggerClass = getTriggerClass(handler);
             if(triggerClass.equals(clazz)) {
-                if (handler.preTrigger(trigger)) {
-                    handler.trigger(trigger);
-                    if (handler.remove()) {
-                        iterator.remove();
+                try {
+                    if (handler.preTrigger(trigger)) {
+                        handler.trigger(trigger);
+                        if (handler.remove()) {
+                            iterator.remove();
+                        }
                     }
-                }
+                }catch (Exception e){}
             }
         }
     }
 
+    /**
+     * 清空触发
+     * @param clazz 清空的trigger类型
+     */
     public void clear(Class<? extends Trigger> clazz){
         triggers.get(clazz).clear();
     }
 
 
+    /**
+     * 判断是否清空的对象
+     * @param clazz 清空的trigger类型
+     * @return true为空
+     */
     public boolean isEmpty(Class<? extends Trigger> clazz){
         return triggers.get(clazz).isEmpty();
     }

springboot-starter/src/main/java/com/codingapi/springboot/framework/trigger/TriggerHandler.java

@@ -1,12 +1,29 @@
 package com.codingapi.springboot.framework.trigger;
 
 
+/**
+ * 触发逻辑
+ * @param <T> 触发DTO对象 {@link Trigger}
+ */
 public interface TriggerHandler<T extends  Trigger> {
 
+    /**
+     * 是否进入触发器
+     * @param trigger 触发对象  {@link Trigger}
+     * @return true进入 false 不进入
+     */
     boolean preTrigger(T trigger);
 
+    /**
+     * 触发执行逻辑
+     * @param trigger 触发对象  {@link Trigger}
+     */
     void trigger(T trigger);
 
+    /**
+     * 执行完成以后是否删除触发器
+     * @return true删除
+     */
     boolean remove();
 
 }