ARouter系列三：依赖注入暴露服务

如果对于 ARouter 不是很了解的，建议先行阅读：
ARouter系列一：Activity跳转原理详解
 ARouter系列二：@Autowired属性注入

想要提供服务暴露给其他人使用，ARouter提供了一个接口：IProvider

// Provider interface, base of other interface.
public interface IProvider {
    /**
     * Do your init work in this method, it well be call when processor has been load.
     *
     * @param context ctx
     */
    void init(Context context);
}

IProvider 只有一个方法 init，参数为 Context。刚看到这接口的时候不是很明白，等把本篇文章看完之后就会明白，参数Context不可或缺。注意IProvider的注释：IProvider是其它 Interface 的基础。可见ARouter推荐的用法是一个Interface 继承 IProvider。

这里大家可能会有疑问，为什么需要Context参数，为什么推荐是一个接口继承 IProvider，而不是实体类。带着这些疑问，我们继续探寻

一、使用

新建一个项目，有两个moudle：app 和 location。location中封装了地图相关服务，例如：开始定位，获取位置等等。 app 依赖 location

1.1 location模块

LocationService 定义此模块提供的基础服务：开始定位和获取地理位置。并且实现了上述的 IProvider

package com.daddyno1.location;
public interface LocationService extends IProvider {
    //开始定位
    void startLocate();
    //获取经纬度信息
    Point getLocation();
}

BaiduLocationService 是提供服务的最终实现类。此处模拟使用了百度来实现具体功能。并且使用了 @Route(path = "/Loc/LocationService") 来标注真实 Location 服务实现类。

@Route(path = "/Loc/LocationService")
public class BaiduLocationService implements LocationService {

    private static final String TAG = "BaiduLocationService";

    @Override
    public void startLocate() {
        Log.i(TAG, "BaiduLocationService - startLocate");
    }

    @Override
    public Point getLocation() {
        return new Point(11,12);
    }

    @Override
    public void init(Context context) {
        Log.i(TAG, "BaiduLocationService - init");
    }
}

编译一下，我们看一下 apt 帮我们生成了哪些 辅助类：
ARouter$$Root$$location、ARouter$$Group$$Loc 和 ARouter$$Providers$$location，ARouter系列一：Activity跳转原理详解的不难理解，ARouter$$Root$$location存储了location module 下所有路由组信息；ARouter$$Group$$Loc 存储了 location module 下路由组名为 Loc 的路由表信息。

package com.alibaba.android.arouter.routes;
...
/**
 * DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY AROUTER. */
public class ARouter$$Root$$location implements IRouteRoot {
  @Override
  public void loadInto(Map<String, Class<? extends IRouteGroup>> routes) {
    routes.put("Loc", ARouter$$Group$$Loc.class);
  }
}

package com.alibaba.android.arouter.routes;
...
/**
 * DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY AROUTER. */
public class ARouter$$Group$$Loc implements IRouteGroup {
  @Override
  public void loadInto(Map<String, RouteMeta> atlas) {
    atlas.put("/Loc/LocationService", RouteMeta.build(RouteType.PROVIDER, BaiduLocationService.class, "/loc/locationservice", "loc", null, -1, -2147483648));
  }
}

ARouter$$Providers$$location 这个类长什么样？我们来看一下：

package com.alibaba.android.arouter.routes;
...
/**
 * DO NOT EDIT THIS FILE!!! IT WAS GENERATED BY AROUTER. */
public class ARouter$$Providers$$location implements IProviderGroup {
  @Override
  public void loadInto(Map<String, RouteMeta> providers) {
    providers.put("com.daddyno1.location.LocationService", RouteMeta.build(RouteType.PROVIDER, BaiduLocationService.class, "/Loc/LocationService", "Loc", null, -1, -2147483648));
  }
}

ARouter$$Providers$$location 这个类有什么用呢，我们先往后看，一会再说。

1.2 app模块

这里新建一个 Activity 使用我们创建好的 Location 服务

public class SecondActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main3);

        // 使用一：by name
        LocationService locationService = (LocationService) ARouter.getInstance().build("/Loc/LocationService").navigation();
        locationService.startLocate();

        //使用二： by type
        LocationService locationService1 = ARouter.getInstance().navigation(LocationService.class);
        locationService1.startLocate();
    }
}

我们运行一下，看一下结果：

I: BaiduLocationService - init
I: BaiduLocationService - startLocate
I: BaiduLocationService - startLocate

注意： init 执行了一次， startLocate 调用了两次。

二、源码分析

2.1 init

之前在分析Activity跳转的时候分析了ARouter的初始化，这里不再细讲。

public synchronized static void init(Context context, ThreadPoolExecutor tpe) throws HandlerException {
 ...
 for (String className : routerMap) {
     if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_ROOT)) {
     //com.alibaba.android.arouter.routes.ARouter$$Root
    // This one of root elements, load root.
     ((IRouteRoot) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.groupsIndex);
    } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_INTERCEPTORS)) {
     //com.alibaba.android.arouter.routes.ARouter$$Interceptors
     // Load interceptorMeta
      ((IInterceptorGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.interceptorsIndex);
    } else if (className.startsWith(ROUTE_ROOT_PAKCAGE + DOT + SDK_NAME + SEPARATOR + SUFFIX_PROVIDERS)) {
     //com.alibaba.android.arouter.routes.ARouter$$Providers
     // Load providerIndex
    ((IProviderGroup) (Class.forName(className).getConstructor().newInstance())).loadInto(Warehouse.providersIndex);
     }
  }
  ...
}

唯一需要提一下的是，经过路由器初始化之后，Warehouse的数据如下：

ARouter$$Providers$$location 这个是之前提到的apt生成的辅助类，它的作用就是帮助路由在初始化的时候，把相关数据注入到 Warehouse.providersIndex，这个有什么用呢，其实对于by name的使用方式来说，Warehouse.providersIndex 和 ARouter$$Providers$$location 根本没用上，只是 by type 时候的辅助类。

2.2 by name

LocationService locationService = (LocationService) ARouter.getInstance().build("/Loc/LocationService").navigation();

2.3 by type

LocationService locationService1 = ARouter.getInstance().navigation(LocationService.class);

2.4 小结

具体的实现逻辑和 Activity 路由过程很相似，自己去看代码吧。唯一的区别是，如果RouteType是 PROVIDER 的话，直接根据反射创建一个路由Destination 类的实例，存到Postcard里，最后返回给用户。

本例中ARouter会使用反射创建一个BaiduLocationService 的实体对象，回调init方法，返回给使用者，之后把实体对象缓存到 Warehouse.providers（Map<Class, IProvider>），下次直接在使用的话，直接从缓存获取，不会再反射创建了。这也是本例为什么 init 只执行了一次。

三、总结

1、为什么IProvider要提供一个Context？
我们知道ARouter是帮助我们实现项目组件化的工具，很多情况下一个Moudle是拿不到应用程序Context的，本例中的场景就是。但很多服务的实现又会依赖于Context，所以有必要把Context传递给各个Moudle。

2、为什么推荐 Interface 集成 IPriovider？
ARouter说通过依赖注入暴露服务。本例中抽象了一个 LocationService 接口，此接口抽象了所有用到的服务，用户通过ARouter可以拿到 LocationService 的具体实现类，然后强转成 LocationService 使用，可以不用关心具体的实现类是谁。这就是通过依赖注入的方式实现控制翻转，从而实现使用者和具体实现解耦的目的。假如某一天又想时候用高德SDK 实现具体的 Location 服务，使用者的代码不用修改，实现完全的解耦。使用高德实现 Location 服务：

package com.daddyno1.location;
...
@Route(path = "/Loc/LocationService")
public class GaodeLocationService implements LocationService {

    private static final String TAG = "GaodeLocationService";

    @Override
    public void startLocate() {
        Log.i(TAG, " GaodeLocationService - startLocate");
    }

    @Override
    public Point getLocation() {
        return new Point(1,2);
    }

    @Override
    public void init(Context context) {
        Log.i(TAG, " GaodeLocationService - init");
    }
}