android自定义serviceloader接口隔离及获取自定义properties参数配置

1.简述:

  之前看过大神的美团组件化方案,其中提到了通过servicelaoder进行解耦的思路,主要是通过配置接口及其实现类的方式坐到接口隔离作用,本文主要是实现此思路并延伸出通过加载自定义properties文件获取参数配置信息

2.系统ServiceLoader简介

  通过查看ServiceLoader源码可知,ServiceLoader是通过加载META-INF/services/路径下的接口实现类,加载方式是通过读取配置文件并通过反射的方式获取类的实例
1.配置文件读取,获取文件流

       private boolean hasNextService() {
            if (nextName != null) {
                return true;
            }
            if (configs == null) {
                try {
                    //文件路径
                    String fullName = PREFIX + service.getName();
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                } catch (IOException x) {
                    fail(service, "Error locating configuration files", x);
                }
            }
            while ((pending == null) || !pending.hasNext()) {
                if (!configs.hasMoreElements()) {
                    return false;
                }
                //通过流获取实现类的class全路径String集合
                pending = parse(service, configs.nextElement());
            }
            nextName = pending.next();
            return true;
        }

其中PREFIX = "META-INF/services/";
由此可见加载路径是META-INF文件夹下面的文件

2.通过流获取实现类全路径

private Iterator<String> parse(Class<?> service, URL u)
            throws ServiceConfigurationError
    {
        InputStream in = null;
        BufferedReader r = null;
        //存储获取的类全路径
        ArrayList<String> names = new ArrayList<>();
        try {
            //通过URL获取流
            in = u.openStream();
            r = new BufferedReader(new InputStreamReader(in, "utf-8"));
            int lc = 1;
            //通过流逐行读取文件并存入names
            while ((lc = parseLine(service, u, r, lc, names)) >= 0);
        } catch (IOException x) {
           ...
        } finally {
            ...
        }
        return names.iterator();
    }

其中parseLine方法里面是做了类全路径名校验

private int parseLine(Class<?> service, URL u, BufferedReader r, int lc,
                          List<String> names)
            throws IOException, ServiceConfigurationError
    {
        ...
        if (n != 0) {
            //判断是否有空格
            if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
                fail(service, u, lc, "Illegal configuration-file syntax");
            int cp = ln.codePointAt(0);
            //确定是否允许将字符(Unicode 代码点)作为 Java 标识符中的首字符
            if (!Character.isJavaIdentifierStart(cp))
                fail(service, u, lc, "Illegal provider-class name: " + ln);
            for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
                cp = ln.codePointAt(i);
                //确定字符(Unicode 代码点)是否可以是 Java 标识符中首字符以外的部分
                if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
                    fail(service, u, lc, "Illegal provider-class name: " + ln);
            }
            ...
        }
        return lc + 1;
    }
3.自定义ServiceLoader

思路:
  1.读取配置文件
  2.获取配置的类全名
  3.通过反射获取类的实例

  我们的配置文件将写在assets文件夹下


image.png

  通过查看apk包结构可以发现assets文件夹位置是与META-INF平级的,由此我们可以将系统的ServiceLoader加载文件路径改为assets路径

1.配置文件读取,获取文件流

class Load {

    private ClassLoader loader;
    private Enumeration<URL> configs = null;

    Load() {
        //初始化加载器
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        if (null != cl) {
            loader = cl;
        } else {
            loader = ClassLoader.getSystemClassLoader();
        }
    }
    //获取URL
    URL initLoad(String location) {
        if (configs == null) {
            try {
                if (loader == null)
                    configs = ClassLoader.getSystemResources(location);
                else
                    configs = loader.getResources(location);
            } catch (IOException x) {
                x.printStackTrace();
            }
        }
        return configs.nextElement();
    }

    ClassLoader getLoader() {
        return loader;
    }
}

2.通过流获取接口类与实现类的对应集合
  由于接口类与实现类是一对一关系,所以通过Map以键值对的方式存储接口类与实现类,在系统ServiceLoader做简单修改:

private static Map<String,String> parse(URL u)
            throws ServiceConfigurationError
    {
       ...
        Map<String,String> names = new HashMap<>();
        try {
          ...
            while ((lc = parseLine(r, lc, names)) >= 0);
        } catch (IOException x) {
//            fail(service, "Error reading configuration file", x);
        } finally {
           ...
        }
        return names;
    }
 private static int parseLine(BufferedReader r, int lc,
                                 Map<String,String> names)
            throws IOException, ServiceConfigurationError
    {
        ...
        if(lns.length == 2){
            if(!isJavaIdentifier(lns[0]) || !isJavaIdentifier(lns[1])){
                return -1;
            }
            names.put(lns[0],lns[1]);
        }else {
            return -1;
        }
        return lc + 1;
    }

3.获取实现类
  在上一步已经获取了所有接口类和实现类的集合,在此通过接口类全名来获取实现类全名,并通过反射的方式获取实现类实例:

<T> T load(Context context,Class<T> server){

            String cn = pending.get(server.getName());
            Class<?> c = null;
            try {
                c = Class.forName(cn, false, dzmLoad.getLoader());
            } catch (ClassNotFoundException x) {
               ...
            }
            ...
            try {
                T p = server.cast(c.newInstance());
                servers.put(server.getName(),p);
                return p;
            } catch (Throwable x) {
                ...
            }
            throw new Error();          // This cannot happen
        }

到此我们自定义ServiceLoader已经初步实现,在实际开发中,我们一般只需要一个实例及单利,在此我们可以用Map将类的实例与接口类名绑定起来即可。

配置文件
image.png

使用

MyServicesLoader.getService(TestService.class).test()
4.延伸---加载properties配置参数

  加载properties配置参数的思路与ServiceLoader基本一致,只是获取配置参数可以通过java类Properties获取
1.获取流
  和自定义ServiceLoader获取流一致

2.获取Properties实例

private Properties loadProperties(String... resourcesPaths) {
        Properties props = new Properties();

        for (String location : resourcesPaths) {
            InputStream is = null;
            try {
                //获取流
                URL url = new Load().initLoad(location);
                URLConnection con = url.openConnection();
                is = con.getInputStream();
                //加载流配置
                props.load(is);
            } catch (IOException ex) {
                ex.printStackTrace();
            } finally {
                try {
                    if(null != is)
                        is.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return props;
    }

3.获取value

    private String getValue(String key) {
        String systemProperty = System.getProperty(key);
        if (systemProperty != null) {
            return systemProperty;
        }
        if (properties.containsKey(key)) {
            return properties.getProperty(key);
        }
        return "";
    }

4.使用

PropertiesLoader propertiesLoader = new PropertiesLoader("assets/services/data.properties");
propertiesLoader.getProperty("ip")
配置:
image.png

image.png
结果
image.png

image.png
注:

1.在查看Iterable 接口时无意中发现了default关键字,经查看资料显示为java8新加的,用于在接口中写默认的方法函数体

有兴趣的可以去https://github.com/dengzhi00/deployloader看看

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,539评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,911评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,337评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,723评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,795评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,762评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,742评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,508评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,954评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,247评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,404评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,104评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,736评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,352评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,557评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,371评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,292评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,649评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,801评论 6 342
  • feisky云计算、虚拟化与Linux技术笔记posts - 1014, comments - 298, trac...
    不排版阅读 3,843评论 0 5
  • 很久没有认真的写一篇了,都是零零碎碎的记录一些事情,有时真的感触很深才会想要记录下来,有时懒,睡一觉第二天也就过了...
    牡羊人阅读 335评论 14 0
  • 今天还好吧!算是写了字每天小结的目的就在于知道自己每天做了多少事情,要坚持,不能因为不打卡就不写了明天又要开始学习...
    Cheer_up阅读 77评论 0 0