Android-skin-support

Introduction: Android-skin-support: 一款用心去做的 Android 换肤框架, 极低的学习成本, 极好的用户体验. 只需要两行代码, 就可以实现换肤, 你值得拥有!!!
More: Author   ReportBugs   
Tags:
换肤-

中文 | In English

skin-support build license

介绍

Android-skin-support: 一款用心去做的 Android 换肤框架, 极低的学习成本, 极好的用户体验.

只需要一行代码, 就可以实现换肤, 你值得拥有!!!

SkinCompatManager.withoutActivity(this).loadSkin();

就这么简单, 你的 APK 已经拥有了强大的换肤功能, 当然现在是拥有了换肤功能, 别忘了制作皮肤包.

功能

  • [x] 支持布局中用到的资源换肤。
  • [x] 支持代码中设置的资源换肤。
  • [x] 默认支持大部分基础控件,Material Design 换肤。
  • [x] 支持动态设置主题颜色值,支持选择 sdcard 上的图片作为drawable换肤资源。
  • [x] 支持多种加载策略(应用内/插件式/自定义 sdcard 路径/zip 等资源等)。
  • [x] 资源加载优先级: 动态设置资源-加载策略中的资源-插件式换肤/应用内换肤-应用资源。
  • [x] 支持定制化,选择需要的模块加载。
  • [x] 支持矢量图(vector/svg)换肤。

详细内容, 请查看更新日志,那里有所有功能提交记录

TODO

  • [x] 解耦 skin-support 对 appcompat-v7 的依赖。
  • [ ] AppCompatDelegate.setCompatVectorFromResourcesEnabled(true);开关使用错误问题修正。
  • [ ] 支持多语言。
  • [ ] 支持多字体。
  • [ ] 支持 Preference。
  • [ ] skin-sample 实现:
    • [x] 动态修改主题颜色值案例
    • [ ] 控件使用案例
    • [ ] 更新日志 tab
    • [ ] 关于页面
  • [ ] Wiki

目录结构

demo // 换肤 demo 集合

skin-sample(skin-app) // demo app

skin-night // 夜间模式皮肤工程

skin-autolayout-app // autolayout demo app

android-support // Android 原生控件

skin-support // 换肤框架, 基础控件支持

skin-support-cardview // 换肤框架, CardView 支持

skin-support-design // 换肤框架, Material Design 支持

skin-support-constraint-layout // 换肤框架, ConstraintLayout 支持

third-part-support // 第三方控件换肤支持

Demo

default app-in plug-in

用法

导入:

直接添加依赖, 最新版本选择, 请查看更新日志

implementation 'skin.support:skin-support:3.1.0-beta'                   // skin-support 基础控件支持
implementation 'skin.support:skin-support-design:3.1.0-beta'            // skin-support-design material design 控件支持[可选]
implementation 'skin.support:skin-support-cardview:3.1.0-beta'          // skin-support-cardview CardView 控件支持[可选]
implementation 'skin.support:skin-support-constraint-layout:3.1.0-beta' // skin-support-constraint-layout ConstraintLayout 控件支持[可选]

使用:

在 Application 的 onCreate 中初始化

@Override
public void onCreate() {
    super.onCreate();
    SkinCompatManager.withoutActivity(this)                         // 基础控件换肤初始化
            .addInflater(new SkinMaterialViewInflater())            // material design 控件换肤初始化[可选]
            .addInflater(new SkinConstraintViewInflater())          // ConstraintLayout 控件换肤初始化[可选]
            .addInflater(new SkinCardViewInflater())                // CardView v7 控件换肤初始化[可选]
            .setSkinStatusBarColorEnable(false)                     // 关闭状态栏换肤,默认打开[可选]
            .setSkinWindowBackgroundEnable(false)                   // 关闭 windowBackground 换肤,默认打开[可选]
            .loadSkin();
}

皮肤开关

如果项目中有特殊需求。例如, 股票控件: 控件颜色始终为红色或绿色, 不需要随着模式切换而换肤

那么可以使用类似的方法, 直接设置 drawable

setBackgroundDrawable(redDrawable) // 不支持换肤
background="#ce3d3a"

而不是使用 R.drawable.red

setBackgroundResource(R.drawable.red)
background="@drawable/red"

加载插件皮肤库

// 指定皮肤插件
SkinCompatManager.getInstance().loadSkin("new.skin"[, SkinLoaderListener], int strategy);

// 恢复应用默认皮肤
SkinCompatManager.getInstance().restoreDefaultTheme();

自定义 View 换肤

要点:

  1. 实现 SkinCompatSupportable 接口

    1. applySkin 方法中实现换肤操作
  2. 在构造方法中解析出需要换肤的 resId

  3. 自定义 View 可以直接继承自 SkinCompatView, SkinCompatLinearLayout 等已有控件

    eg: CustomTextView

  4. 不想继承自已有控件

    eg: CustomTextView2

  5. 需要换肤自定义属性

    // 需要换肤 AutoCompleteTextView 的 R.attr.popupBackground 属性

    eg: SkinCompatAutoCompleteTextView

  6. 需要使用第三方库控件怎么办

    // 需要使用https://github.com/hdodenhof/CircleImageView 控件, 并且要支持换肤

    eg: SkinCompatCircleImageView

应用内换肤:

应用内换肤,皮肤名为: night; 新增需要换肤的资源添加后缀 night 或者前缀 night

需要换肤的资源为 R.color.windowBackgroundColor, 添加对应资源 R.color.windowBackgroundColor_night。

加载应用内皮肤:

SkinCompatManager.getInstance().loadSkin("night", SkinCompatManager.SKIN_LOADER_STRATEGY_BUILD_IN); // 后缀加载
SkinCompatManager.getInstance().loadSkin("night", SkinCompatManager.SKIN_LOADER_STRATEGY_PREFIX_BUILD_IN); // 前缀加载

推荐将应用内换肤相关的皮肤资源放到单独的目录中

eg: res-night

注: 如果使用这种方式来增加换肤资源,记得在 build.gradle 中配置一下这个资源目录 sourceSets {main {res.srcDirs = ['src/main/res', 'src/main/res-night']}}

插件式换肤:

新建 Android application 工程

皮肤工程包名不能和宿主应用包名相同.

例如:

宿主包名: com.ximsfei.skindemo
夜间模式: com.ximsfei.skindemo.night

将需要换肤的资源放到 res 目录下(同名资源)

例如 APK 中窗口背景颜色为

colors.xml

<color name="background">#ffffff</color>

那么夜间模式你可以在 skin-night 工程中设置

colors.xml

<color name="background">#000000</color>

打包生成 apk, 即为皮肤包

将打包生成的 apk 文件, 重命名为'xxx.skin', 防止 apk 结尾的文件造成混淆.

加载皮肤插件

加载插件式皮肤, 将皮肤包放到 assets/skins 目录下

SkinCompatManager.getInstance().loadSkin("night.skin", SkinCompatManager.SKIN_LOADER_STRATEGY_ASSETS);

自定义加载策略:

自定义 sdcard 路径

继承自SkinSDCardLoader,通过getSkinPath方法指定皮肤加载路径,通过getType方法指定加载器 type。

public class CustomSDCardLoader extends SkinSDCardLoader {
    public static final int SKIN_LOADER_STRATEGY_SDCARD = Integer.MAX_VALUE;

    @Override
    protected String getSkinPath(Context context, String skinName) {
        return new File(SkinFileUtils.getSkinDir(context), skinName).getAbsolutePath();
    }

    @Override
    public int getType() {
        return SKIN_LOADER_STRATEGY_SDCARD;
    }
}

注: 自定义加载器 type 值最好从整数最大值开始递减,框架的 type 值从小数开始递增,以免将来框架升级造成 type 值冲突

在 Application 中,添加自定义加载策略:

SkinCompatManager.withoutActivity(this)
        .addStrategy(new CustomSDCardLoader());          // 自定义加载策略,指定 SDCard 路径

注: 自定义加载器必须在 Application 中注册,皮肤切换后,重启应用需要根据当前策略加载皮肤

使用自定义加载器加载皮肤:

SkinCompatManager.getInstance().loadSkin("night.skin", null, CustomSDCardLoader.SKIN_LOADER_STRATEGY_SDCARD);

zip 包中加载资源

继承自SkinSDCardLoader,在loadSkinInBackground方法中解压资源,在getDrawable等方法中返回加压后的资源。

public class ZipSDCardLoader extends SkinSDCardLoader {
    public static final int SKIN_LOADER_STRATEGY_ZIP = Integer.MAX_VALUE - 1;

    @Override
    public String loadSkinInBackground(Context context, String skinName) {
        // TODO 解压 zip 包中的资源,同时可以根据 skinName 安装皮肤包(.skin)。
        return super.loadSkinInBackground(context, skinName);
    }

    @Override
    protected String getSkinPath(Context context, String skinName) {
        // TODO 返回皮肤包路径,如果自需要使用 zip 包,则返回""
        return new File(SkinFileUtils.getSkinDir(context), skinName).getAbsolutePath();
    }

    @Override
    public Drawable getDrawable(Context context, String skinName, int resId) {
        // TODO 根据 resId 来判断是否使用 zip 包中的资源。
        return super.getDrawable(context, skinName, resId);
    }

    @Override
    public int getType() {
        return SKIN_LOADER_STRATEGY_ZIP;
    }
}

资源加载策略更灵活,不仅仅只有皮肤包,开发者可配置任意资源获取方式(Zip/Apk/Json...)。

在 Application 中,添加自定义加载策略:

SkinCompatManager.withoutActivity(this)
        .addStrategy(new ZipSDCardLoader());          // 自定义加载策略,加载 zip 包中的资源

动态设置资源

动态设置颜色

SkinCompatUserThemeManager.get().addColorState(R.color.colorPrimary, #ffffffff);

SkinCompatUserThemeManager.get().addColorState(R.color.colorPrimary, new ColorState.ColorBuilder().addXxx().build());

// 清除所有已有颜色值。
SkinCompatUserThemeManager.get().clearColors();

动态设置图片

SkinCompatUserThemeManager.get().addDrawablePath(R.drawable.windowBackground, "/sdcard/DCIM/Camera/xxx.jpg");

// 要换肤的资源 id,图片路径,图片旋转角度(默认为 0)
SkinCompatUserThemeManager.get().addDrawablePath(R.drawable.windowBackground, "/sdcard/DCIM/Camera/xxx.jpg", 90);

// 清除所有已有图片路径。
SkinCompatUserThemeManager.get().clearDrawables();

在设置完颜色及图片后,需要调用apply()方法来保存设置。

SkinCompatUserThemeManager.get().apply();

资源加载优先级: 用户自定义颜色值-加载策略中的资源-皮肤包资源-应用资源。

谁在使用

如果你想提交作品,欢迎提出 PR 或联系作者

搜狐新闻探索版 讯飞语记 qoo app 多维新闻

技术交流

License MIT

Support Me
Apps
About Me
Google+: Trinea trinea
GitHub: Trinea