源碼地址
在一切開始之前,我只想用正當(dāng)?shù)姆绞酵┖保蚯蟾魑坏囊粋€star
https://github.com/geminiwen/skin-sprite
預(yù)覽
序
在寫SegmentFault for Android 4.0
的過程中缸棵,因為原先采用的夜間模式仿村,代碼著實不好看缰雇,于是我又開始挖坑了。
在幾個月前更新的Android Support Library 23.2
中嘹屯,讓我們認識到了DayNight Theme
。一看源碼从撼,原來以前在API 8
的時候就已經(jīng)有了night
相關(guān)的資源可以設(shè)置州弟,只是之前一直不知道怎么使用,后來發(fā)現(xiàn)原來還是利用了AssetManager
相關(guān)的API —— Android在指定條件下加載指定文件夾中的資源低零。 這正是我想要的呆馁! 這樣我們只用指定好引用的資源,(比如@color/colorPrimary
) 那么我就可以在白天加載values/color.xml
中的資源毁兆,晚上加載values-night/color.xml
中的資源浙滤。
v7
已經(jīng)幫我們完成了這里的功能纺腊,放置夜晚資源的問題也已經(jīng)解決了畔咧,可是每次切換DayNight
模式的時候,需要重啟下Activity
揖膜,這件事情很讓人討厭誓沸,原因就是因為重啟后,我們的Context
就會重新創(chuàng)建壹粟,View
也會重新創(chuàng)建拜隧,根據(jù)當(dāng)前系統(tǒng)(應(yīng)用)配置的不同,加載不同的資源趁仙。 那我們有沒有可能做到不重啟Activity
來實現(xiàn)夜間模式呢洪添?其實實現(xiàn)方案很簡單:我們只用記錄好系統(tǒng)渲染xml的時候,當(dāng)時給View
的資源id雀费,在特定時刻干奢,重新加載這些資源,然后設(shè)置給View即可盏袄。接下去我們碰到兩個問題:
- 在引入這個庫的情況下忿峻,讓開發(fā)者少改已有的xml文件,把所有的布局都換為我們指定的布局辕羽。
- API要盡量簡單逛尚,清楚,明白刁愿。
上面兩個條件說起來很容易黑低,其實想實現(xiàn)并不是很容易的,還好AppCompat
給了我一些思路酌毡。
來自AppCompat的啟發(fā)
當(dāng)我們引入appcompat-v7
克握,有了AppCompatActivity
的時候,我們發(fā)現(xiàn)我們渲染的TextView
/Button
等組件分別變成了AppCompatTextView
和AppCompatButton
枷踏, 這些組件都是包含在v7
包中的菩暗,很早以前覺得很神奇,當(dāng)看了AppCompatActivity
和AppCompatDelegate
的源碼旭蠕,知道了LayoutInflator.Factory
這些東西的工作原理之后停团,這一切也就不神奇了 —— 它只是在inflate
的過程中,注入了自己的代碼進去掏熬,比如把TextView
解析成AppCompatTextView
類佑稠,達到對解析結(jié)果攔截的目的。
OK旗芬,借助這個方法舌胶,我們可以在Activity.onCreate
中,注入我們自己的LayoutInflatorFactory
:
像這樣疮丛,有興趣的同學(xué)可以看看AppCompatDelegateImplV7
這個類的installViewFactory
方法的實現(xiàn)幔嫂。
接下去我們的目的是把TextView
辆它、Button
等類換成我們自己的實現(xiàn)——SkinnableTextView
和SkinnableButton
。
可以翻到AppCompatViewInflater
這個類的源碼履恩,其實很清晰了:
public final View createView(View parent, final String name, @NonNull Context context,
@NonNull AttributeSet attrs, boolean inheritContext,
boolean readAndroidTheme, boolean readAppTheme, boolean wrapContext) {
final Context originalContext = context;
// We can emulate Lollipop's android:theme attribute propagating down the view hierarchy
// by using the parent's context
if (inheritContext && parent != null) {
context = parent.getContext();
}
if (readAndroidTheme || readAppTheme) {
// We then apply the theme on the context, if specified
context = themifyContext(context, attrs, readAndroidTheme, readAppTheme);
}
if (wrapContext) {
context = TintContextWrapper.wrap(context);
}
View view = null;
// We need to 'inject' our tint aware Views in place of the standard framework versions
switch (name) {
case "TextView":
view = new AppCompatTextView(context, attrs);
break;
case "ImageView":
view = new AppCompatImageView(context, attrs);
break;
case "Button":
view = new AppCompatButton(context, attrs);
break;
case "EditText":
view = new AppCompatEditText(context, attrs);
break;
case "Spinner":
view = new AppCompatSpinner(context, attrs);
break;
case "ImageButton":
view = new AppCompatImageButton(context, attrs);
break;
case "CheckBox":
view = new AppCompatCheckBox(context, attrs);
break;
case "RadioButton":
view = new AppCompatRadioButton(context, attrs);
break;
case "CheckedTextView":
view = new AppCompatCheckedTextView(context, attrs);
break;
case "AutoCompleteTextView":
view = new AppCompatAutoCompleteTextView(context, attrs);
break;
case "MultiAutoCompleteTextView":
view = new AppCompatMultiAutoCompleteTextView(context, attrs);
break;
case "RatingBar":
view = new AppCompatRatingBar(context, attrs);
break;
case "SeekBar":
view = new AppCompatSeekBar(context, attrs);
break;
}
if (view == null && originalContext != context) {
// If the original context does not equal our themed context, then we need to manually
// inflate it using the name so that android:theme takes effect.
view = createViewFromTag(context, name, attrs);
}
if (view != null) {
// If we have created a view, check it's android:onClick
checkOnClickListener(view, attrs);
}
return view;
}
這里完成的工作就是把XML
中的一些Tag解析為java的類實例锰茉,我們可以依樣畫葫蘆,只不過把其中的AppCompatTextView
換成SkinnableTextView
//省略代碼
switch (name) {
case "TextView":
view = new SkinnableTextView(context, attrs);
break;
}
//省略代碼
好了切心,如果有需要飒筑,我們在庫中把所有的類都替換成自己的實現(xiàn),就能達到目的了绽昏,使得那些使用原始控件的開發(fā)者协屡,不修改一絲一毫的代碼,渲染出我們定制的控件而涉。
應(yīng)用DayNightMode
上一節(jié)我們解決了自定義View
替換原始View
的問題著瓶,那么接下去怎么辦呢联予?這里我們同樣也參考AppCompat
關(guān)于BackgroundTint
的一些設(shè)計方式啼县。首先我們可以看到AppComatTextView
的聲明:
public class AppCompatTextView extends TextView implements TintableBackgroundView {
//...
}
實現(xiàn)了一個TintableBackgroundView
的接口,而我們使用ViewCompat.setSupportBackgroundTint
的時候沸久,可以找到這么一條:
static void setBackgroundTintList(View view, ColorStateList tintList) {
if (view instanceof TintableBackgroundView) {
((TintableBackgroundView) view).setSupportBackgroundTintList(tintList);
}
}
利用OO的特性季眷,很輕松的判斷這個View是否支持我們想要的特性,這時候我也聲明了一個接口Skinnable
public class SkinnableTextView extends AppCompatTextView implements Skinnable {
//...
}
這樣等于給我的類打了一個標記卷胯,外部調(diào)用的時候子刮,就可以判斷這個View是否實現(xiàn)了我們的接口,如果實現(xiàn)了接口窑睁,就可以調(diào)用相關(guān)的函數(shù)挺峡。
我們在Activity
的基類中,可以如此調(diào)用
private void applyDayNightForView(View view) {
if (view instanceof Skinnable) {
Skinnable skinnable = (Skinnable) view;
if (skinnable.isSkinnable()) {
skinnable.applyDayNight();
}
}
if (view instanceof ViewGroup) {
ViewGroup parent = (ViewGroup)view;
int childCount = parent.getChildCount();
for (int i = 0; i < childCount; i++) {
applyDayNightForView(parent.getChildAt(i));
}
}
}
利用遞歸的方式担钮,把所有實現(xiàn)Skinnable
接口的View
全部應(yīng)用了applyDayNight
方法橱赠。 因此開發(fā)者使用的時候,只用把Activity
的繼承改為SkinnableActivity
箫津,然后在恰當(dāng)?shù)臅r機調(diào)用setDayNightMode
即可狭姨。
Skinnable在View中具體實現(xiàn)
這節(jié)講的是如何解決我們的痛點 —— 不重啟Activity
應(yīng)用DayNight mode
。
對 | 錯 |
---|---|
android:textColor="@color/primaryColor" | android:textColor="#fff" |
android:textColor="?attr/colorPrimary" | android:textColor="#000" |
那我們的View
實現(xiàn)Skinnable
接口中的方法苏遥,到底是如何工作的呢饼拍,以SkinnableTextView
為例子。
一般我們對TextView
應(yīng)用的樣式有background
和textColor
田炭,額外的情況下帶一個backgroundTint
都是OK的师抄。
首先我們的大前提是,這些資源在xml
中是用引用的方式傳進來的教硫,什么意思呢司澎,看下面的表格
對 | 錯 |
---|---|
android:textColor="@color/primaryColor" | android:textColor="#fff" |
android:textColor="?attr/colorPrimary" | android:textColor="#000" |
總結(jié)起來一句話欺缘,就是不應(yīng)該是絕對值,如果是絕對值的話挤安,我們?nèi)ジ乃闹狄膊环线壿嫛?/p>
那么如果是資源引用的方式的話谚殊,我們使用TypedArray
這個對象,是可以獲取到我們引用的資源的id的蛤铜,也就是R.color.primaryColor
的具體數(shù)值嫩絮。 我們把這個值保存下來,然后在恰當(dāng)?shù)臅r候围肥,利用這個值再去變化后的Context
中獲取一遍指定的顏色
ContextCompat.getColor(context, R.color.primaryColor);
這時候我們獲取到的實際值剿干,context
就會根據(jù)系統(tǒng)的配置去正確的文件夾下找我們想要的資源了。
我們利用TypedArray
能獲取到資源的id穆刻,使用TypedArray.getResourceId
方法即可置尔,傳入屬性的索引值就行。
public void storeAttributeResource(TypedArray a, int[] styleable) {
int size = a.getIndexCount();
for (int index = 0; index < size; index ++) {
int resourceId = a.getResourceId(index, -1);
int key = styleable[index];
if (resourceId != -1) {
mResourceMap.put(key, resourceId);
}
}
}
最后氢伟,在切換夜間模式的時候榜轿,我們調(diào)用了applyDayNight
方法,具體代碼如下:
@Override
public void applyDayNight() {
Context context = getContext();
int key;
key = R.styleable.SkinnableView[R.styleable.SkinnableView_android_background];
Integer backgroundResource = mAttrsHelper.getAttributeResource(key);
if (backgroundResource != null) {
Drawable background = ContextCompat.getDrawable(context, backgroundResource);
//這時候獲取到的background是符合上下文的
setBackgroundDrawable(background);
}
//省略代碼
}
總結(jié)以及缺陷
經(jīng)過以上幾點的開發(fā)朵锣,我們使用日/夜模式切換就變得非常容易了谬盐,比如我們?nèi)绻惶幚眍伾男薷牡脑挘挥迷?code>values/colors.xml和values-night/colors.xml
配置好指定顏色在不同模式下的表現(xiàn)形式诚些,再調(diào)用setDayNightMode
方法飞傀,就可以完成一鍵切換,不需要在xml
中添加任何復(fù)雜凌亂的東西诬烹。
因為在配置上節(jié)省了許多代碼砸烦,那我們的約定就變得比較冗長了,如果想進行自定義View的換膚的話绞吁,就需要手動去實現(xiàn)Skinnable
接口幢痘,實現(xiàn)applyDayNight
方法,開發(fā)者這時候就需要去做一些緩存資源id的操作掀泳。
同時因為它依賴于AppCompat DayNight Mode
雪隧,它只能作用于日/夜間模式的切換,要想實現(xiàn)換膚
功能员舵,是做不到的脑沿。
這兩點是缺陷,同時也是和市面上其他換膚庫最不同的地方马僻。但是我們把骯臟的代碼隱藏在頂部實現(xiàn)里庄拇,就是為了業(yè)務(wù)邏輯層代碼的干凈和整潔。
希望各位會喜歡,然后有問題可以留言或者在github
上給我提PR措近,非常感謝溶弟。
Github Repo 地址:https://github.com/geminiwen/skin-sprite