AndRouter Documentation

The ActivityRouter maps URLs to Android Activities. You can initialize it in your Application class using two different methods:

1. Using Java Annotations

Annotate your Activity classes with @RouterMap containing the desired URLs. Then, call Router.initActivityRouter(Context) in your Application's onCreate().

2. Using an Initializer Class

Provide an implementation of IActivityRouteTableInitializer to manually map URLs to Activity classes. This is useful for dynamic routing or complex path patterns.

// Method 1: Annotation
@RouterMap({"activity://second", "activity://second2"})
public class SecondActivity extends Activity { ... }

// In Application class
public class App extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        Router.initActivityRouter(getApplicationContext());
    }
}

// Method 2: Initializer class
Router.initActivityRouter(getApplicationContext(), new IActivityRouteTableInitializer() {
    @Override
    public void initRouterTable(Map<String, Class<? extends Activity>> router) {
        router.put("activity://first/:s{name}/:i{age}/birthday", FirstActivity.class);
    }
});

You can extend the routing capabilities by implementing BaseRouter and BaseRoute.

1. Implement BaseRouter: Define how to open routes, how to retrieve a route object from a URL, and which scheme your router handles via canOpenTheUrl.
2. Implement BaseRoute: Define the specific logic for the route instance.
3. Register: Add your router instance to the RouterManager using Router.addRouter(new YourCustomRouter()).

private static class TestRouter extends BaseRouter {
    @Override
    public void open(IRoute route) { Timber.i(route.getUrl()); }

    @Override
    public void open(String url) { Timber.i(url); }

    @Override
    public IRoute getRoute(String url) { return new TestRoute(this, url); }

    @Override
    public boolean canOpenTheRoute(IRoute route) { return (route instanceof TestRoute); }

    @Override
    public boolean canOpenTheUrl(String url) { 
        return TextUtils.equals(UrlUtils.getScheme(url), "test"); 
    }

    @Override
    public Class<? extends IRoute> getCanOpenRoute() { return TestRoute.class; }
}

private static class TestRoute extends BaseRoute {
    public TestRoute(IRouter router, String url) { super(router, url); }
}

// Register the router
Router.addRouter(new TestRouter());

Once initialized, you can use the Router class to navigate between activities using URLs. AndRouter provides several ways to handle the transition:

• Basic Open: Router.open(String url)
• With Animation: Use Router.getRoute(url) to get an ActivityRoute object, then call .setAnimation(context, enterAnim, exitAnim).open().
• For Result: Use .withOpenMethodStartForResult(context, requestCode).open() to handle onActivityResult.
• With Extra Parameters: Use .withParams(key, value).open() to add additional data to the Intent that isn't part of the URL path.

// Basic open
Router.open("activity://second/汤二狗");

// Open with animation
ActivityRoute activityRoute = (ActivityRoute) Router.getRoute("activity://second/汤二狗");
activityRoute.setAnimation(this, R.anim.in_from_left, R.anim.out_to_right).open();

// Open for result
((ActivityRoute) Router.getRoute("activity://second/汤二狗"))
    .withOpenMethodStartForResult(this, 200)
    .open();

// Add extra parameters
((ActivityRoute) Router.getRoute("activity://third"))
    .withParams("date", new Date())
    .open();