WMRouter 开源路由框架教程

项目介绍

WMRouter 是一款基于组件化设计思路的 Android 路由框架，由美团开发并开源。它主要提供 URI 分发和 ServiceLoader 两大功能，适用于多工程之间的页面跳转、动态下发 URI 链接的跳转等场景。WMRouter 的特点包括支持多 scheme、host、path，支持 URI 正则匹配，以及完全组件化设计，核心组件均可扩展、按需组合，实现灵活强大的功能。

项目快速启动

添加依赖

首先，在项目的 build.gradle 文件中添加 WMRouter 的依赖：

dependencies {
    implementation 'io.github.meituan-dianping:router:1.2.1'
}

初始化 WMRouter

在应用的 Application 类中初始化 WMRouter：

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        // 初始化 WMRouter
        WMRouter.init(this);
    }
}

配置路由

使用注解配置路由：

@RouterUri(path = "/main/activity")
public class MainActivity extends AppCompatActivity {
    // 你的代码
}

跳转页面

使用 WMRouter 进行页面跳转：

WMRouter.getInstance().build("/main/activity").navigation();

应用案例和最佳实践

页面跳转

WMRouter 支持多 scheme、host、path，可以灵活配置页面跳转：

WMRouter.getInstance().build("wm_router://page/main").navigation();

拦截器

使用拦截器在跳转前执行同步/异步操作，例如定位、登录等：

WMRouter.getInstance().addGlobalInterceptor(new GlobalInterceptor() {
    @Override
    public void intercept(final UriRequest request, final InterceptorCallback callback) {
        // 执行拦截操作
        callback.onContinue(request);
    }
});

降级策略

配置全局和局部降级策略，保证关键功能的正常工作：

WMRouter.getInstance().setGlobalOnCompleteListener(new OnCompleteListener() {
    @Override
    public void onSuccess(UriRequest request) {
        // 跳转成功
    }

    @Override
    public void onError(UriRequest request, int resultCode) {
        // 跳转失败，执行降级逻辑
    }
});

典型生态项目

WMRouter 已经被广泛应用于美团外卖、美团外卖商家版、美团、大众点评等项目中。这些项目通过 WMRouter 实现了高效的页面跳转和模块解耦，提高了开发效率和应用性能。

美团外卖

美团外卖通过 WMRouter 实现了多工程之间的页面跳转和动态下发 URI 链接的跳转，提高了用户体验和开发效率。

美团外卖商家版

美团外卖商家版利用 WMRouter 的 ServiceLoader 模块，实现了模块间的解耦和通信，便于实现组件化和模块间通信。

美团

美团通过 WMRouter 实现了页面 A/B 测试和动态配置，根据不同的需求动态下发一组路由表，相同的 URI 跳转到不同的一组页面。

大众点评

大众点评使用 WMRouter 进行页面跳转和拦截操作，确保关键功能的正常工作，并提供友好的用户提示。

通过以上案例，可以看出 WMRouter 在实际项目中的应用广泛，能够有效提升开发效率和应用性能。