QSkinLoader换肤框架

如何在一个成熟的应用内换肤？ 请参见文章：链接。

README分三部分：基本简介、使用方法、框架由来与架构设计。如果不嫌麻烦，还可以去看文章夜间模式方案调研和QSkinLoader框架介绍

#效果图 QSkinLoader实现夜间模式效果图

#基本简介： QSkinLoader是一个支持多种场景的Android换肤框架。基本原理是通过代理LayoutInflater的View创建过程解析皮肤相关属性（background/src/textColor等），将皮肤相关属性设置到View的Tag内，在切换皮肤时寻找对应的皮肤来完成实时刷新动作。此方案具有代码及XML侵入性小、功能完善（支持Activity/Dialog/悬浮窗/PopWindow等）、无需重启Activity、支持自定义属性换肤、同时支持资源内换肤和独立资源包（下载后换肤）等优点。

#使用方法

基本使用

由于可以自定义皮肤资源加载过程，QSkinLoader框架内并未提供当前皮肤的保存逻辑（不能支持loadCurrentSkin之类的接口）。因此建议使用框架时封装两个类：一个负责保存当前皮肤（保存皮肤其实就是SharePreference持久化存储，此处略去），一个负责与框架交互，如下：

public void init(Context context) {
    SkinManager.getInstance().init(context);
}

public void switchSkinMode(OnSkinChangeListener listener) {
    mIsSwitching = true;
    mIsDefaultMode = !mIsDefaultMode;
    refreshSkin(listener);
}

public void refreshSkin(OnSkinChangeListener listener) {
    if (mIsDefaultMode) {
        //恢复到默认皮肤
        SkinManager.getInstance().restoreDefault(SkinConstant.DEFAULT_SKIN, new MyLoadSkinListener(listener));
    } else {
        changeSkin(listener);
    }
}

private void changeSkin(OnSkinChangeListener listener) {
    SkinManager.getInstance().loadSkin("_night",
            new SuffixResourceLoader(mContext),
            new MyLoadSkinListener(listener));
}

具体代码此处不完全贴出了，工程内有详细的代码。

###1. 框架初始化在Application创建过程中执行框架的初始化：

// 初始化皮肤框架
SkinChangeHelper.getInstance().init(this);
//初始化上次缓存的皮肤
SkinChangeHelper.getInstance().refreshSkin(null);

初始化了框架后需要调用refreshSkin来加载上一次的皮肤设置，refreshSkin加载完成皮肤后会通知各Activity界面刷新皮肤设置，由于此处在Application初始化时调用，可能加载完成皮肤设置后界面仍未初始化，这并不无影响，因为Activity初始化时会主动执行一次换肤操作，弥补此过程的缺失。

###2. Activity初始化与各生命周期调用因为换肤一般是整个应用都需要执行的过程，此处建议实现一个基础类(BaseActivity)来封装换肤相关逻辑，此类建议实现接口ISkinActivity，告知是否支持换肤，以及在换肤操作触发后如果界面不在前台是否立刻换肤：

@Override
public boolean isSupportSkinChange() {
    //告知当前界面是否支持换肤：true支持换肤，false不支持
    return true;
}

@Override
public boolean isSwitchSkinImmediately() {
    //告知当切换皮肤时，是否立刻刷新当前界面；true立刻刷新，false表示在界面onResume时刷新；
    //减轻换肤时性能压力
    return false;
}

@Override
public void handleSkinChange() {
    //当前界面在换肤时收到的回调，可以在此回调内做一些其他事情；
    //比如：通知WebView内的页面切换到夜间模式等
}

然后在Activity的onCreate中执行IActivitySkinEventHandler的初始化与配置工作：

//初始化并配置IActivitySkinEventHandler，应在IActivitySkinEventHandler.onCreate之前执行
mSkinEventHandler = SkinManager.newActivitySkinEventHandler()
        .setSwitchSkinImmediately(isSwitchSkinImmediately())
        .setSupportSkinChange(isSupportSkinChange())
        .setWindowBackgroundResource(getWindowBackgroundResource())
        .setNeedDelegateViewCreate(false);
//通知框架onCreate事件
mSkinEventHandler.onCreate(this);

其中，setWindowBackgroundResource用于设置Activity的背景色，在换肤时会寻找对应的背景色替换之，此处传入的不能是色值，只支持引用，类似R.color.xx。 setNeedDelegateViewCreate用于设置是否需要代理View创建，因为LayoutInflater的代理View创建Factory只支持设置一次，如果外部已经设置了Factory，则框架内再次设置会引起崩溃，所以框架使用配置与回调来处理此问题。具体见高级使用部分。

其他生命周期回调基本类似，挑两个做实例，如下：

@Override
protected void onResume() {
    super.onResume();
    //皮肤相关，此通知放在此处，尽量让子类的view都添加到view树内
    if (mFirstTimeApplySkin) {
        mSkinEventHandler.onViewCreated();
        mFirstTimeApplySkin = false;
    }
    //皮肤相关
    mSkinEventHandler.onResume();
}

@Override
public void onWindowFocusChanged(boolean hasFocus) {
    super.onWindowFocusChanged(hasFocus);

    //皮肤相关
    mSkinEventHandler.onWindowFocusChanged(hasFocus);
}

###3. XML配置 QSkinLoader只支持引用型资源换肤，所有的颜色定义都应定义在colors.xml内，在使用时引用。对于一个布局，需要定义一个skin的命名空间：

xmlns:skin="http://schemas.android.com/android/skin"

然后对所有需要换肤的View增加属性：

skin:enable="true"

即可完成换肤配置。举例如下：

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:skin="http://schemas.android.com/android/skin"
    android:orientation="horizontal"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    skin:enable="true"
    android:gravity="center_vertical"
    android:background="@color/color_background">
    <ImageView
        android:layout_width="50dp"
        android:layout_height="50dp"
        android:src="@mipmap/ic_launcher"/>

    <TextView
        android:id="@+id/list_item_text_view"
        android:layout_width="100dp"
        android:layout_height="50dp"
        android:textColor="@color/color_text"
        skin:enable="true"/>
</LinearLayout>

在这段布局内，框架代理创建Linearlayout时会解析其background属性，代理创建View时不解析任何属性，代理创建TextView时会解析textColor属性。

###4. 图片蒙层对ImageView/ImageButton可以配置属性：

skin:drawShadow="@color/night_shadow_color"

来支持图片蒙层，night_shadow_color是一个颜色引用，在默认情况下建议使用透明色，同时在皮肤包内定义此值为另一个色值（不必须是半透明色）。需要注意的是：蒙层的原理是ImageView的ColorFilter，有时候对ImageView设置ColorFilter会失效。但是对Drawable设置ColorFilter基本都会生效，所以如果是对ImageView的Src属性做蒙层，建议使用框架内的ShadowImageView替代ImageView。如下：

<org.qcode.qskinloader.view.ShadowImageView
            android:id="@+id/logo"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_centerVertical="true"
            skin:enable="true"
            skin:drawShadow="@color/news_pic_night_shadow_color"/>

###5. 换肤与恢复默认皮肤 先来看看换肤操作：

SkinManager.getInstance().loadSkin("_night",
            new SuffixResourceLoader(mContext),
            new MyLoadSkinListener(listener));

这是基于资源后缀的换肤方式，对于R.color.color_text，切换到夜间模式时，框架会去找R.color.color_text_night作为夜间模式的资源。 QSkinLoader换肤框架还支持另一种默认的换肤方式——APK资源换肤，也就是将资源文件定义在独立的APK文件内，此文件可从服务端下载，从而真正实现动态换肤。此方式对现有工程的影响比较小，非常值得推荐。具体方式如下：

SkinUtils.copyAssetSkin(mContext);
File skin = new File(SkinUtils.getTotalSkinPath(mContext));
SkinManager.getInstance().loadAPKSkin(
        skin.getAbsolutePath(), new MyLoadSkinListener(listener));

当然也可以写成：

SkinManager.getInstance().loadSkin(skin.getAbsolutePath(),
            new APKResourceLoader(mContext),
            new MyLoadSkinListener(listener));

此时对于资源R.color.color_text，框架会去skin路径的APK文件内寻找对于的资源R.color.color_text，找不到就继续使用当前应用的color_text资源。自定义皮肤加载过程见高级使用部分。

那么怎么恢复默认皮肤呢？

//恢复到默认皮肤
SkinManager.getInstance().restoreDefault(SkinConstant.DEFAULT_SKIN,
        new MyLoadSkinListener(listener));

DEFAULT_SKIN值对框架而言并无意义，框架只是把此值回调到ILoadSkinListener使外部知道当前加载的是默认皮肤，所以此值是在框架外定义的。

###6. 动态创建View的皮肤设置上文中指出的使用方式是基于XML配置的，如果是在Java代码内如何使用呢？ QSkinLoader框架提供了一个帮助类ISkinViewHelper来添加/删除View的皮肤属性。此类设计为链式编程方式，提供的接口有：

ISkinViewHelper setViewAttrs(String attrName, int resId);
ISkinViewHelper setViewAttrs(DynamicAttr... dynamicAttrs);
ISkinViewHelper setViewAttrs(SkinAttr... skinAttrs);
ISkinViewHelper setViewAttrs(List<DynamicAttr> dynamicAttrs);

ISkinViewHelper addViewAttrs(String attrName, int resId);
ISkinViewHelper addViewAttrs(DynamicAttr... dynamicAttrs);
ISkinViewHelper addViewAttrs(SkinAttr... skinAttrs);
ISkinViewHelper addViewAttrs(List<DynamicAttr> dynamicAttrs);

ISkinViewHelper cleanAttrs(boolean clearChild);
void applySkin(boolean applyChild);

如果View本身已经有了皮肤属性，setViewAttrs接口会替换已有的皮肤属性，而addViewAttrs不会覆盖已有属性，而是在已有的皮肤属性内添加新的属性。 cleanAttrs会清除View的所有皮肤属性，如果传入clearChild为true则遍历所有子元素清除皮肤属性，false只清除自身属性。 applySkin则对当前View应用皮肤设置，如果传入applyChild为true则遍历所有子元素应用皮肤，false只应用自身。假设对一个TextView，动态设置View的皮肤属性大致如下：

SkinManager
    .with(textview)
    .setViewAttrs(SkinAttrName.BACKGROUND, R.color.white)
    .addViewAttrs(SkinAttrName.TEXT_COLOR, R.color.black)
    .applySkin(false);

所有框架支持的属性名称都定义在SkinAttrName内，如果需要扩展属性支持，建议参考自定义View属性处理器部分。

###7. 特定View的换肤管理上面的换肤过程都是对Activity的View树做遍历换肤操作的，树根是：

activity.findViewById(android.R.id.content);

所有不在这颗树内的View都不能换肤，哪些View不在换肤范围呢？ Dialog的View、popWindow的View、悬浮窗(WindowManager上直接加View)，目前这三类View要换肤都应该使用特定View的换肤管理模块。需要注意的是：Dialog的交互具有排他型，通常在换肤操作时是不展示的，所以一般可以在show接口调用时做换肤，而不使用IWindowViewManager。 怎么对特定View进行换肤管理呢？ 框架提供了IWindowViewManager接口来提供特定View的管理，支持链式编程，接口如下：

IWindowViewManager addWindowView(View view);
IWindowViewManager removeWindowView(View view);
IWindowViewManager clear();
void applySkinForViews(boolean applyChild);
List<View> getWindowViewList();

接口比较简单，主要是增加/删除/清空全局View列表和应用皮肤的操作。使用如下：

View popView = LayoutInflater.from(mContext).inflate(
    R.layout.news_list_item_pop, null);
SkinManager.getInstance().applySkin(popView, true);
SkinManager
        .getWindowViewManager()
        .addWindowView(popView);
popupWindow = new PopupWindow(popView, popWidth, popHeight);

通常不建议使用applySkinForViews接口，因为它会遍历所有全局View列表的View做遍历，所以替代方式是先对当前View做属性设置，再添加到框架内管理，从而在下次换肤时接口换肤事件。 IWindowViewManager内的View是弱引用存储的，所以不会发生内存泄露，但建议在View无用的时候从框架内移除特定View。

高级使用

###1. 自定义View属性处理器当项目需要自定义View时，一般都会自定义一些属性，这些属性框架是不支持换肤的，此时需要自定义属性处理器并注册到框架内。自定义属性处理器实现接口ISkinAttrHandler，实现方法：

void apply(View view,
        SkinAttr skinAttr,
        IResourceManager resourceManager);

下面是一个示例：若有一个自定义CustomTextView，使用属性defTextColor来定义文字颜色，如下：

<org.qcode.demo.ui.customattr.CustomTextView
        android:layout_width="match_parent"
        android:layout_height="50dp"
        android:gravity="center"
        android:text="自定义的文字颜色和背景1"
        app:defBackground="@color/color_background"
        app:defTextColor="@color/color_text"
        skin:enable="true" />

则其自定义属性处理器为：

public class DefTextColorAttrHandler implements ISkinAttrHandler {
    public static final String DEF_TEXT_COLOR = "defTextColor";

    @Override
    public void apply(View view, SkinAttr skinAttr, IResourceManager resourceManager) {
        if(!(view instanceof CustomTextView)) {
            //防止在错误的View上设置了此属性
            return;
        }
        CustomTextView tv = (CustomTextView) view;
        if (RES_TYPE_NAME_COLOR.equals(skinAttr.mAttrValueTypeName)) {
            if (SkinConstant.RES_TYPE_NAME_COLOR.equals(
            skinAttr.mAttrValueTypeName)) {
                try {
                    //先尝试按照int型颜色解析

QSkinLoader

Install / Use

README

QSkinLoader换肤框架

基本使用

高级使用