ButterKnife外掛的出現讓Android程式設計師從繁瑣的findViewById重複程式碼中解放出來,尤其搭配各種自動生成程式碼的Android Studio外掛,更是如虎添翼。
ButterKnife的實現原理,大家應該都有所耳聞,利用AbstractProcess,在編譯時候為BindView註解的控制元件自動生成findViewById程式碼,ButterKnife#bind(Activity)方法,實質就是去呼叫自動生成的這些findViewById程式碼。
然而,當我需要去了解這些實現細節的時候,我決定去看看ButterKnife的原始碼。ButterKnife整個專案涵蓋的註解有很多,看起來可能會消耗不少的時間,筆者基於這些天的摸索的該專案的思路,實現了自己的一個BindView註解的使用,來幫助大家瞭解。
本文實現的功能
在Activity中用@BindView註解實現findViewById的功能。
GitHub連結
筆者實現的專案已經上傳到Github,歡迎大家star。點選檢視ButterFork
專案結構
Annotation module
我們需要處理的BindView註解,就宣告在這個module裡,簡單不多說。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.CLASS)
public @interface BindView {
int value() ;
}複製程式碼
Target為FIELD型別,表示這個註解用於類內屬性的宣告;Retention為CLASS,表示這個註解在專案編譯時起作用,如果為RUNTIME則表示在執行時起作用,RUNTIME的註解都是結合反射使用的,所以執行效率上有所欠缺,應該儘量避免使用RUNTIME類註解。
BindView內的value為int型別,正是R.id對應的型別,方便我們直接對View宣告其繫結的id:
@BindView(R.id.btn)
protected Button mBtn;複製程式碼
Compiler module
這個module是自動生成findViewById程式碼的重點,這裡只有一個類,繼承於AbstractProcessor。
@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class BindProcess extends AbstractProcessor{
private Elements mElementsUtil;
/**
* key: eclosed elemnt
* value: inner views with BindView annotation
*/
private Map<TypeElement,Set<Element>> mElems;
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
mElementsUtil = processingEnv.getElementUtils();
mElems = new HashMap<>();
}
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> types = new HashSet<>();
types.add(BindView.class.getCanonicalName());
return types;
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
System.out.println("Process start !");
initBindElems(roundEnv.getElementsAnnotatedWith(BindView.class));
generateJavaClass();
System.out.println("Process finish !");
return true;
}
private void generateJavaClass() {
for (TypeElement enclosedElem : mElems.keySet()) {
MethodSpec.Builder methodSpecBuilder = MethodSpec.methodBuilder("bind")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.addParameter(ClassName.get(enclosedElem.asType()),"activity")
.returns(TypeName.VOID);
for (Element bindElem : mElems.get(enclosedElem)) {
methodSpecBuilder.addStatement(String.format("activity.%s = (%s)activity.findViewById(%d)",bindElem.getSimpleName(),bindElem.asType(),bindElem.getAnnotation(BindView.class).value()));
}
TypeSpec typeSpec = TypeSpec.classBuilder("Bind"+enclosedElem.getSimpleName())
.superclass(TypeName.get(enclosedElem.asType()))
.addModifiers(Modifier.FINAL,Modifier.PUBLIC)
.addMethod(methodSpecBuilder.build())
.build();
JavaFile file = JavaFile.builder(getPackageName(enclosedElem),typeSpec).build();
try {
file.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
}
}
private void initBindElems(Set<? extends Element> bindElems) {
for (Element bindElem : bindElems) {
TypeElement enclosedElem = (TypeElement) bindElem.getEnclosingElement();
Set<Element> elems = mElems.get(enclosedElem);
if (elems == null){
elems= new HashSet<>();
mElems.put(enclosedElem,elems);
System.out.println("Add enclose elem "+enclosedElem.getSimpleName());
}
elems.add(bindElem);
System.out.println("Add bind elem "+bindElem.getSimpleName());
}
}
private String getPackageName(TypeElement type) {
return mElementsUtil.getPackageOf(type).getQualifiedName().toString();
}
}複製程式碼
類註解@AutoServic用於自動生成META-INF資訊,對於AbstractProcessor的繼承類,需要宣告在META-INF裡,才能在編譯時生效。有了AutoService,可以自動把註解的類加入到META-INF裡。使用AutoService需要引入如下包:
compile 'com.google.auto.service:auto-service:1.0-rc2'複製程式碼
然後編譯時就會執行proces方法來生成程式碼,引數annotautions是一個集合,由於上面getSupportedAnnotationTypes返回的是@BindView註解,所以annotations引數裡包含所有被@BindView註解的元素。把各元素按照所在類來分組,放入map中,然後generateJavaClass方法中用該map來生成程式碼,這裡使用了javapoet包裡的類,能很方便的生成各種java類,方法,修飾符等等。方法體類程式碼看似複雜,但稍微學一下javapoet包的使用,就可以很快熟練該方法的作用,以下是編譯後生成出來的java類程式碼:
public final class BindMainActivity extends MainActivity {
public static void bind(MainActivity activity) {
activity.mBtn = (android.widget.Button)activity.findViewById(2131427422);
activity.mTextView = (android.widget.TextView)activity.findViewById(2131427423);
}
}複製程式碼
而被註解的原類如下:
public class MainActivity extends AppCompatActivity {
@BindView(R.id.btn)
protected Button mBtn;
@BindView(R.id.text)
protected TextView mTextView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
BindMainActivity.bind(this)
}
}複製程式碼
生成的java類位於如下位置:
mybutterknife module
按理說,上面已經完成了整個findViewById的程式碼生成,在MainActivity的onCreat方法裡,呼叫完setContentView後,就可以直接呼叫BindMainActivity.bindView(this)來完成各個View和id的繫結和例項化了。
但是我們觀察ButterKnife中的實現,不管是哪個Activity類,都是呼叫ButterKnife.bindView(this)方法來注入的。而在本專案的程式碼中,不同的類,就會生成不同名字繼承類,比如,如果另有一個HomeActivity類,那注入就要使用BindHomeActivity.bindView(this)來實現。
怎樣實現ButterKnife那樣統一方法來注入呢?
還是檢視原始碼,可以發現,ButterKnife.bindView方法使用的還是反射來呼叫生成的類中的方法,也就是說,ButterKnife.bindView只是提供了統一入口。
對照於此,在mybutterknife module裡,我們也可以用反射實現類似的方法路由,統一所有的注入方法入口:
public class ButterFork {
private static Map<Class,Method> classMethodMap = new HashMap<>();
public static void bind(Activity target){
if (target != null){
Method method = classMethodMap.get(target.getClass());
try {
if (method == null) {
String bindClassName = target.getClass().getPackage().getName() + ".Bind" + target.getClass().getSimpleName();
Class bindClass = Class.forName(bindClassName);
method = bindClass.getMethod("bind", target.getClass());
classMethodMap.put(target.getClass(), method);
}
method.invoke(null, target);
}catch (Exception e){
e.printStackTrace();
}
}
}
}複製程式碼
sample module
綜上,輕輕鬆鬆實現了我們自己的BindView註解,使用方式如下:
public class MainActivity extends AppCompatActivity {
@BindView(R.id.btn)
protected Button mBtn;
@BindView(R.id.text)
protected TextView mTextView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
MyButterKnife.bind(this);
mBtn.setText("changed");
mTextView.setText("changed too");
}
}複製程式碼
執行程式碼,完美!