ActivityRouter路由框架:通过注解实现URL打开Activity
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
app
base
build-map/src/main/groovy/cn/taoweiji/gradle
gradle/wrapper
other_module
router-annotation
router-compiler
router
.gitignore
LICENSE
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

基于apt技术,通过注解方式来实现URL打开Activity功能,并支持在WebView和外部浏览器使用,支持多级Activity跳转,支持Bundle、Uri参数注入并转换参数类型。

特点

  1. 支持注解方式、手动方式注册Activity。
  2. 支持注入Bundle、Uri的参数并转换格式。
  3. 支持多级跳转。
  4. 支持外部浏览器打开。
  5. 支持HTTP协议。
  6. 支持目标Activity的URL构造器访问。
  7. 支持多个Module。

简单例子

@RouterActivity("second")
public class SecondActivity extends Activity {
    @RouterField("uid")
    private int uid;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        Router.inject(this);
        Log.e("uid", String.valueOf(uid));
    }
}
Router.init("test");//设置Scheme
// 方式一
RouterHelper.getSecondActivityHelper().withUid(24).start(this);
// 方式二
Router.startActivity(context, "test://second?uid=233");
// 方式三
// 如果AndroidManifest.xml注册了RouterCenterActivity,也可以通过下面的方式打开,如果是APP内部使用,不建议使用。
// startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("test://second?uid=233")));

目标Activity的URL构造器访问

使用URL访问有一个缺点就是难以得以目标Activity所需要的参数,同时也需要手工生成URL,使用并不友好,填写的参数名称也容易出错。所以我们就做了一个用于生成目标Activity的URL构造器,减少我们写参数名的代码。会根据注解了RouterField的成员变量生成构造器。

// Router.startActivity(context, "test://second?uid=233&name=Wiki");
RouterHelper.getSecondActivityHelper().withUid(233).withName("Wiki").start(this);
// Router.startActivityForResult(context, "test://second?uid=233&name=Wiki",1);
RouterHelper.getSecondActivityHelper().withUid(233).withName("Wiki").startForResult(this,1);
//也可以这样写 new SecondActivityHelper().withUid(233).withName("Wiki").startForResult(this,1);

多级跳转

@RouterActivity("third")
public class ThirdActivity extends BaseActivity {
    @RouterField("uid")
    private int uid;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_third);
        Router.inject(this);
        Log.e("uid", String.valueOf(uid));
    }
}
// 先打开SecondActivity,再打开ThirdActivity
Router.startActivity(context, "test://second/third?uid=233");

Bundle、Uri参数注入(支持单独使用)

Router.inject(this)方法可以单独使用,可以实现注入Bundle、Uri的参数,由于Uri的参数是String类型,所以该框架还支持把String格式的类型转换为目标类型。目前该方法支持double、float、int、boolean、String数据类型。

// Bundle
Intent intent = new Intent(this, SecondActivity.class);
intent.putExtra("uid", "233");
startActivity(intent);
// Uri
Intent intent = new Intent(this, SecondActivity.class);
intent.setData(Uri.parse("test://second?uid=233"));
startActivity(intent);
// Bundle、Uri
Intent intent = new Intent(this, SecondActivity.class);
intent.setData(Uri.parse("test://second?uid=233"));
intent.putExtra("name", "Wiki");
startActivity(intent);
@RouterActivity("second")
public class SecondActivity extends Activity {
    @RouterField("uid")
    private int uid;
    @RouterField("name")
    private String name;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        Router.inject(this);
        Log.e("uid", String.valueOf(uid));
        Log.e("name", String.valueOf(name));
    }
}

从外部浏览器、其它APP打开

只要在AndroidManifest.xml注册了RouterCenterActivity,即可变成经典的Uri打开,可以支持外部浏览器、其它APP打开内部的Activity。

<activity android:name="com.thejoyrun.router.RouterCenterActivity">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="test" />
    </intent-filter>
</activity>
// Java代码调用
startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("test://second?uid=233&name=Wiki")));
// HTML方式,系统浏览器(不支持微信)
<a href="test://second?uid=233&name=Wiki">打开JoyrunApp的SecondActivity</a>

支持HTTP协议

<activity android:name="com.thejoyrun.router.RouterCenterActivity">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:host="www.thejoyrun.com" android:scheme="http" />
    </intent-filter>
</activity>

如果支持HTTP协议,那么URL的结构就要做些修改

// test://second?uid=233
// =>
http://www.thejoyrun.com/second?uid=233

使用方式

配置根目录的build.gradle

allprojects {
	repositories {
		...
		maven { url "https://jitpack.io" }
	}
	dependencies {
        classpath 'com.android.tools.build:gradle:1.5.0'
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}

配置app module的build.gradle

apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt'

dependencies {
    compile 'com.github.joyrun.ActivityRouter:router:0.6.2'
    apt 'com.github.joyrun.ActivityRouter:router-compiler:0.6.2'
}

初始化

建议在Application进行初始化

// 必填,填写独特的scheme,避免和其它APP重复
Router.init("test");
// 可选,如果需要支持HTTP协议就需要填写
Router.setHttpHost("www.thejoyrun.com");
// 可选,手工注册Activity
Router.register(new RouterInitializer() {
    @Override
    public void init(Map<String, Class<? extends Activity>> router) {
        router.put("second2", SecondActivity.class);
        router.put("other://www.thejoyrun.com/second", SecondActivity.class);
    }
});
// 可选,针对自己的业务做调整
Router.setFilter(new Filter() {
    public String doFilter(String url) {
    	//return url.replace("test://www.thejoyrun.com/","test://");
        return url;
    }
});

配置AndroidManifest

如果需要从外部浏览器打开,就要注册

<activity android:name="com.thejoyrun.router.RouterCenterActivity">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:host="www.thejoyrun.com" android:scheme="http" />
    </intent-filter>
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="test" />
    </intent-filter>
</activity>

其它说明

多对一映射

一个Activity支持配置多个路径,也支持完整的URL配置

@RouterActivity({"second", "second2", "other2://www.thejoyrun.com/second", "test://www.thejoyrun.com/second"})
public class SecondActivity extends Activity {}

手工注册Activity

手工注册,也支持路径注册,也支持完整路径注册,支持多种scheme

Router.register(new RouterInitializer() {
    @Override
    public void init(Map<String, Class<? extends Activity>> router) {
        router.put("second2", SecondActivity.class);
        router.put("other://www.thejoyrun.com/second", SecondActivity.class);
    }
});

URL过滤器

通过URL过滤器可以对URL进行过滤,可以通过过滤器对URL进行修改,也可以拦截URL,不让路由器打开。

Router.setFilter(new Filter() {
    public String doFilter(String url) {
    	//return url.replace("test://www.thejoyrun.com/","test://");
        return url;
    }
});

支持多个Module

ActivityRouter框架支持多个Module,以适应多个Module的项目,首先需要在module的build.gradle添加:

apt {
    arguments {
        targetModuleName 'SomeUniqueModuleName'
    }
}

SomeUniqueModuleName改成这个module专属的名称,然后在主项目初始化的时候添加:

Router.init("test");
Router.register(new SomeUniqueModuleNameRouterInitializer());

Module的Activity的URL构造器,中心类名就变成了SomeUniqueModuleNameRouterHelper

混淆

如果项目用到了混淆,记得需要添加下面代码到proguard-rules

-keep class * extends com.thejoyrun.router.RouterInitializer { *; }

License

Copyright 2016 Joyrun, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.