New for AOP

silentbalanceyh · Jun 3, 2023 · cf2df95 · cf2df95
1 parent 2340df1
commit cf2df95
Show file tree

Hide file tree

Showing 89 changed files with 212 additions and 181 deletions.
diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/EmAop.java b/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/EmAop.java
@@ -0,0 +1,20 @@
+package io.horizon.eon.em;
+
+/**
+ * @author lang : 2023-06-03
+ */
+public final class EmAop {
+    private EmAop() {
+    }
+
+    /**
+     * 执行AOP的作用时间，全环境通用，使用单词 Effect 代表影响的意思，
+     * 副作用、影响表示其组件生命周期的发生时间戳
+     */
+    public enum Effect {
+        BEFORE,  // 之前执行
+        AFTER,   // 之后执行
+        AROUND,  // 前后执行
+        NONE,    // 关闭不执行
+    }
+}
diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/EmDict.java b/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/EmDict.java
@@ -0,0 +1,17 @@
+package io.horizon.eon.em;
+
+/**
+ * @author lang : 2023-06-03
+ */
+public final class EmDict {
+    private EmDict() {
+    }
+
+    public enum Type {
+        CATEGORY, // The category data ( tree ) definition,
+        TABULAR,  // The tabular data ( list ) definition,
+        ASSIST,   // The adminicle data ( dynamic ) came from definition
+        DAO,      // The standard Dao Dict for capture
+        NONE,     // None for source define
+    }
+}
diff --git a/...ronment/io/horizon/eon/em/uca/CcMode.java → ...ronment/io/horizon/eon/em/app/CcMode.java b/...ronment/io/horizon/eon/em/uca/CcMode.java → ...ronment/io/horizon/eon/em/app/CcMode.java
@@ -1,4 +1,4 @@
-package io.horizon.eon.em.uca;
+package io.horizon.eon.em.app;
 
 /**
  * @author <a href="http://www.origin-x.cn">Lang</a>

diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/uca/AopType.java b/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/uca/AopType.java
diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/uca/DictType.java b/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/uca/DictType.java
diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/web/HttpStatusCode.java b/vertx-gaia/vertx-ams/src/main/environment/io/horizon/eon/em/web/HttpStatusCode.java
@@ -202,9 +202,9 @@ public enum HttpStatusCode {
     REQUEST_URI_TOO_LONG(414, "Request-URI Too Long"),
 
     /**
-     * 415 Unsupported Media Type
+     * 415 Unsupported Media Effect
      **/
-    UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Type"),
+    UNSUPPORTED_MEDIA_TYPE(415, "Unsupported Media Effect"),
 
     /**
      * 416 Requested Range Not Satisfiable

diff --git a/vertx-gaia/vertx-ams/src/main/environment/io/modello/eon/configure/aop.java b/vertx-gaia/vertx-ams/src/main/environment/io/modello/eon/configure/aop.java
@@ -57,5 +57,25 @@ interface HPCAop {
      * </code></pre>
      */
     String PLUGIN_COMPONENT_JOB = "plugin.component.job";
+    /**
+     * <value>plugin.config</value>, 和 Before/After 相关的组件静态配置，数据类型为 {@link io.vertx.core.json.JsonObject}
+     *
+     * 该组件配置为`name = Json`的核心结构，Json中存储了和组件相关的配置数据，配置如下：
+     *
+     * <pre><code>
+     *     {
+     *         "plugin.config": {
+     *             "component1": {
+     *
+     *             },
+     *             "component2": {
+     *
+     *             }
+     *         }
+     *     }
+     * </code></pre>
+     *
+     * 上述片段中 component1 和 component2 是组件名称（Java类全名）
+     */
     String PLUGIN_CONFIG = "plugin.config";
 }
diff --git a/vertx-gaia/vertx-ams/src/main/java/io/horizon/util/IoStream.java b/vertx-gaia/vertx-ams/src/main/java/io/horizon/util/IoStream.java
@@ -31,7 +31,7 @@ private IoStream() {
      * @param message The java object that will be converted from.
      * @param <T>     Target java object that will be converted to.
      *
-     * @return Target java object ( Generic Type )
+     * @return Target java object ( Generic Effect )
      */
     static <T> byte[] to(final T message) {
         final ByteArrayOutputStream bytes = new ByteArrayOutputStream();
@@ -48,7 +48,7 @@ static <T> byte[] to(final T message) {
      *
      * @param pos    The position of reading
      * @param buffer The buffer to hold the data from reading.
-     * @param <T>    The converted java object type, Generic Type
+     * @param <T>    The converted java object type, Generic Effect
      *
      * @return Return to converted java object.
      */

diff --git a/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/aop/AspectSwitcher.java b/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/aop/AspectSwitcher.java
@@ -2,7 +2,14 @@
 
 /**
  * 「切面分流器」
- * 根据既定规则对AOP部分的配置执行分流操作，分类规则
+ * 根据既定规则对AOP部分的配置执行分流操作，分类规则参考如下配置：
+ * <pre><code>
+ *     {
+ *         "plugin.switcher": {
+ *             "field": "type"
+ *         }
+ *     }
+ * </code></pre>
  *
  * @author lang : 2023-06-03
  */

diff --git a/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/cache/Cc.java b/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/cache/Cc.java
@@ -1,6 +1,6 @@
 package io.horizon.uca.cache;
 
-import io.horizon.eon.em.uca.CcMode;
+import io.horizon.eon.em.app.CcMode;
 import io.horizon.exception.internal.CcModeNullException;
 import io.horizon.util.HUt;
 import io.vertx.core.Future;

diff --git a/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/cache/CcAsync.java b/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/cache/CcAsync.java
@@ -1,6 +1,6 @@
 package io.horizon.uca.cache;
 
-import io.horizon.eon.em.uca.CcMode;
+import io.horizon.eon.em.app.CcMode;
 import io.horizon.exception.internal.OperationException;
 import io.vertx.core.Future;
 

diff --git a/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/compare/Vs.java b/vertx-gaia/vertx-ams/src/main/jib/io/horizon/uca/compare/Vs.java
@@ -77,7 +77,7 @@ public static Vs create(final String identifier, final ConcurrentMap<String, HMe
 
     // ============================ Static Comparing Change ===============================
     public static boolean isValue(final Object value, final Class<?> type) {
-        // Fix Null Pointer Exception for Unknown Type comparing.
+        // Fix Null Pointer Exception for Unknown Effect comparing.
         final VsSame same = VsSame.get(type);
         return Objects.isNull(same) ? Objects.nonNull(value) : same.ok(value);
     }

diff --git a/vertx-gaia/vertx-ams/src/main/qas/io/modello/specification/HRecord.java b/vertx-gaia/vertx-ams/src/main/qas/io/modello/specification/HRecord.java
@@ -126,7 +126,7 @@ interface HMeta {
     Set<String> joins();
 
     /*
-     * Type
+     * Effect
      */
     ConcurrentMap<String, Class<?>> types();
 

diff --git a/vertx-gaia/vertx-co/src/main/environment/io/vertx/up/eon/KWeb.java b/vertx-gaia/vertx-co/src/main/environment/io/vertx/up/eon/KWeb.java
@@ -32,7 +32,7 @@ interface ARGS {
         String MIME_DIRECT = "$$DIRECT$$";
         /*
          * Flow used here
-         * IGNORE -> Flow.TYPED ( Extract by Type )
+         * IGNORE -> Flow.TYPED ( Extract by Effect )
          */
         String MIME_IGNORE = "$$IGNORE$$";
 

diff --git a/vertx-gaia/vertx-co/src/main/environment/io/vertx/up/eon/em/EmSecure.java b/vertx-gaia/vertx-co/src/main/environment/io/vertx/up/eon/em/EmSecure.java
@@ -47,22 +47,6 @@ public enum ActPhase {
         ERROR, // Error phase
     }
 
-    /**
-     * 数据域 DataRegion 的触发时间
-     * - BEFORE: 在请求之前触发 DataRegion
-     * - AFTER：在请求之后触发 DataRegion
-     * - AROUND：在请求之前和之后都触发 DataRegion
-     * - NONE：不触发，直接禁用，方便热部署时禁用
-     *
-     * @author <a href="http://www.origin-x.cn">Lang</a>
-     */
-    public enum ActTime {
-        BEFORE, // DataRegion before
-        AFTER,  // DataRegion after
-        AROUND,  // Around execution
-        NONE,    // Disable dual mapping execution
-    }
-
     /**
      * Wall type for security
      */
@@ -88,27 +72,27 @@ public enum AuthWall {
          * defined key that could be read configuration data from `vertx-secure.yml` etc.
          */
         EXTENSION("extension");
-    
+
         private static final ConcurrentMap<String, AuthWall> TYPE_MAP = new ConcurrentHashMap<>();
-    
+
         static {
             Arrays.stream(AuthWall.values()).forEach(wall -> TYPE_MAP.put(wall.key(), wall));
         }
-    
+
         private transient final String configKey;
-    
+
         AuthWall(final String configKey) {
             this.configKey = configKey;
         }
-    
+
         public static AuthWall from(final String configKey) {
             return TYPE_MAP.getOrDefault(configKey, null);
         }
-    
+
         public static Set<String> keys() {
             return TYPE_MAP.keySet();
         }
-    
+
         public String key() {
             return this.configKey;
         }

diff --git a/vertx-gaia/vertx-co/src/main/extension/io/vertx/core/ClusterOptionsConverter.java b/vertx-gaia/vertx-co/src/main/extension/io/vertx/core/ClusterOptionsConverter.java
@@ -16,7 +16,7 @@
  *
  * This class is ClusterOptions assist tool
  *
- * * enabled: Boolean Type
+ * * enabled: Boolean Effect
  * * manager: String class and it will be converted to `ClusterManager`
  * * options: JsonObject
  *

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BMapping.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BMapping.java
@@ -55,7 +55,7 @@ void init(final JsonObject input) {
                         final String typeFlag = Objects.isNull(toArray[1]) ? "" : toArray[1].trim();
                         if (Objects.nonNull(toField)) {
                             /*
-                             * Type here
+                             * Effect here
                              */
                             final Class<?> type = BType.type(typeFlag);
                             /* mapping type */

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BTree.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BTree.java
@@ -1,6 +1,6 @@
 package io.vertx.up.atom.exchange;
 
-import io.horizon.eon.em.uca.AopType;
+import io.horizon.eon.em.EmAop;
 import io.vertx.core.json.JsonArray;
 import io.vertx.core.json.JsonObject;
 import io.vertx.up.util.Ut;
@@ -36,7 +36,7 @@ public class BTree implements Serializable {
     /*
      * Configured `MappingMode` and `Class<?>`
      */
-    private AopType mode = AopType.NONE;
+    private EmAop.Effect mode = EmAop.Effect.NONE;
     private Class<?> component;
 
     public BTree() {
@@ -82,15 +82,15 @@ public BTree init(final JsonObject input) {
      * 3) DualMapping ( Bind Life Cycle )
      * 4) valid() -> boolean Check whether the mapping is enabled.
      */
-    public AopType getMode() {
+    public EmAop.Effect getMode() {
         return this.mode;
     }
 
     public Class<?> getComponent() {
         return this.component;
     }
 
-    public BTree bind(final AopType mode) {
+    public BTree bind(final EmAop.Effect mode) {
         this.mode = mode;
         return this;
     }
@@ -101,7 +101,7 @@ public BTree bind(final Class<?> component) {
     }
 
     public boolean valid() {
-        return AopType.NONE != this.mode;
+        return EmAop.Effect.NONE != this.mode;
     }
 
     // -------------  Get by identifier ----------------------------

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BType.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/BType.java
@@ -8,7 +8,7 @@
 import java.util.concurrent.ConcurrentMap;
 
 /*
- * Type Mapping here
+ * Effect Mapping here
  * Definition for type conversation of `DualItem`
  */
 class BType {

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/DSource.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/exchange/DSource.java
@@ -1,6 +1,6 @@
 package io.vertx.up.atom.exchange;
 
-import io.horizon.eon.em.uca.DictType;
+import io.horizon.eon.em.EmDict;
 import io.horizon.specification.typed.TCopy;
 import io.horizon.uca.log.Annal;
 import io.vertx.core.json.JsonArray;
@@ -31,7 +31,7 @@ public class DSource implements Serializable, TCopy<DSource> {
     /*
      * SourceType of current source definition
      */
-    private DictType source;
+    private EmDict.Type source;
     /*
      * Another source of ASSIST here
      */
@@ -44,8 +44,8 @@ public DSource(final JsonObject definition) {
          * Source normalize for `source type`
          */
         final String source = definition.getString("source");
-        this.source = Ut.toEnum(() -> source, DictType.class, DictType.NONE);
-        if (DictType.CATEGORY == this.source || DictType.TABULAR == this.source) {
+        this.source = Ut.toEnum(() -> source, EmDict.Type.class, EmDict.Type.NONE);
+        if (EmDict.Type.CATEGORY == this.source || EmDict.Type.TABULAR == this.source) {
             /*
              * Different definition for
              * 1) CATEGORY / TABULAR
@@ -56,7 +56,7 @@ public DSource(final JsonObject definition) {
                     .map(item -> (String) item)
                     .forEach(this.types::add);
             }
-        } else if (DictType.ASSIST == this.source) {
+        } else if (EmDict.Type.ASSIST == this.source) {
             /*
              * Different definition for
              * ASSIST
@@ -79,7 +79,7 @@ public DSource(final JsonObject definition) {
     private DSource() {
     }
 
-    public DictType getSourceType() {
+    public EmDict.Type getSourceType() {
         return this.source;
     }
 

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/extension/KNaming.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/extension/KNaming.java
@@ -21,7 +21,7 @@
  * - key        : System Primary Key
  * - code       : System Code
  * - name       : System Name
- * - type       : System Type
+ * - type       : System Effect
  * - category   : System Category
  * - serial     : System Number & Serialization
  *

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/sch/KTimer.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/atom/sch/KTimer.java
@@ -100,12 +100,12 @@ public long waitUntil() {
              * Fix issue of delay < 1ms, the default should be 1
              * Cannot schedule a timer with delay < 1 ms
              *
-             * Type = ONCE
+             * Effect = ONCE
              */
             return 1;
         } else {
             /*
-             * Type != ONCE
+             * Effect != ONCE
              */
             final Instant start = Instant.now();
             final long delay = ChronoUnit.MILLIS.between(start, end);

diff --git a/vertx-gaia/vertx-co/src/main/java/io/vertx/up/commune/Ruler.java b/vertx-gaia/vertx-co/src/main/java/io/vertx/up/commune/Ruler.java
@@ -106,7 +106,7 @@ private static <T> void verifyItem(final T input, final JsonObject rule) throws
                 reference.flumen(data, rule);
                 // EmType
                 reference = CC_INSURER.pick(TypedInsurer::new, "A-EmType");
-                // Fn.po?lThread(POOL_INSURER, TypedInsurer::new, "A-Type");
+                // Fn.po?lThread(POOL_INSURER, TypedInsurer::new, "A-Effect");
                 reference.flumen(data, rule);
                 // Forbidden
                 reference = CC_INSURER.pick(ForbiddenInsurer::new, "A-Forbidden");
@@ -119,8 +119,8 @@ private static <T> void verifyItem(final T input, final JsonObject rule) throws
                 // Fn.po?lThread(POOL_INSURER, RequiredInsurer::new, "J-Required");
                 reference.flumen(data, rule);
                 // EmType
-                reference = CC_INSURER.pick(TypedInsurer::new, "J-Type");
-                // Fn.po?lThread(POOL_INSURER, TypedInsurer::new, "J-Type");
+                reference = CC_INSURER.pick(TypedInsurer::new, "J-Effect");
+                // Fn.po?lThread(POOL_INSURER, TypedInsurer::new, "J-Effect");
                 reference.flumen(data, rule);
                 // Forbidden
                 reference = CC_INSURER.pick(ForbiddenInsurer::new, "J-Forbidden");