Note that, not like {@link #inject(Object)} (Object)} this method will NOT increment - * reference count for the injectable object with the same type and qualifier.
- * @param type the type of the object - * @param qualifier the qualifier of the injected object. Null is allowed if no qualifier is specified - * @return The cached object or a new instance matching the type and qualifier - * @throws MvcGraphException throw if exception occurs during getting the instance + * Same as {@link #use(Class, Annotation, Consumer)} except using un-qualified injectable type. + * @param type The type of the injectable instance + * @param consumer Consume to use the instance */ - publicFor example,
+ *
+ interface Os {
+ }
+
+ static class DeviceComponent extends Component {
+ @Provides
+ @Singleton
+ public Os provide() {
+ return new Os(){
+ };
+ }
+ }
+
+ class Device {
+ @Inject
+ private Os os;
+ }
+
+ mvcGraph.register(new DeviceComponent());
+
+ //OsReferenceCount = 0
+ mvcGraph.use(Os.class, null, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //First time to create the instance.
+ //OsReferenceCount = 1
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+
+ final Device device = new Device();
+ mvcGraph.inject(device); //OsReferenceCount = 1
+ //New instance created and cached
+
+ mvcGraph.use(Os.class, null, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //Since reference count is greater than 0, cached instance will be reused
+ //OsReferenceCount = 2
+ Assert.assertTrue(device.os == instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 1
+
+ mvcGraph.release(device); //OsReferenceCount = 0
+ //Last instance released, so next time a new instance will be created
+
+ mvcGraph.use(Os.class, null, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os != instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+
+ mvcGraph.use(Os.class, null, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os != instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+ //Cached instance cleared again
+
+ mvcGraph.use(Os.class, null, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ mvcGraph.inject(device);
+ //Injection will reuse the cached instance and increment the reference count
+ //OsReferenceCount = 2
+
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os == instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 1
+
+ mvcGraph.release(device); //OsReferenceCount = 0
+ *
+ * @param type The type of the injectable instance
+ * @param qualifier Qualifier for the injectable instance
+ * @param consumer Consume to use the instance
+ * @throws MvcGraphException throw when there are exceptions during the consumption of the instance
+ */
+ public The model of the controller will be instantiated by model's default no-argument constructor. + * However, if the controller needs to be restored, a new instance of model restored by + * {@link #restoreState(Object)} will replace the model created here.
+ */ + public void onConstruct() { model = createModelInstance(); eventBusC2C.register(this); - onInitialized(); } private MODEL createModelInstance() { @@ -80,14 +86,8 @@ private MODEL createModelInstance() { } /** - * Called when the controller is newly initialized. - */ - protected void onInitialized() { - } - - /** - * Called when the controller is disposed. When the controller is not referenced any more this - * should be called. + * Called when the controller is disposed. This occurs when the controller is de-referenced and + * not retained by any objects. */ @Override public void onDisposed() { @@ -143,10 +143,8 @@ final public Class- * Note that if the controller doesn't need to get its state saved and restored - * automatically. e.g. The controller always loads resource from remote services so that - * its state can be thought persisted by the remote services when {@link #getModelClassType()} - * returns null, the method will have no effect. + * Note that if the controller doesn't need its state saved and restored automatically return + * null in {@link #getModelClassType()} and then this method will have no effect. *
* * @param restoredState The restored state by {@link StateKeeper} that will be bound to the @@ -157,6 +155,13 @@ final public void restoreState(MODEL restoredState) { if (getModelClassType() != null) { bindModel(this, restoredState); } + onRestored(); + } + + /** + * Called when the controller is restored after {@link #restoreState(Object)} is called. + */ + public void onRestored() { } @Override diff --git a/library/android-mvc-controller/src/test/java/com/shipdream/lib/android/mvc/TestMvcGraph.java b/library/android-mvc-controller/src/test/java/com/shipdream/lib/android/mvc/TestMvcGraph.java index 7da131a..77c4b5f 100644 --- a/library/android-mvc-controller/src/test/java/com/shipdream/lib/android/mvc/TestMvcGraph.java +++ b/library/android-mvc-controller/src/test/java/com/shipdream/lib/android/mvc/TestMvcGraph.java @@ -17,11 +17,13 @@ package com.shipdream.lib.android.mvc; import com.shipdream.lib.poke.Component; +import com.shipdream.lib.poke.Consumer; import com.shipdream.lib.poke.Graph; +import com.shipdream.lib.poke.Provider.OnFreedListener; +import com.shipdream.lib.poke.Provides; import com.shipdream.lib.poke.ScopeCache; import com.shipdream.lib.poke.exception.ProvideException; import com.shipdream.lib.poke.exception.ProviderConflictException; -import com.shipdream.lib.poke.Provider.OnFreedListener; import org.junit.Assert; import org.junit.Before; @@ -29,10 +31,18 @@ import org.mockito.invocation.InvocationOnMock; import org.mockito.stubbing.Answer; +import java.lang.annotation.Annotation; +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; import java.util.ArrayList; import java.util.List; import java.util.concurrent.ExecutorService; +import javax.inject.Inject; +import javax.inject.Qualifier; +import javax.inject.Singleton; + +import static java.lang.annotation.RetentionPolicy.RUNTIME; import static org.mockito.Matchers.any; import static org.mockito.Matchers.eq; import static org.mockito.Mockito.doAnswer; @@ -66,6 +76,225 @@ protected ExecutorService createExecutorService() { }); } + interface Os { + } + + @Qualifier + @Documented + @Retention(RUNTIME) + @interface Apple { + } + + @Qualifier + @Documented + @Retention(RUNTIME) + @interface Google { + } + + static class iOS implements Os { + + } + + static class Android implements Os { + + } + + static class DeviceComponent extends Component { + @Provides + @Singleton + public Os provide() { + return new Android(); + } + + @Provides + @Singleton + @Apple + public Os provideIos() { + return new iOS(); + } + + @Provides + @Singleton + @Google + public Os provideAndroid() { + return new Android(); + } + } + + class Device { + @Inject + private Os android; + + @Inject + @Apple + private Os os; + } + + @Test + public void use_method_should_retain_and_release_instance_without_qualifier_correctly() { + mvcGraph.register(new DeviceComponent()); + + //OsReferenceCount = 0 + mvcGraph.use(Os.class, new ConsumerNote that, the graph will be regenerated after config. In addition, it's cached instances - * will be regenerated such as cached singletons.
- * - * @param baseDependencies The dependencies of all controllers - */ - public static void configGraph(MvcGraph.BaseDependencies baseDependencies) { - try { - mvcGraph = new MvcGraph(baseDependencies); - eventBusC2VHolder = new EventBusC2VHolder(); - mvcGraph.inject(eventBusC2VHolder); - } catch (PokeException e) { - throw new RuntimeException(e); - } - } - - static void saveStateOfAllControllers(Bundle outState) { - sStateManager.bundle = outState; - mvcGraph.saveAllStates(sStateManager); - sStateManager.bundle = null; - } - - static void restoreStateOfAllControllers(Bundle savedState) { - sStateManager.bundle = savedState; - mvcGraph.restoreAllStates(sStateManager); - sStateManager.bundle = null; - } - - static void saveControllerStateOfTheirOwn(Bundle outState, Object object) { - Field[] fields = object.getClass().getDeclaredFields(); - sStateManager.bundle = outState; - for (int i = 0; i < fields.length; i++) { - Field field = fields[i]; - if (BaseController.class.isAssignableFrom(field.getType())) { - StateManaged stateManaged = null; - try { - field.setAccessible(true); - stateManaged = (StateManaged) field.get(object); - } catch (IllegalAccessException e) { - //ignore - } - sStateManager.saveState(stateManaged.getState(), stateManaged.getStateType()); - } - } - } - - static void restoreControllerStateByTheirOwn(Bundle savedState, Object object) { - Field[] fields = object.getClass().getDeclaredFields(); - sStateManager.bundle = savedState; - for (int i = 0; i < fields.length; i++) { - Field field = fields[i]; - if (BaseController.class.isAssignableFrom(field.getType())) { - try { - field.setAccessible(true); - StateManaged stateManaged = (StateManaged) field.get(object); - Object value = sStateManager.getState(stateManaged.getStateType()); - stateManaged.restoreState(value); - } catch (IllegalAccessException e) { - //ignore - } - } - } - } - - /** - * Gets Controllers to Views event bus. Internal use by AndroidMvc library only. - * @return The event bus - */ - static EventBus getEventBusC2V() { - return eventBusC2VHolder.eventBusC2V; - } - - /** - * Gets the views to views event bus. By default all {@link MvcFragment}s, - * {@link MvcDialogFragment} and {@link MvcService} have registered to this event bus. They - * also have short cut methods to post {@link BaseEventV2V}. Custom views which need to use the - * event bus must register to this event respectively.. - * @return The event bus - */ - public static EventBus getEventBusV2V() { - return eventBusV2V; - } - - /** - * Set the custom state keeper for the objects that are wanted to be saved and restored by it. - * Other objects will still be saved and restored by json serialization. - * @param customStateKeeper The State keeper use {@link Parcelable} to save and restore state. - * If any state doesn't need to be managed by this state keeper return - * null in its {@link AndroidStateKeeper#saveState(Object, Class)} and - * {@link AndroidStateKeeper#getState(Parcelable, Class)} - */ - public static void setCustomStateKeeper(AndroidStateKeeper customStateKeeper) { - sStateManager.customStateKeeper = customStateKeeper; - } - private static class DefaultControllerDependencies extends MvcGraph.BaseDependencies { private static ExecutorService sNetworkExecutorService; private final static String BACKGROUND_THREAD_NAME = "AndroidMvcDefaultBackgroundThread"; @@ -206,117 +66,43 @@ public void run() { } } - private static class DefaultStateKeeper implements StateKeeper { - private static Gson gson; - private Bundle bundle; - private Logger logger = LoggerFactory.getLogger(getClass()); - private AndroidStateKeeper navigationModelKeeper = new NavigationModelKeeper(); - private AndroidStateKeeper customStateKeeper; - - private DefaultStateKeeper() { - gson = new GsonBuilder().create(); - } - - private static String getStateKey(String stateTypeName) { - return MVC_SATE_PREFIX + stateTypeName; - } - - @SuppressWarnings("unchecked") - @Override - publicHowever, it's not absolute. If touching a controller is an overkill, sending events + * directly through V2V channel is still an option.
+ * @param event */ protected void postEventV2V(BaseEventV2V event) { - AndroidMvc.getEventBusV2V().post(event); + eventRegister.postEventV2V(event); } } diff --git a/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcFragment.java b/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcFragment.java index 2a75b73..e6bca32 100644 --- a/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcFragment.java +++ b/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcFragment.java @@ -65,26 +65,6 @@ public static class Reason { private boolean isRotated; private boolean isPoppedOut; - void setNewInstance(boolean isNewInstance) { - this.isNewInstance = isNewInstance; - } - - void setFirstTime(boolean isFirstTime) { - this.isFirstTime = isFirstTime; - } - - void setRestored(boolean isRestored) { - this.isRestored = isRestored; - } - - void setRotated(boolean isRotated) { - this.isRotated = isRotated; - } - - void setPoppedOut(boolean isPoppedOut) { - this.isPoppedOut = isPoppedOut; - } - /** * @return Indicates whether the fragment is a new instance that all its fields need to be * reinitialized and configured. This could happen when a fragment is created for the first @@ -156,7 +136,7 @@ public String toString() { } } - private final static String STATE_LAST_ORIENTATION = AndroidMvc.MVC_SATE_PREFIX + "LastOrientation--__"; + private final static String STATE_LAST_ORIENTATION = DefaultStateKeeper.MVC_SATE_PREFIX + "LastOrientation--__"; private EventRegister eventRegister; private CopyOnWriteArrayListHowever, it's not absolute. If touching a controller is an overkill, sending events + * directly through V2V channel is still an option.
+ * @param event */ protected void postEventV2V(BaseEventV2V event) { - AndroidMvc.getEventBusV2V().post(event); + eventRegister.postEventV2V(event); } } diff --git a/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcService.java b/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcService.java index 2a25485..ecc1026 100644 --- a/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcService.java +++ b/library/android-mvc/src/main/java/com/shipdream/lib/android/mvc/view/MvcService.java @@ -37,6 +37,7 @@ public void onCreate() { AndroidMvc.graph().inject(this); eventRegister = new EventRegister(this); + eventRegister.onCreate(); eventRegister.registerEventBuses(); } @@ -47,14 +48,23 @@ public void onCreate() { public void onDestroy() { super.onDestroy(); eventRegister.unregisterEventBuses(); + eventRegister.onDestroy(); AndroidMvc.graph().release(this); } /** - * Post an event from this view to other views + * Post an event from this view to other views. Using EventBusV2V is a handy way to + * inter-communicate among views but it's a little anti pattern. Best practice is that views + * communicates to other views through controllers and EventBusC2V. For example, if view1 wants + * to talk to view2, instead of sending V2V events, view1 can send a command to a controller and + * that controller will fire an C2VEvent that will be received by view2. In this way, more + * business logic can be wrapped into controllers rather than exposed to view1. + * + *However, it's not absolute. If touching a controller is an overkill, sending events + * directly through V2V channel is still an option.
* @param event */ protected void postEventV2V(BaseEventV2V event) { - AndroidMvc.getEventBusC2V().post(event); + eventRegister.postEventV2V(event); } } diff --git a/library/poke/build.gradle b/library/poke/build.gradle index b1b26b7..32487e3 100644 --- a/library/poke/build.gradle +++ b/library/poke/build.gradle @@ -14,9 +14,12 @@ * limitations under the License. */ +plugins { + id "com.jfrog.bintray" version "1.4" +} + apply plugin: 'java' apply plugin: 'maven' -apply plugin: 'com.jfrog.bintray' task sourceJar(type: Jar) { from sourceSets.main.java.srcDirs diff --git a/library/poke/src/main/java/com/shipdream/lib/poke/Consumer.java b/library/poke/src/main/java/com/shipdream/lib/poke/Consumer.java new file mode 100644 index 0000000..3e7c4c4 --- /dev/null +++ b/library/poke/src/main/java/com/shipdream/lib/poke/Consumer.java @@ -0,0 +1,5 @@ +package com.shipdream.lib.poke; + +public abstract class ConsumerNote that, not like {@link #inject(Object, Class)} this method will NOT increment - * reference count for the injectable object with the same type and qualifier.
- * @param type the type of the object - * @param qualifier the qualifier of the injected object. Null is allowed if no qualifier is specified - * @return The cached object or a new instance matching the type and qualifier - * @throws ProviderMissingException throw if the provider matching the requiredType and qualifier is not found - * @throws ProvideException throw when failed to create a new instance - * @throws CircularDependenciesException throw when circular dependency found during injecting the newly created instance + * Same as {@link #use(Class, Annotation, Class, Consumer)} except using un-qualified injectable type. + * @param type The type of the injectable instance + * @param injectAnnotation injectAnnotation + * @param consumer Consume to use the instance + * @throws ProvideException ProvideException + * @throws CircularDependenciesException CircularDependenciesException + * @throws ProviderMissingException ProviderMissingException + */ + publicFor example,
+ *
+ private static class Device {
+ @MyInject
+ private Os os;
+ }
+
+ final SimpleGraph graph = new SimpleGraph();
+ ScopeCache scopeCache = new ScopeCache();
+
+ graph.register(Os.class, Android.class, scopeCache);
+
+ //OsReferenceCount = 0
+ graph.use(Os.class, null, Inject.class, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //First time to create the instance.
+ //OsReferenceCount = 1
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+
+ Device device = new Device();
+ graph.inject(device, MyInject.class); //OsReferenceCount = 1
+ //New instance created and cached
+
+ graph.use(Os.class, null, Inject.class, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //Since reference count is greater than 0, cached instance will be reused
+ //OsReferenceCount = 2
+ Assert.assertTrue(device.os == instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 1
+
+ graph.release(device, MyInject.class); //OsReferenceCount = 0
+ //Last instance released, so next time a new instance will be created
+
+ graph.use(Os.class, null, Inject.class, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os != instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+
+ graph.use(Os.class, null, Inject.class, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os != instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 0
+ //Cached instance cleared again
+
+ graph.use(Os.class, null, Inject.class, new Consumer() {
+ @Override
+ public void consume(Os instance) {
+ //OsReferenceCount = 1
+ graph.inject(device, MyInject.class);
+ //Injection will reuse the cached instance and increment the reference count
+ //OsReferenceCount = 2
+
+ //Since the cached instance is cleared, the new instance is a newly created one.
+ Assert.assertTrue(device.os == instance);
+ }
+ });
+ //Reference count decremented by use method automatically
+ //OsReferenceCount = 1
+
+ graph.release(device, MyInject.class); //OsReferenceCount = 0
+ *
+ * @param type The type of the injectable instance
+ * @param qualifier Qualifier for the injectable instance
+ * @param injectAnnotation injectAnnotation
+ * @param consumer Consume to use the instance
+ * @throws ProvideException ProvideException
+ * @throws CircularDependenciesException CircularDependenciesException
+ * @throws ProviderMissingException ProviderMissingException
*/
- public