https://github.com/wangchenyan/crouter
支持组件化的 Android 路由框架
https://github.com/wangchenyan/crouter
android interceptor modularization router
Last synced: 3 months ago
JSON representation
支持组件化的 Android 路由框架
- Host: GitHub
- URL: https://github.com/wangchenyan/crouter
- Owner: wangchenyan
- License: apache-2.0
- Created: 2019-09-11T02:48:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T04:31:22.000Z (over 1 year ago)
- Last Synced: 2025-03-27T17:35:22.074Z (11 months ago)
- Topics: android, interceptor, modularization, router
- Language: Kotlin
- Homepage: https://juejin.im/post/6844903923606618126
- Size: 275 KB
- Stars: 26
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crouter
[](https://jitpack.io/#wangchenyan/crouter)
## 系列文章
- [手撸一个 Router 框架（上）：熟悉 APT](https://juejin.im/post/6844903923606618126)
- [手撸一个 Router 框架（下）：路由拦截机制](https://juejin.im/post/6844904193866596365)
## Features
1. 支持直接解析标准 URL 进行跳转，参数在目标页面通过 getIntent 获取
2. 支持多模块工程使用
3. 支持添加多个拦截器，自定义拦截顺序
4. Activity 自动注册（使用 [AutoRegister](https://github.com/luckybilly/AutoRegister) 实现自动注册）
5. 自动处理 `startActivityForResult` 回调
6. 支持获取 Fragment
7. 支持启动 Fragment（需要设置 `RouterClient#fragmentContainerIntent`，可参考 sample）
8. 支持 Kotlin
## Change Log
`v3`
- 支持 APG 8+
`v2`
- 优化 Api 调用
- 新增获取 Fragment
- 新增启动 Fragment
`v1`
- 完成路由功能
## Dependency
### 1. 添加 Jitpack 仓库
```kotlin
// settings file
pluginManagement {
repositories {
maven("https://jitpack.io")
}
}
dependencyResolutionManagement {
repositories {
maven("https://jitpack.io")
}
}
```
### 2. 添加 crouter-plugin 插件，用于字节码注入
> 注意：插件仅支持 AGP 7.4+
```kotlin
// root build file
buildscript {
dependencies {
classpath("com.github.wangchenyan.crouter:crouter-plugin:${latestVersion}")
}
}
```
```kotlin
// app build file
plugins {
id("crouter-plugin")
}
```
### 3. 添加 router 依赖和注解处理器
> 注意：`2.4.0` 版本开始使用 `ksp`，建议尽快迁移，如果仍想使用 `kapt`，请使用 `2.3.0` 版本
```kotlin
// app build file
plugins {
id("com.google.devtools.ksp")
}
ksp {
// 使用默认
arg("moduleName", project.name)
// 默认 scheme
arg("defaultScheme", "(http|https|native|host)")
// 默认 host
arg("defaultHost", "(\\w+\\.)*host\\.com")
}
dependencies {
ksp("com.github.wangchenyan.crouter:crouter-processor:${latestVersion}")
implementation("com.github.wangchenyan.crouter:crouter-api:${latestVersion}")
}
```
## Usage
### 1. 初始化，设置路由客户端
建议在 Application 的 onCreate，或第一个 Activity 的 onCreate 中执行
```kotlin
CRouter.setRouterClient(
RouterClient.Builder()
// 设置登录拦截器，可选
.loginProvider { context, callback ->
CRouter.with(context)
.url("scheme://host/login")
.startForResult {
if (it.isSuccess()) {
callback.invoke()
}
}
}
// 启动 Fragment 时，需要设置 Fragment 容器 Activity 的 Intent
.fragmentContainerIntent(Intent(this, FragmentContainerActivity::class.java))
.build()
)
```
### 2. 在 `BaseActivity` 中配置 `getIntent` 包装
```kotlin
abstract class BaseActivity : AppCompatActivity() {
override fun getIntent(): Intent {
return RouterIntent(super.getIntent())
}
}
```
### 3. 配置 Activity 路由注解
```kotlin
// path 使用正则匹配，注意转义
@Route("/target\\.html", needLogin = true)
class TargetActivity : BaseActivity() {
}
```
### 4. 尽情使用吧
```kotlin
// 不关心结果
CRouter.with(this)
.url("scheme://host/target.html")
.start()
// 关心结果
CRouter.with(this)
.url("scheme://host/target.html")
.startForResult {
if (it.isSuccess("key")) {
val value = it.data?.getStringExtra("key")
alert("跳转取值", value)
}
}
```
**更多用法请参考 [sample](https://github.com/wangchenyan/crouter/tree/master/sample) 代码**
## Interceptor
在 CRouter 中使用拦截器和 OkHttp 的用法一致，这里以添加一个 H5 页面拦截器为例，当识别到网页链接，用内置浏览器打开
```kotlin
class H5Interceptor : Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
val request = chain.request()
val uri = request.uri()
val response = chain.proceed(request)
if (response.intent() == null && uri != null && (uri.scheme == "http" || uri.scheme == "https")) {
val context = request.context()
val intent = Intent(context, BrowserActivity::class.java)
intent.putExtra(Extra.URL, uri.toString())
return Response.Builder()
.context(context)
.request(request)
.intent(intent)
.build()
}
return response
}
}
```
在初始化时添加拦截器
```kotlin
CRouter.setRouterClient(
RouterClient.Builder()
.addInterceptor(H5Interceptor())
.build()
)
```
## ProGuard
无
## About me
掘金：https://juejin.im/user/2313028193754168
微博：https://weibo.com/wangchenyan1993
## License
Copyright 2019 wangchenyan
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.