Allow specify the app env (e.g. PROD or DEV) when loading a Genie module

greenlaw110 · greenlaw110 · commit 4fe125111148 · 2016-10-17T22:10:20.000+11:00
diff --git a/src/main/java/act/Act.java b/src/main/java/act/Act.java
@@ -9,6 +9,7 @@
 import act.conf.ActConfLoader;
 import act.conf.ActConfig;
 import act.conf.AppConfig;
+import act.conf.ConfLoader;
 import act.controller.meta.ActionMethodMetaInfo;
 import act.controller.meta.CatchMethodMetaInfo;
 import act.controller.meta.InterceptorMethodMetaInfo;
@@ -172,6 +173,13 @@ public static boolean isDev() {
         return mode.isDev();
     }
 
+    /**
+     * Return the current profile name
+     */
+    public static String profile() {
+        return ConfLoader.confSetName();
+    }
+
     public static ActConfig conf() {
         return conf;
     }
diff --git a/src/main/java/act/inject/ModuleTag.java b/src/main/java/act/inject/ModuleTag.java
@@ -0,0 +1,14 @@
+package act.inject;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Mark a class as dependency injector module
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface ModuleTag {
+}
diff --git a/src/main/java/act/inject/genie/GenieInjector.java b/src/main/java/act/inject/genie/GenieInjector.java
@@ -7,6 +7,8 @@
 import act.inject.ActProviders;
 import act.inject.DependencyInjectionBinder;
 import act.inject.DependencyInjectorBase;
+import act.inject.ModuleTag;
+import act.sys.Env;
 import act.util.AnnotatedClassFinder;
 import act.util.SubClassFinder;
 import org.osgl.$;
@@ -19,6 +21,7 @@
 import org.osgl.mvc.annotation.Param;
 import org.osgl.util.C;
 import org.osgl.util.E;
+import org.osgl.util.S;
 
 import javax.inject.Inject;
 import javax.inject.Provider;
@@ -163,11 +166,24 @@ public Void apply(Class aClass, Provider provider) throws NotAppliedException, O
 
     @SubClassFinder(value = Module.class, callOn = AppEventId.DEPENDENCY_INJECTOR_LOADED)
     public static void foundModule(Class<? extends Module> moduleClass) {
+        if (!isModuleAllowed(moduleClass)) {
+            return;
+        }
         App app = App.instance();
         GenieInjector genieInjector = app.injector();
         genieInjector.addModule($.newInstance(moduleClass));
     }
 
+    @AnnotatedClassFinder(value = ModuleTag.class, callOn = AppEventId.DEPENDENCY_INJECTOR_LOADED, noAbstract = false)
+    public static void foundTaggedModule(Class<?> taggedModuleClass) {
+        if (!isModuleAllowed(taggedModuleClass)) {
+            return;
+        }
+        App app = App.instance();
+        GenieInjector genieInjector = app.injector();
+        genieInjector.addModule(taggedModuleClass);
+    }
+
     @AnnotatedClassFinder(value = LoadValue.class, noAbstract = false, callOn = AppEventId.DEPENDENCY_INJECTOR_LOADED)
     public static void foundValueLoader(Class<? extends Annotation> valueLoader) {
         App app = App.instance();
@@ -191,4 +207,28 @@ public static void foundGenericTypedBeanLoader(Class<? extends GenericTypedBeanL
         }
     }
 
+    private static boolean isModuleAllowed(Class<?> moduleClass) {
+        Env.Profile profile = moduleClass.getAnnotation(Env.Profile.class);
+        if (null != profile) {
+            return isProfileMatched(profile);
+        }
+        Env.Mode mode = moduleClass.getAnnotation(Env.Mode.class);
+        if (null != mode) {
+            return isModeMatched(mode);
+        }
+        return true;
+    }
+
+    private static boolean isProfileMatched(Env.Profile profile) {
+        boolean unless = profile.unless();
+        String required = profile.value();
+        return unless ^ S.eq(required, Act.profile());
+    }
+
+    private static boolean isModeMatched(Env.Mode mode) {
+        boolean unless = mode.unless();
+        Act.Mode required = mode.value();
+        return unless ^ (required == Act.mode());
+    }
+
 }
diff --git a/src/main/java/act/sys/Env.java b/src/main/java/act/sys/Env.java
@@ -0,0 +1,58 @@
+package act.sys;
+
+import act.Act;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Mark a module should only be loaded in certain environment
+ */
+public final class Env {
+
+    private Env() {}
+
+    /**
+     * Used to mark a dependency injector module that
+     * should be load only in specified profile
+     */
+    @Target(ElementType.TYPE)
+    @Retention(RetentionPolicy.RUNTIME)
+    public @interface Profile {
+
+        /**
+         * The profile specification
+         */
+        String value();
+
+        /**
+         * If unless is `true` then the module should be load
+         * unless the current profile is the value specified
+         */
+        boolean unless() default false;
+    }
+
+    /**
+     * Used to mark a dependency injector module
+     * that should be load only in specified mode
+     */
+    @Target(ElementType.TYPE)
+    @Retention(RetentionPolicy.RUNTIME)
+    public @interface Mode {
+
+        /**
+         * The mode specification
+         */
+        Act.Mode value();
+
+        /**
+         * If unless is `true` then the module should be load
+         * unless the current mode is the value specified
+         */
+        boolean unless() default false;
+    }
+
+
+}
