Android开发技巧——实现可复用的ActionSheet菜单

时间:2023-03-09 03:15:38
Android开发技巧——实现可复用的ActionSheet菜单

在上一篇《Android开发技巧——使用Dialog实现仿QQ的ActionSheet菜单》中,讲了这种菜单的实现过程,接下来将把它改成一个可复用的控件库。

本文原创,转载请注明出处:

http://blog.****.net/maosidiaoxian/article/details/46324941

对于要实现的可复用的控件库,我需要它具备以下两点:

  1. 可添加远程依赖(不考虑Eclipse中的使用)
  2. 可灵活配置

分离库的实现代码

对于第一点,需要做的就是在Android Studio中新建一个library的module,然后把相关的实现代码,资源分离出来拖过去,并且把library中如图标,一些字符串等没有用到的资源删掉,保持AndroidManifest.xml的干净(仅保留会用到的权限,声明等)。在这里,我们library的AndroidManifest最终只剩下了:

<manifest
    package="com.githang.android.actionsheet">

    <application/>

</manifest>

注意,application节点里 的allowBackup属性要去掉,不然会让一些不知道怎么用tools中的几个属性来解决冲突的人,面对AndroidManifest.xml的合并冲突不知所措。labelicon属性在这里也不需要,所以也去掉了。

然后把一开始创建的app module的包名加上.demo后缀,把com.githang.andorid.actionsheet仅作为我们的library的包名(这个是纯属个人习惯,你也可以不这么做。我是觉得在包名上把library和demo区分来比较好,而我又不想给library加多一个.library的包。

分离完之后的项目是这样的:

https://github.com/msdx/ActionSheet/commit/934b73bc3e2d1504c9b13e87649ce388c59f4613

分离之后,就可以把我们的库打包成aar,并上传到jcenter,让别人能以添加远程依赖的方式来使用了。如何发布到jcenter,可以见我这篇博客:《使用Gradle发布Android开源项目到JCenter》

但是现在,我们仅完成的最基本的工作,因为,你不能要求每个人对一个库的要求都和你完全一样,可能有些人的需求中,需要改一下UI上的一些属性什么的。所以接下来,我们需要让我们的库能够灵活配置。

可*配置的属性

我们的大部分属性是定义在xml中的。要改动这些属性,方法主要有两种:

1. 在Java代码中提供一些View的UI上的接口,让第三方通过调用它来设置。

2. 布局文件中使用属性的引用,而不是直接使用它的值。

如果你写的是自定义控件(通过继承View),那么你可能还需要自定义一些属性,让别人在使用的时候可以在xml中添加。由于这里我们写的不是这类控件,不需要用到它,在这里就不赘述了。

继续说上面的两种方法。Android中,采用xml定义布局,就是想让布局代码与逻辑代码相分离,所以第一种方式我是尽量少用的(在需要动态设置,或者是在Java代码中设置更简单时使用,)。下面先说一下第二种的方式的实现过程。

我们在xml中定义到的控件有三个,一是ListView,二是Button,三是ListView的Item。所以首先,在values文件夹里新建一个attrs.xml的属性文件,在里面分别定义三个属性,formatreference。如下:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <attr name="ActionSheetList" format="reference"/>
    <attr name="ActionSheetCancel" format="reference"/>
    <attr name="ActionSheetItem" format="reference"/>
</resources>

接着,把之前写的布局文件改为使用?attr的方式声明属性。

menu_item.xml

<?xml version="1.0" encoding="utf-8"?>
<TextView xmlns:android="http://schemas.android.com/apk/res/android"
          android:id="@android:id/text1"
          style="?attr/ActionSheetItem" />

dialog_action_sheet.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
              android:layout_width="match_parent"
              android:layout_height="match_parent"
              android:orientation="vertical">

    <ListView
        android:id="@+id/menu_items"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        style="?attr/ActionSheetList"
        android:listSelector="@android:color/transparent"/>

    <Button
        android:id="@+id/menu_cancel"
        style="?attr/ActionSheetCancel"/>
</LinearLayout>

然后在我们的style中声明这几个属性的style:

    <style name="ActionSheetList">
        <item name="android:divider">#c9dddddd</item>
        <item name="android:dividerHeight">1px</item>
    </style>
    <style name="ActionSheetItem">
        <item name="android:layout_width">match_parent</item>
        <item name="android:layout_height">45dp</item>
        <item name="android:textSize">18sp</item>
        <item name="android:gravity">center</item>
        <item name="android:textColor">@color/menu_text</item>
    </style>
    <style name="ActionSheetCancel" parent="ActionSheetItem">
        <item name="android:layout_marginTop">8dp</item>
        <item name="android:layout_marginBottom">8dp</item>
        <item name="android:background">@drawable/menu_item_single</item>
    </style>

注意,这里的style的名称并不要求与attr中声明的名称一致,这里我只是懒得想其他名字,真的。

这样做了之后,其他人在使用的时候,会需要多一个步骤:在他的styler中的AppTheme(具体视androidmanifest中指定的theme而定)节点中,需要添加以下几项:

    <style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
        <item name="ActionSheetList">@style/ActionSheetList</item>
        <item name="ActionSheetItem">@style/ActionSheetItem</item>
        <item name="ActionSheetCancel">@style/ActionSheetCancel</item>
    </style>

如果他想自己修改属性的值,只需要写对应的style,然后把上面的item里的值改为他写的style即可。

对于菜单的改动,我们就改到这里。

接下来是对ActionSheetDialog的重构,让它提供可以进行以下设置的API:

  • 设置显示与隐藏时的动画
  • 设置菜单的背景

首先是菜单的背景,上文已经说过它一共有四个背景。所以定义一个菜单背景的类:

    /**
     * 菜单背景
     */
    public static class MenuBackground {
        public int top;
        public int middle;
        public int bottom;
        public int single;

        public MenuBackground() {}

        public MenuBackground(int top, int middle, int bottom, int single) {
            this.top = top;
            this.middle = middle;
            this.bottom = bottom;
            this.single = single;
        }
    }

然后定义一个菜单背景的对象,给它初始值,并定义一个设置背景的方法:

    private MenuBackground mMenuBg = new MenuBackground(R.drawable.menu_item_top,
            R.drawable.menu_item_middle, R.drawable.menu_item_bottom, R.drawable.menu_item_single);

    public void setMenuBackground(int top, int middle, int bottom, int single) {
        mMenuBg.top = top;
        mMenuBg.middle = middle;
        mMenuBg.bottom = bottom;
        mMenuBg.single = single;
    }

最后剩下动画的配置的。定义分别设置显示及隐藏动画的两个方法,注意,对隐藏动画的方法中,要设置动画结束的回调,在这里隐藏我们的菜单。

动画设置的代码重构如下:

    private void initAnim(Context context) {
        setShowAnimation(AnimationUtils.loadAnimation(context, R.anim.translate_up));
        setDismissAnimation(AnimationUtils.loadAnimation(context, R.anim.translate_down));
    }

    /**
     * @param animation Showing animation.
     * @since 0.2
     */
    public void setShowAnimation(Animation animation) {
        mShowAnim = animation;
    }

    /**
     * @param animation Dismissing animation.
     * @since 0.2
     */
    public void setDismissAnimation(Animation animation) {
        mDismissAnim = animation;
        mDismissAnim.setAnimationListener(new Animation.AnimationListener() {
            @Override
            public void onAnimationStart(Animation animation) {

            }

            @Override
            public void onAnimationEnd(Animation animation) {
                dismissMe();
            }

            @Override
            public void onAnimationRepeat(Animation animation) {

            }
        });
    }

现在我们的库已经重构完了,它暴露了适当的API,以让其他人可以自定义一些属性。它也对布局文件的配置提供了方法,即通过style来进行配置。

最后就是升版本号,改README,发布新版本了,打TAG了。

项目最后如下:

https://github.com/msdx/ActionSheet/tree/0.2