路由存在的意義
- 模組間解耦,不需要再類中明確跳轉目標的類名
- 動態配置,業務需求原因,部分諸如banner頁等地方的地址需要動態可配的,這個時候就不方便寫死類名,路由是一個比較好的解決方式。
前言
本文會講解一下如何編寫一個簡單的路由。在講解路由之前,需要先了解一下android下的註解(annotation),註解不單單是路由的重要組成部分,目前主流的各大框架都有註解的成分在。
實際上我們通過一個註解就能完成的譬如繫結控制元件,路由跳轉等操作,都是因為註解處理器幫我們生成了對應程式碼來幫我們實現上述的操作。
下面就來講解下路由跳轉的實現，另外註解的相關知識，可參考 淺談Android下的註解
路由跳轉
正常情況下Activity之間的跳轉如下
Intent intent=new Intent(this,TestActivity.class);
startActivity(intent);
複製程式碼而路由跳轉的原理實際上執行的也是類似的程式碼,只不過路由執行的是註解生成的邏輯程式碼。專案下所有註解的Activity會以Map的形式儲存下來,類似於下面這樣的邏輯.
public static void initActivityMap(HashMap<String, Class> activityMap) {
activityMap.put("test", TestActivity1.class);
activityMap.put("test2", TestActivity2.class);
}
複製程式碼然後在傳入test這樣的字串,通過遍歷map找到對應的TestActivity1這樣的目標Activity。最後執行startActivity()實現跳轉,上述就是一個簡單的路由的跳轉。
具體實現
在工程下建立如下幾個module
--app (主工程)
--route_annotation (java module 自定義註解)
--route-api (Android module)
--route_compiler (java module 註解處理器邏輯)
複製程式碼route_annotation 定義註解
一個很簡單的註解介面
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Route {
String [] value();
}
複製程式碼route_compiler 註解處理器邏輯
新建一個註解處理器的類RouteProcessor 繼承自AbstractProcessor
具體實現
@AutoService(Processor.class)
public class RouteProcessor extends AbstractProcessor {
private Messager mMessager;
private Filer mFiler;
@Override
public synchronized void init(ProcessingEnvironment processingEnvironment) {
super.init(processingEnvironment);
mMessager = processingEnv.getMessager();
mFiler = processingEnv.getFiler();
}
@Override
public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
Set<? extends Element> routeElements = roundEnvironment.getElementsAnnotatedWith(Route.class);
try {
TypeSpec typeSpec = processRouterTable(routeElements);
if (typeSpec != null) {
JavaFile.builder("com.dly.routeDemo", typeSpec).build().writeTo(mFiler);
}
} catch (Exception e) {
e.printStackTrace();
error(e.getMessage());
}
return true;
}
private TypeSpec processRouterTable(Set<? extends Element> elements) {
//注意這裡一定要做判空處理,因為apt會多次掃描專案所有檔案包括javaPoet生成的檔案.
//不做這步處理的話,第一次生成你需要的檔案,第二次再進行掃描的時候,又會去生成檔案,那時系統就會報一個異常,提示不能生成相同的檔案
if (elements == null || elements.size() == 0) {
return null;
}
ParameterizedTypeName mapTypeName = ParameterizedTypeName
.get(ClassName.get(HashMap.class), ClassName.get(String.class),
ClassName.get(Class.class));
ParameterSpec mapParameterSpec = ParameterSpec.builder(mapTypeName, "activityMap")
.build();
MethodSpec.Builder routerInitBuilder = MethodSpec.methodBuilder("initActivityMap")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.addParameter(mapParameterSpec);
for (Element element : elements) {
Route route = element.getAnnotation(Route.class);
String[] routerUrls = route.value();
for (String url : routerUrls) {
//核心邏輯 將字元與類做對映關聯
routerInitBuilder.addStatement("activityMap.put($S, $T.class)", url, ClassName.get((TypeElement) element));
}
}
return TypeSpec.classBuilder("AutoCreateModuleActivityMap_app")
.addModifiers(Modifier.PUBLIC)
.addMethod(routerInitBuilder.build())
.build();
}
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> ret = new HashSet<>();
ret.add(Route.class.getCanonicalName());
return ret;
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latestSupported();
}
private void error(String error) {
mMessager.printMessage(Diagnostic.Kind.ERROR, error);
}
}
複製程式碼上述RouteProcessor類會在AS編譯完成之後,會在目錄app/build/generated/source/apt/debug/專案名 下生產一個java檔案。
public class AutoCreateModuleActivityMap_app {
public static void initActivityMap(HashMap<String, Class> activityMap) {
activityMap.put("test", TestActivity1.class);
activityMap.put("test2", TestActivity2.class);
}
}
複製程式碼這個java檔案會儲存你註解過的類以及對於字串之間的對映關係。
route_api 需要執行具體的跳轉邏輯 即我們熟悉的startActivity
新建RouteDemo.class
public class RouteDemo {
private static HashMap<String, Class> activityMap = new HashMap<>();
private static Application mApplication;
public static void init(Application application) {
mApplication = application;
try {
//通過反射呼叫AutoCreateModuleActivityMap_app類的方法,並給activityMap賦值
Class clazz = Class.forName("com.dly.routeDemo.AutoCreateModuleActivityMap_app");
Method method = clazz.getMethod("initActivityMap", HashMap.class);
method.invoke(null, activityMap);
for (String key : activityMap.keySet()) {
System.out.println("activityMap = " + activityMap.get(key));
}
} catch (Exception e) {
e.printStackTrace();
}
}
public static void open(String url) {
for (String key : activityMap.keySet()) {
if (url.equals(key)) {
Intent intent = new Intent(mApplication, activityMap.get(key));
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK );
mApplication.startActivity(intent);
}
}
}
}
複製程式碼一個簡單的反射呼叫給我們自己定義的ActivityMap賦值.這樣的話我們就擁有了ActivityMap的集合了。
app 主工程
定義一個MyApplication用來初始化路由
public class MyApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
RouteDemo.init(this);
}
}
複製程式碼然後MainActivity下執行路由跳轉即可。
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Intent intent=new Intent(this,TestActivity.class);
startActivity(intent);
}
public void onClick(View v) {
switch (v.getId()) {
case R.id.text1:
RouteDemo.open("test");
break;
case R.id.text2:
RouteDemo.open("test2");
break;
}
}
}
複製程式碼對應的TestActivity1
@Route("test")
public class TestActivity1 extends AppCompatActivity {
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_test);
}
}
複製程式碼上述幾個流程就完成了一個最為簡單的路由跳轉,當然我們需要的可不僅僅只是一個跳轉,還需要攜帶引數跳轉,,或者跳轉攔截等等需求.
而這些需求會在之後的文章中慢慢講解。