A framework for assisting in the renovation of Android app componentization

中文文档

Lastest version

module	arouter-api	arouter-compiler	arouter-register	arouter-idea-plugin
version

Demo

Demo apk、Demo Gif

I. Feature

1. Supports direct parsing of standard URLs for jumps and automatic injection of parameters into target pages
2. Support for multi-module
3. Support for interceptor
4. Support for dependency injection
5. InstantRun support
6. MultiDex support
7. Mappings are grouped by group, multi-level management, on-demand initialization
8. Supports users to specify global demotion and local demotion strategies
9. Activity, interceptor and service can be automatically registered to the framework
10. Support multiple ways to configure transition animation
11. Support for fragment
12. Full kotlin support (Look at Other#2)
13. Generate route doc support
14. Provide IDE plugin for quick navigation to target class
15. Support Incremental annotation processing
16. Support register route meta dynamic.

II. Classic Case

1. Forward from external URLs to internal pages, and parsing parameters
2. Jump and decoupling between multi-module
3. Intercept jump process, handle login, statistics and other logic
4. Cross-module communication, decouple components by IoC

III. Configuration

1. Adding dependencies and configurations ``` gradle android { defaultConfig { ... javaCompileOptions { annotationProcessorOptions { arguments = [AROUTER_MODULE_NAME: project.getName()] } } } }

   dependencies { // Replace with the latest version compile 'com.alibaba:arouter-api:?' annotationProcessor 'com.alibaba:arouter-compiler:?' ... } // Old version of gradle plugin (< 2.2), You can use apt plugin, look at 'Other#1' // Kotlin configuration reference 'Other#2' ```

2. Add annotations java // Add annotations on pages that support routing (required) // The path here needs to pay attention to need at least two levels : /xx/xx @Route(path = "/test/activity") public class YourActivity extend Activity { ... }

3. Initialize the SDK java if (isDebug()) { // These two lines must be written before init, otherwise these configurations will be invalid in the init process ARouter.openLog(); // Print log ARouter.openDebug(); // Turn on debugging mode (If you are running in InstantRun mode, you must turn on debug mode! Online version needs to be closed, otherwise there is a security risk) } ARouter.init(mApplication); // As early as possible, it is recommended to initialize in the Application

4. Initiate the routing ``` java // 1. Simple jump within application (Jump via URL in 'Advanced usage') ARouter.getInstance().build("/test/activity").navigation();

   // 2. Jump with parameters ARouter.getInstance().build("/test/1") .withLong("key1", 666L) .withString("key3", "888") .withObject("key4", new Test("Jack", "Rose")) .navigation(); ```

5. Add confusing rules (If Proguard is turn on) ``` -keep public class com.alibaba.android.arouter.routes.{*;} -keep public class com.alibaba.android.arouter.facade.{;} -keep class * implements com.alibaba.android.arouter.facade.template.ISyringe{;}

   If you use the byType method to obtain Service, add the following rules to protect the interface:

   -keep interface * implements com.alibaba.android.arouter.facade.template.IProvider

   If single-type injection is used, that is, no interface is defined to implement IProvider, the following rules need to be added to protect the implementation

   -keep class * implements com.alibaba.android.arouter.facade.template.IProvider

   ```

6. Using the custom gradle plugin to autoload the routing table ```gradle apply plugin: 'com.alibaba.arouter'

   buildscript { repositories { mavenCentral() }

   dependencies {
       // Replace with the latest version
       classpath "com.alibaba:arouter-register:?"
   }
   

   } ```

   Optional, use the registration plugin provided by the ARouter to automatically load the routing table(power by AutoRegister). By default, the ARouter will scanned the dex files . Performing an auto-registration via the gradle plugin can shorten the initialization time , it should be noted that the plugin must be used with api above 1.3.0!

7. use ide plugin for quick navigation to target class (Optional)

   Search for ARouter Helper in the Android Studio plugin market, or directly download the arouter-idea-plugin zip installation package listed in the Latest version above the documentation, after installation plugin without any settings, U can find an icon at the beginning of the jump code. () click the icon to jump to the target class that identifies the path in the code.

IV. Advanced usage

1. Jump via URL ``` java // Create a new Activity for monitoring Scheme events, and then directly pass url to ARouter public class SchemeFilterActivity extends Activity { @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState);

       Uri uri = getIntent().getData();
       ARouter.getInstance().build(uri).navigation();
       finish();
   }
   

   } ```

   AndroidManifest.xml ``` xml

   <intent-filter>
       <data
           android:host="m.aliyun.com"
           android:scheme="arouter"/>
   
       <action android:name="android.intent.action.VIEW"/>
   
       <category android:name="android.intent.category.DEFAULT"/>
       <category android:name="android.intent.category.BROWSABLE"/>
   </intent-filter>
   

   ```

2. Parse the parameters in the URL ``` java // Declare a field for each parameter and annotate it with @Autowired @Route(path = "/test/activity") public class Test1Activity extends Activity { @Autowired public String name; @Autowired int age; @Autowired(name = "girl") // Map different parameters in the URL by name boolean boy; @Autowired TestObj obj; // Support for parsing custom objects, using json pass in URL

   @Override
   protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       ARouter.getInstance().inject(this);
   
       // ARouter will automatically set value of fields
       Log.d("param", name + age + boy);
   }
   

   }

   // If you need to pass a custom object, Create a new class(Not the custom object class),implement the SerializationService, And use the @Route annotation annotation, E.g: @Route(path = "/yourservicegroupname/json") public class JsonServiceImpl implements SerializationService { @Override public void init(Context context) {

   }
   
   @Override
   public <T> T json2Object(String text, Class<T> clazz) {
       return JSON.parseObject(text, clazz);
   }
   
   @Override
   public String object2Json(Object instance) {
       return JSON.toJSONString(instance);
   }
   

   } ```

3. Declaration Interceptor (Intercept jump process, AOP) ``` java // A more classic application is to handle login events during a jump so that there is no need to repeat the login check on the target page. // Interceptors will be executed between jumps, multiple interceptors will be executed in order of priority @Interceptor(priority = 8, name = "test interceptor") public class TestInterceptor implements IInterceptor { @Override public void process(Postcard postcard, InterceptorCallback callback) { ... // No problem! hand over control to the framework callback.onContinue(postcard);

       // Interrupt routing process
       // callback.onInterrupt(new RuntimeException("Something exception"));
   
       // The above two types need to call at least one of them, otherwise it will not continue routing
   }
   
   @Override
   public void init(Context context) {
       // Interceptor initialization, this method will be called when sdk is initialized, it will only be called once
   }
   

   } ```

4. Processing jump results ``` java // U can get the result of a single jump ARouter.getInstance().build("/test/1").navigation(this, new NavigationCallback() { @Override public void onFound(Postcard postcard) { ... }

   @Override
   public void onLost(Postcard postcard) {
   ...
   }
   

   }); ```

5. Custom global demotion strategy ``` java // Implement the DegradeService interface @Route(path = "/xxx/xxx") public class DegradeServiceImpl implements DegradeService { @Override public void onLost(Context context, Postcard postcard) { // do something. }

   @Override
   public void init(Context context) {
   
   }
   

   } ```

6. Decoupled by dependency injection : Service management -- Exposure services ``` java // Declaration interface, other components get the service instance through the interface public interface HelloService extends IProvider { String sayHello(String name); }

   @Route(path = "/yourservicegroupname/hello", name = "test service") public class HelloServiceImpl implements HelloService {

   @Override
   public String sayHello(String name) {
       return "hello, " + name;
   }
   
   @Override
   public void init(Context context) {
   
   }
   

   } ```

7. Decoupled by dependency injection : Service management -- Discovery service ``` java public class Test { @Autowired HelloService helloService;

   @Autowired(name = "/yourservicegroupname/hello")
   HelloService helloService2;
   
   HelloService helloService3;
   
   HelloService helloService4;
   
   public Test() {
       ARouter.getInstance().inject(this);
   }
   
   public void testService() {
       // 1. Use Dependency Injection to discover services, annotate fields with annotations
       helloService.sayHello("Vergil");
       helloService2.sayHello("Vergil");
   
       // 2. Discovering services using dependency lookup, the following two methods are byName and byType
       helloService3 = ARouter.getInstance().navigation(HelloService.class);
       helloService4 = (HelloService) ARouter.getInstance().build("/yourservicegroupname/hello").navigation();
       helloService3.sayHello("Vergil");
       helloService4.sayHello("Vergil");
   }
   

   } ```

8. Pretreatment Service ``` java @Route(path = "/xxx/xxx") public class PretreatmentServiceImpl implements PretreatmentService { @Override public boolean onPretreatment(Context context, Postcard postcard) { // Do something before the navigation, if you need to handle the navigation yourself, the method returns false }

   @Override
   public void init(Context context) {
   
   }
   

   } ```

9. Dynamic register route meta Applicable to apps with plug-in architectures or some scenarios where routing information needs to be dynamically registered，Dynamic registration can be achieved through the interface provided by ARouter, The target page and service need not be marked with @Route annotation，Only the routing information of the same group can be registered in the same batch ``` java ARouter.getInstance().addRouteGroup(new IRouteGroup() { @Override public void loadInto(Map atlas) { atlas.put("/dynamic/activity", // path RouteMeta.build( RouteType.ACTIVITY, // Route type TestDynamicActivity.class, // Target class "/dynamic/activity", // Path "dynamic", //