Merge pull request #23 from leobert-lan/feature/anno

Feature/anno

Author: mqzhangw

URI设计.md

@@ -0,0 +1,54 @@
+# URI设计
+By Leobert
+
+## 为什么要有这一篇
+DDComponent设计的初衷应当是注重于实现组件化，得到的几位大牛也提供了非常优秀的解决方案。但是组件化的代码边界带来了一个问题：UI跳转的时候没那么方便了，以往常见的做法：
+
+* 耦合非常高的直接构造Intent并启动
+* 将所需的参数、参数组装等都在目标Activity中进行方法封装，暴露静态方法供调用
+* 实现Factory进行Intent的构造、实现启动器
+
+都不行了。所以DDComponent中有了Router部分，使用路由进行UI跳转（通过路由寻找组件的内容本篇略过）。而DDComponent中的UIRouter部分是比较轻量级的，本人也有幸和得到的大牛进行了一定的讨论，对router部分略尽了绵薄之力。但是当前的Router部分使用还是没那么轻松的，而本人也对这些问题进行了思考，幸有所得。鉴于接下来一段时间我都比较忙，现将设计思路记录于此，倘若有同行有兴趣提供一臂自力也是非常感激的。
+
+PS：格竹子君给我开了一个anno分支，本身我命这个名字是Feature/anno 使用注解实现路由定义的功能分支。
+
+## URI的基础格式
+> 协议://域名:port/目录a/目录b/文件c?key1=value1&key2=v2#author
+
+除了这些还有query部分，author部分（URL中也有人称hash部分）
+而‘目录a/目录b/文件c’这段也有人称为path。
+
+**在当前的实现中，参数传递暂使用Bundle，不支持使用queryString**。
+
+我们可以看到demo中有这样一段：
+
+```
+UIRouter.getInstance().openUri(getActivity(), "componentdemo://share", bundle);
+```
+
+这里使用的URI尚未经过精心设计，而且直接使用hardcode形式也是不利于维护的（当然这里只是demo，当我们将框架完善后这些问题就解决了）
+
+## 设计构想
+### 协议部分
+有一些朋友提过issue：runalone时的传值问题。参考一些服务端的同事在一些非敏感接口同时兼容了query传值和表单传值的做法，我觉得Router部分兼容query传值和Intent的bundle传值是可取的。考虑到可能控制不住的场面。通过协议部分区分两种形式。
+
+* dunq: DDUiNavigation-QueryString 使用queryString传值
+* dunb: DDUiNavigation-Bundle 使用Bundle传值
+
+### host部分
+我们可以将Component认为是不同的主机，给定不同的域名
+
+### port部分
+我有在项目中提过一个issue，intent的FLAG问题，当前是没有支持的，可以使用port来做一些手脚，也可以直接在Router中将方法原型扩展一下。*我还要再细想想哪种好*
+
+### path部分
+当前的anno分支实现中，在对path提出了group的概念，可以针对group分一下Router，但是除了看起来有点噱头其实没啥大用，因为路由表都是按照注解自动生成的，最多就是路由器命名的时候贴切一些。
+
+但潜意识告诉我这个group迟早会有用 233333
+
+计划中会按照注解的path生成一些常量，减少hardcode。这个时候group可能会有用哦。
+
+### query部分
+计划中需要支持使用query进行传值
+
+

componentlib/build.gradle

@@ -25,13 +25,13 @@ android {
 }
 
 dependencies {
-    compile fileTree(dir: 'libs', include: ['*.jar'])
+    compile fileTree(include: ['*.jar'], dir: 'libs')
     compile 'com.android.support:appcompat-v7:26.+'
-
     androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
         exclude group: 'com.android.support', module: 'support-annotations'
     })
     testCompile 'junit:junit:4.12'
+    compile project(':router-annotation')
 }
 
 

componentlib/src/main/java/com/mrzhang/component/componentlib/router/UiActivityUri.java

@@ -0,0 +1,76 @@
+package com.mrzhang.component.componentlib.router;
+
+import android.support.annotation.StringDef;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * <p><b>Package:</b> com.mrzhang.component.componentlib.router </p>
+ * <p><b>Project:</b> DDComponentForAndroid </p>
+ * <p><b>Classname:</b> Path </p>
+ * <p><b>Description:</b> TODO </p>
+ * Created by leobert on 2017/9/23.
+ */
+
+public final class UiActivityUri {
+
+    @Retention(RetentionPolicy.SOURCE)
+    @StringDef({Scheme.DUNQ,Scheme.DUNB})
+    public @interface SchemeDef {
+
+    }
+
+    public static final class Scheme {
+        public static final String DUNQ = "dunp:";
+
+        public static final  String DUNB = "dunb:";
+    }
+
+    @SchemeDef
+    private String scheme;
+
+    private final String host;
+
+    private final String path;
+
+    private String queryString;
+
+    public UiActivityUri(String host, String path) {
+        this.host = host;
+        this.path = path;
+    }
+
+
+    @SchemeDef
+    public String getScheme() {
+        return scheme;
+    }
+
+    public void setScheme(@SchemeDef String scheme) {
+        this.scheme = scheme;
+    }
+
+    public String getHost() {
+        return host;
+    }
+
+    public String getPath() {
+        return path;
+    }
+
+    public void setQueryString(String queryString) {
+        this.queryString = queryString;
+    }
+
+    public String getQueryString() {
+        return queryString;
+    }
+
+
+
+    //    public  String getUri() {
+//
+//    }
+
+}

componentlib/src/main/java/com/mrzhang/component/componentlib/router/ui/UIRouter.java

@@ -3,12 +3,18 @@
 import android.content.Context;
 import android.net.Uri;
 import android.os.Bundle;
+import android.support.annotation.NonNull;
 import android.text.TextUtils;
 
+import com.ljsw.router.facade.Constants;
+import com.ljsw.router.facade.annotation.Router;
+
+import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Singleton implement of {@link IUIRouter}
@@ -18,6 +24,7 @@
  */
 
 public class UIRouter implements IUIRouter {
+    private static Map<String, IComponentRouter> routerInstanceCache = new HashMap<>();
 
     private List<IComponentRouter> uiRouters = new ArrayList<>();
     private HashMap<IComponentRouter, Integer> priorities = new HashMap<>();
@@ -124,4 +131,33 @@ private void removeOldUIRouter(IComponentRouter router) {
             }
         }
     }
+
+    public static IComponentRouter fetch(@NonNull Class<? extends IComponentRouter> clz) {
+        if (!clz.isInterface())
+            throw new IllegalArgumentException("need a interface, but this isn't a interface:" + clz.getName());
+
+        Router router = clz.getAnnotation(Router.class);
+        if (router == null)
+            throw new IllegalArgumentException("not annotated with Router:" + clz.getName());
+
+        String path = Constants.ROUTERIMPL_OUTPUT_PKG +
+                Constants.DOT + router.group() + Constants.DOT + clz.getSimpleName() + "Impl";
+        if (routerInstanceCache.containsKey(path))
+            return routerInstanceCache.get(path);
+
+        try {
+            Class cla = Class.forName(path);
+            IComponentRouter instance = (IComponentRouter) cla.newInstance();
+            routerInstanceCache.put(path, instance);
+            return instance;
+        } catch (ClassNotFoundException e) {
+            e.printStackTrace();
+        } catch (InstantiationException e) {
+            e.printStackTrace();
+        } catch (IllegalAccessException e) {
+            e.printStackTrace();
+        }
+
+        return null;
+    }
 }

readercomponent/src/main/java/com/mrzhang/reader/ReaderFragment.java

@@ -36,7 +36,8 @@ public void onClick(View v) {
                     final String _dto = "{\"s\":\"sss\"}";
                     bundle.putString("bookName","testBookName");
                     bundle.putString("testDto",_dto);
-                    UIRouter.getInstance().openUri(getActivity(), "componentdemo://share", bundle);
+                    UIRouter.getInstance().openUri(getActivity(), "dunb://shareComponent/share", bundle);
+//                    "componentdemo://share"
                 }
             });
 

router-anno-compiler/build.gradle

@@ -3,7 +3,7 @@ apply plugin: 'java'
 dependencies {
     compile fileTree(include: ['*.jar'], dir: 'libs')
     compile 'com.google.auto.service:auto-service:1.0-rc2'
-    compile 'com.squareup:javapoet:1.7.0'
+    compile 'com.squareup:javapoet:1.9.0'
 
 
     compile 'org.apache.commons:commons-lang3:3.4'

router-anno-compiler/src/main/java/com/ljsw/router/compiler/model/GroupInfo.java

@@ -0,0 +1,35 @@
+package com.ljsw.router.compiler.model;
+
+import javax.lang.model.type.TypeMirror;
+
+/**
+ * <p><b>Package:</b> com.ljsw.router.compiler.model </p>
+ * <p><b>Project:</b> DDComponentForAndroid </p>
+ * <p><b>Classname:</b> HostInfo </p>
+ * <p><b>Description:</b> TODO </p>
+ * Created by leobert on 2017/9/25.
+ */
+
+public class GroupInfo {
+    private String host;
+    private String outPutPath;
+    private String interfacePath;
+
+    public GroupInfo(String host, String outPutPath, String interfacePath) {
+        this.host = host;
+        this.outPutPath = outPutPath;
+        this.interfacePath = interfacePath;
+    }
+
+    public String getHost() {
+        return host;
+    }
+
+    public String getOutPutPath() {
+        return outPutPath;
+    }
+
+    public String getInterfacePath() {
+        return interfacePath;
+    }
+}

router-anno-compiler/src/main/java/com/ljsw/router/compiler/model/MethodInfo.java

@@ -0,0 +1,98 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2017 leobert-lan
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package com.ljsw.router.compiler.model;
+
+import com.squareup.javapoet.ClassName;
+import com.squareup.javapoet.ParameterSpec;
+import com.squareup.javapoet.TypeName;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.lang.model.element.Modifier;
+import javax.lang.model.element.VariableElement;
+import javax.lang.model.type.TypeMirror;
+
+/**
+ * Description: Helper class to record method info needed by Processor
+ */
+public class MethodInfo {
+    private String methodName;
+    private List<Modifier> methodModifiers;
+    private List<VariableElement> methodParameters;
+    private TypeMirror methodReturnType;
+
+    public MethodInfo() {
+    }
+
+    public MethodInfo setMethodName(String methodName) {
+        this.methodName = methodName;
+        return this;
+    }
+
+    public MethodInfo setMethodModifiers(List<Modifier> methodModifiers) {
+        this.methodModifiers = methodModifiers;
+        return this;
+    }
+
+    public MethodInfo setMethodParameters(List<VariableElement> methodParameters) {
+        this.methodParameters = methodParameters;
+        return this;
+    }
+
+    public MethodInfo setMethodReturnType(TypeMirror methodReturnType) {
+        this.methodReturnType = methodReturnType;
+        return this;
+    }
+
+    public String getMethodName() {
+        return methodName;
+    }
+
+    public List<Modifier> getMethodModifiers() {
+        return methodModifiers;
+    }
+
+    public List<ParameterSpec> getMethodParameters() {
+        List<ParameterSpec> parameterSpecs = new ArrayList<>();
+        for (VariableElement variableElement : methodParameters) {
+            parameterSpecs.add(ParameterSpec.get(variableElement));
+        }
+        return parameterSpecs;
+    }
+
+    public List<String> getMethodParametersSimple() {
+        List<String> params = new ArrayList<>();
+        for (VariableElement methodParameter : methodParameters) {
+            params.add(methodParameter.getSimpleName().toString());
+        }
+        return params;
+    }
+
+    public TypeName getTypeName() {
+        return ClassName.get(methodReturnType);
+    }
+}