Android用建造者模式实现一个新功能引导页

最近每次版本更新都会在UI变动或加了新功能的地方加一个引导蒙层页面(新功能标记、文案和一个“知道了”的按钮),有时候一个版本会加三四个页面,原来的做法是:

  • 1.在每个Activity的布局文件外层添加一个FrameLayout(这方法好蠢,又要嵌套一层布局);
  • 2.再将需要显示的引导页布局加在后面(或用include的方式);
  • 3.写两个方法,获取和设置是否显示了该引导页的判断,存储到SharedPreferences;
  • 4.最后在对应Activity页面添加对应控制引导页显隐的逻辑

每添加一个页面就要重复上面四个步骤,而且之后版本迭代需要去掉这些冗余代码时也比较麻烦,改动的地方比较多,不利于管理。
这方法太笨了,不能纯粹只为了完成功能呀,于是想了一个简单有效的方法。

新功能引导页面

首先解决避免改动原Activity布局的问题,只要通过findViewById(android.R.id.content)获取Activity根布局下的FrameLayout, 再将需要添加的引导页布局addView(view)进入就可以了

FrameLayout rootLayout = (FrameLayout) activity.findViewById(android.R.id.content);
View layoutView = View.inflate(activity, layoutId, null);
rootLayout.add(layoutView);

这样就解决了改动Activity布局的问题,同时也将引导页的内容单独放在一个Layout文件(说得好像是废话,这不是必须的吗,不过我还真看过有人将所有布局代码都放在Activity的布局文件的 o(╯□╰)o)

然后后面的优化就好办了。将存储到SharedPreferences引导页是否已展示的方法增加一个pageTag的参数,通过外部使用时传入,这样就避免了每个页面都写同类型的方法的问题了。

最后将上面所说的方法封装在一个类GuidePage,使用时传入activity, layoutId, knowViewId(知道了按钮)和pageTag即可,写好这个工具类后,之后再需要增加引导页时只需要:
1.写一个引导页面的布局;
2.在对应的Activity页面调用这个工具方法即可;

private void apply(@LayoutRes int layoutId, @IdRes int knowViewId, String pageTag) {
    FrameLayout rootLayout = (FrameLayout) activity.findViewById(android.R.id.content);
    View layoutView = View.inflate(activity, layoutId, null);
    rootLayout.addView(layoutView);
    layoutView.setOnTouchListener(new View.OnTouchListener() {
        @Override
        public boolean onTouch(View v, MotionEvent event) {
            return true;
        }
    });
    layoutView.findViewById(knowViewId).setOnClickListener(new OnClickListener() {
        @Override
        public void onClick(View v) {
            rootLayout.removeView(layoutView);
            SpUtil.setHasShowedGuidePage(activity, pageTag, true);
        }
    });
}
//调用时,直接在Activity写
if(!SpUtil.hasShowedGuidePage()){
    new GuidePage(this).apply(R.layout.view_home_guide_page, R.id.home_guide_page_know, pageTag);
}

减少了大量重复代码,不用修改原来的布局文件,后期删除也比较方便,简单吧 -_-

理论上,这样就完了,不过程序员比较喜欢折腾,这样直接在构造器写四个参数好像不太好看吧,好像可以用建造者模式改下,于是就开始了将简单的事情搞复杂的道路-_-

------------------------------分割线------------------------------------

期待这样调用就可以了

new GuidePage.Builder(this)
      .setLayoutId(R.layout.view_home_guide_page)
      .setKnowViewId(R.id.home_guide_page_know)
      .setPageTag(pageTag)
      .builder()
      .apply();

建造者模式有两种写法,一种是有设计者的(有序),一种是无设计者的(无序),AlertDialog是无设计者的方式,简单一点,比较喜欢这种连写的方式。不记得建造者模式的可以看篇文章回忆下:[Android] 设计模式-建造者模式

建一个GuidePage的类,里面有个Builder的内部类,通过内部类设置activity, layoutId, knowViewId等参数。存储引导页是否已展示的方法好像可以直接写在GuidePage,就不用在外部判断了,不过这样要执行一些无用的代码,不适合;还有pageTag好像可以直接用activity.getClass().getSimpleName(), 也不用传这个值了,不过如果同一个Activity有两个引导页(如不同Fragment需要不同引导页)就不适用了,还是只能通过参数传入好点

好吧,这么简单,就不多说了,直接上代码:

public class GuidePage {
    private int layoutId;
    private int knowViewId;
    private String pageTag;
    private boolean mCancel = false;

    private Activity activity;
    private FrameLayout rootLayout;
    private View layoutView;
    //设置为 protected或private, 不被外部直接调用
    protected GuidePage(){
    }

    public static class Builder{
        private GuidePage guidePage = new GuidePage();

        public Builder(Activity activity){
            guidePage.activity = activity;
        }

        public Builder setLayoutId(@LayoutRes int layoutId){
            guidePage.layoutId = layoutId;
            return this;
        }

        public Builder setKnowViewId(@IdRes int knowViewId){
            guidePage.knowViewId = knowViewId;
            return this;
        }

        /**
         * 引导唯一的标记,用作存储到SharedPreferences的key值,不同引导页必须不一样
         * @param pageTag
         * @return
         */
        public Builder setPageTag(String pageTag){
            guidePage.pageTag = pageTag;
            return this;
        }

        public Builder setCloseOnTouchOutside(boolean cancel){
            guidePage.mCancel = cancel;
            return this;
        }

        public GuidePage builder(){
            if(TextUtils.isEmpty(guidePage.pageTag)){
                throw new RuntimeException("the guide page must set page tag");
            }
            guidePage.setLayoutView();
            guidePage.setKnowEvent();
            guidePage.setCloseOnTouchOutside();
            return guidePage;
        }
    }

    public void setLayoutView(){
        rootLayout = (FrameLayout) activity.findViewById(android.R.id.content);
        layoutView = View.inflate(activity, layoutId, null);
    }

    public void setKnowEvent(){
        if(layoutView!=null) {
            layoutView.findViewById(knowViewId).setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    cancel();
                }
            });
        }
    }

    public void setCloseOnTouchOutside(){
        if(layoutView == null)
            return;
        layoutView.setOnTouchListener(new View.OnTouchListener() {
            @Override
            public boolean onTouch(View v, MotionEvent event) {
                if(mCancel){
                    cancel();
                }
                return true;  //消费事件,不下发
            }
        });
    }

    public void apply(){
        rootLayout.addView(layoutView);
    }

    public void cancel(){
        if(rootLayout!=null && layoutView!=null) {
            rootLayout.removeView(layoutView);
            GuidePageManager.setHasShowedGuidePage(activity, pageTag, true);
        }
    }
}

下面是判断页面是否显示引导页的类,或者用来定义一些静态的pageTag也行

public class GuidePageManager {

    private GuidePageManager(){
    }
    /**
     * @param activity
     * @param pageKey 使用时,传入的值必须和GuidePage设置的值一样
     * @return
     */
    public static boolean hasNotShowed(Activity activity, String pageKey){
        return !hasShowedGuidePage(activity, pageKey);
    }

    public static void setHasShowedGuidePage(Context context, String key, boolean hasShowed){
        SharedPreferences settings= context.getSharedPreferences(context.getPackageName(), 0);
        SharedPreferences.Editor editor=settings.edit();
        editor.putBoolean(key, hasShowed);
        editor.commit();
    }

    private static boolean hasShowedGuidePage(Context context, String key){
        SharedPreferences settings=context.getSharedPreferences(context.getPackageName(), 0);
        boolean value=settings.getBoolean(key, false);
        return value;
    }
}

最后,使用方法

if(GuidePageManager.hasNotShowed(this, MainActivity.class.getSimpleName())){
    new GuidePage.Builder(this)
            .setLayoutId(R.layout.view_home_guide_page)
            .setKnowViewId(R.id.btn_home_act_enter_know)
            .setPageTag(MainActivity.class.getSimpleName())
            .builder()
            .apply();
}

完了。
Github代码: GuidePageManage

首发于: Android用建造者模式实现一个新功能引导页

---EOF---

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

推荐阅读更多精彩内容