router/com.therouter.router

Package-level declarations

Types

@Retention(value = RetentionPolicy.SOURCE)

annotation class Autowired

Annotation for parameters, which need autowired.

class AutowiredItem(type: String, key: String, id: Int, args: String, className: String, fieldName: String, required: Boolean, description: String)

IRouterMapAPT

interface IRouterMapAPT

Created by ZhangTao on 17/8/1.

Navigator

open class Navigator(var url: String?, val intent: Intent?)

路由导航器。与RouterItem作用类似，允许互转。 RouterItem 用于描述一个静态的路由项 Navigator 用于描述一个路由项的跳转动作

OnRouteMapChangedListener

interface OnRouteMapChangedListener

PendingNavigator

class PendingNavigator(val navigator: Navigator, val action: () -> Unit)

可以被挂起的导航器，通常用于延迟动作。延迟跳转主要应用场景有两种：第一种：初始化时期，如果路由表的量非常巨大时。这种情况在别的路由框架上要么会白屏一段时间，要么直接丢弃这次跳转。在TheRouter中，框架会暂存当前的跳转动作，在路由表初始化完成后立刻执行跳转。第二种：从Android 8.0开始，Activity 不能在后台启动页面，这对于业务判断造成了很大的影响。由于可能会有前台 Service 的情况，不能单纯以 Activity 生命周期判断前后台。在TheRouter中，框架允许业务自定义前后台规则，如果为后台情况，可以将跳转动作暂存，当进入前台后再恢复跳转。

RegexpKeyedMap

class RegexpKeyedMap<V> : HashMap<String?, V?>

专门为路由服务，因为路由的path存在正则的情况

Route

@Retention(value = RetentionPolicy.SOURCE)

@Target(value = [ElementType.TYPE])

@Repeatable(value = Routes::class)

annotation class Route

https://youtrack.jetbrains.com/issue/KT-12794 Kotlin 的 @Repeatable 不能注解到 Java class，得要到1.6才能支持，但是 Java 的却能注解到 Kotlin 代码，所以这个类只能写 Java 的 Created by ZhangTao on 17/8/11.

RouteItem

class RouteItem : Parcelable, Serializable

独立的一条路由记录

RouterMapInitTask

interface RouterMapInitTask

Routes

@Retention(value = RetentionPolicy.SOURCE)

@Target(value = [ElementType.TYPE])

annotation class Routes

Created by ZhangTao on 17/8/11.

Properties

gson

val gson: Gson

KEY_ACTION

const val KEY_ACTION: String

KEY_ANIM_IN

const val KEY_ANIM_IN: String

KEY_ANIM_OUT

const val KEY_ANIM_OUT: String

KEY_BUNDLE

const val KEY_BUNDLE: String

KEY_DESCRIPTION

const val KEY_DESCRIPTION: String

KEY_INTENT_FLAGS

const val KEY_INTENT_FLAGS: String

KEY_OBJECT_ACTIVITY

const val KEY_OBJECT_ACTIVITY: String

KEY_OBJECT_NAVIGATOR

const val KEY_OBJECT_NAVIGATOR: String

KEY_PATH

const val KEY_PATH: String

Functions

addNavigatorPathFixHandle

fun addNavigatorPathFixHandle(handle: NavigatorPathFixHandle)

应用场景：用于修复客户端上路由 path 错误问题。例如：相对路径转绝对路径，或由于服务端下发的链接无法固定https或http，但客户端代码写死了 https 的 path，就可以用这种方式统一。注：必须在 TheRouter.build() 方法调用前添加处理器，否则处理器前的所有path不会被修改。

addPathReplaceInterceptor

fun addPathReplaceInterceptor(interceptor: PathReplaceInterceptor)

页面替换器应用场景：需要将某些path指定为新链接的时候使用。也可以用在修复链接的场景，但是与 path 修改器不同的是，修改器通常是为了解决通用性的问题，替换器只在页面跳转时才会生效，更多是用来解决特性问题。

addRouteItem

fun addRouteItem(routeItem: RouteItem)

向路由表添加路由

addRouteMap