LRouter

KO | EN

gitlite — search

#hacktoberfest #typescript #golang #go #android #machine-learning #rust #deep-learning #macos #nodejs #awesome-list #vue #mcp #openai

(★ 18)

Android路由框架（支持多进程多模块,请求拦截,rxjava）

LRouter 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Android项目路由框架
![Logo](https://github.com/yuzhijun/LRouter/blob/master/app/src/main/logo/app_logo.png)
```
此框架是多进程多模块支持拦截,注解用法的框架
```
---
#### 功能：
1.**支持跨进程访问其他模块** 							
2.**支持跨进程请求拦截** 								
3.**支持功能类注解注入(AnnotationProcessor方式)** 	
4.**支持Intent跳转拦截** 
5.**模块间频繁通讯socket**

#### TODO：
1.请求路由的管理 
2.请求链接为uri则直接跳转

## 1.开始使用

### 1.1.在项目中集成

```
1.首先我们需要在主APP工程里面和module工程里面都添加进依赖库工程（完善版本之后会上传至jcenter）
lrouter-api（多进程多模块框架库）和rxlrouter-api（扩展框架支持rxjava）
2.然后在主APP工程和module工程里面添加AnnotationProcessor的依赖
    compile project(':lrouter-annotation')
    annotationProcessor project(':lrouter-compiler')
```

### 1.2.创建自定义applicaiton

创建自定义applicaiton继承自LRouterAppcation
```
public class MainApplication extends LRouterAppcation {

}
```

然后在AndroidManifest.xml中加入

```
<application
 ...
 android:name=".CustomApplication"
 ...
 >
 ...
</application>
```
### 1.3.创建自定义类applicaiton

因为多进程application会执行多次，为了让每个进程初始化都能初始化自己的模块的逻辑所以定义了类applicaiton
```
@Application(name = "com.lenovohit.lrouter",priority = 999)
public class MainAnologyApplication extends AnologyApplication {
}
```
其中@Application注解name为进程名字，priority为优先级

### 1.4.实现Provider

一个工程或者模块只有一个provider，创建方法如下：
```
@Provider(name = "main")
public class MainProvider extends LRProvider {
 
}
```
其中@Provider注解中name字段是根据自己喜好可以随意取得，但是尽量取一个有意义的名字

### 1.5.实现Action

一个action代表一个要执行的动作，用于跨模块的调用（跨进程跨模块也是action）
```
@Action(name = "main",provider = "main")
public class MainAction extends LRAction {//动作的执行
}
```
其中@Action注解name也是根据自己喜好取得，provider名字必须跟之前创建的provider名字一致
```
 @Override
    public boolean needAsync(Context context, LRouterRequest requestData) {

return false;
    }
```
这个标识标志了是异步访问还是同步访问
### 1.6.多进程支持

如果需要开启多进程则需要在applicaiton的方法设置为true
```
  @Override
    public boolean needMultipleProcess() {
        return true;
    }
```

### 1.7.创建本地跨进程通讯的service
因为跨进程用AIDL通讯，所以每个工程在多进程情况下都需要创建这个service用于本地进程与远程进程的通讯
```
@Service(name = "com.lenovohit.lrouter")
public class MainRouterConnectService extends LocalRouterService {
}
其中@Service注解的name应为进程名
```
### 1.8.跨进程请求拦截器

跨进程请求拦截器是为了做埋点检测等功能实现的
```
@Interceptor
public class AppInterceptor extends AopInterceptor {
    @Override
    public void enterRequestIntercept(String methodName, String[] paramNames, Object[] paramValues) {
      
    }

@Override
    public void exitRequestIntercept(String methodName, String[] paramNames, Object[] paramValues, long lengthMillis) {

}
}
```
其中enterRequestIntercept即为进入请求方法前执行，exitRequestIntercept即为请求方法后执行，拦截器可以创建多个

### 1.9.Intent请求拦截器

想要拦截activity跳转到另外activity请求则可以通过继承StartupInterceptor，然后用@IntentInterceptor注解
```
@IntentInterceptor
public class StartInterceptor extends StartupInterceptor {
}
```
### 2.0.创建支持socket通信的Action
某些需求需要频繁通信，则需要创建action继承SocketAction
```
@Action(name = "ModulebSocketAction",provider = "ModuleBProvider")
public class ModulebSocketAction extends LRSocketAction {
    @Override
    public String socketInvoke(String receiveStr) {
        return receiveStr;
    }

@Override
    public int socketPort() {
        return 10001;
    }
}
```
其中name为action的名字根据自己喜欢定，provider为模块唯一的provider
## 2.调用方法

### 2.1.模块内无跨进程同步调用方法

只需要指明provider和actin和要传的参数即可
```
LocalRouter.ListenerFutureTask response =  LocalRouter.getInstance(LRouterAppcation.getInstance())
                                    .navigation(MainActivity.this, LRouterRequest.getInstance(MainActivity.this)
                                    .provider("main")
                                    .action("main")
                                    .param("1", "Hello")
                                    .param("2", "World"));                              
``` 
response.get();直接获取请求结果
  
### 2.2.跨模块跨进程异步调用方法

此处建议跨模块跨进程最好使用异步调用
```
LocalRouter.ListenerFutureTask response = LocalRouter.getInstance(LRouterAppcation.getInstance())
                            .navigation(MainActivity.this, LRouterRequest.getInstance(MainActivity.this)
                                    .processName("com.lenovohit.lrouter:moduleB")
                                    .provider("ModuleBProvider")
                                    .action("ModuleBAction")
                                    .param("1", "Hello")
                                    .param("2", "Annotation")
                                    .reqeustObject(new User("yuzhijun","123456")))
                            .setCallBack(new IRequestCallBack() {
                                @Override
                                public void onSuccess(final String result) {
                                    Toast.makeText(MainActivity.this,result,Toast.LENGTH_SHORT).show();
                                }

@Override
                                public void onFailure(Exception e) {

}
                            });
```
processName表示要访问的进程名字，provider表示要访问的provider，action表示要执行的动作，param表示要传的参数，reqeustObject表示传的对象参数
  
### 2.3.使用rxjava方式访问

如果引入了rxlrouter-api则可以使用rxjava的方式进行访问
```
RxLocalLRouter.getInstance(LRouterAppcation.getInstance())
 .rxProxyNavigation(MainActivity.this,LRouterRequest.getInstance(MainActivity.this)
 .processName("com.lenovohit.lrouter:moduleA")
 .provider("bussinessModuleA")
 .action("bussinessModuleA")
 .param("1", "Hello")
 .param("2", "Thread"))
 .subscribeOn(Schedulers.from(LocalRouter.getThreadPool()))
 .observeOn(AndroidSchedulers.mainThread())
 .subscribe(new Consumer<String>() {
 @Override
 public void accept(String s) throws Exception {
 Toast.makeText(MainActivity.this,s,Toast.LENGTH_SHORT).show();
 }
 }, new Consumer<Throwable>() {
 @Override
 public void accept(Throwable throwable) throws Exception {

}
                            });
```
### 2.4.socket方式访问
如果采用socket方式调用则方法如下
```
    LocalRouter.getInstance(LRouterAppcation.getInstance())
                        .socketNavigation("Hello-socket".getBytes(), 10001, new IRequestCallBack() {
                            @Override
                            public void onSuccess(final String result) {
                                Message message = new Message();
                                message.obj = result;
                                message.what =1;
                                handler.sendMessage(message);
                            }

@Override
                            public void onFailure(Exception e) {

}
                        });
```
其中第一个参数为要发送的消息，第二个参数要访问的端口号，最后是回调（但是回调回来是在线程中不是在主线程）
## 3.后续工作
  
  文档补充与功能实现均还在路上，期待进一步...

LRouter

LRouter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

LRouter

LRouter 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README