重走JAVA之路（一）：覆盤ButterKnife-編譯時註解
摘要：
其實一直想寫這麼個系列，雖然Android開發大部分是基於Java語言的，但是日常開發中基本涉及的都比較簡單，當遇到一些疑難雜症的時候，很難去找到根因，本系列就針對一些平常開發比較少涉及的JAVA點，比如、註解、代理、併發等等，希望能幫到一些朋友重新鞏固下基礎知識。
今天我們主要來說道說道...
其實一直想寫這麼個系列，雖然Android開發大部分是基於Java語言的，但是日常開發中基本涉及的都比較簡單，當遇到一些疑難雜症的時候，很難去找到根因，本系列就針對一些平常開發比較少涉及的JAVA點，比如、註解、代理、併發等等，希望能幫到一些朋友重新鞏固下基礎知識。
今天我們主要來說道說道註解中另一種實現方式，編譯時註解（CLASS），不同於執行時註解（RUNTIME），大家比較熟悉的需要在程式碼執行時，反射拿到註解的引數值，然後再把值繫結回去，這樣反射畢竟消耗效能。著名的ButterKnife就是用的編譯時註解，利用APT在編譯時生成檔案，再去賦值，就不會有效能消耗問題啦~
1.編譯時註解
因為編譯時註解需要用到AbstractProcessor這個類，而這個是在JDK裡面的，所以我們需要Android Stuio中新建一個Java lib
建好之後，我們新建一個註解類
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface InjectView {
int value();
}
複製程式碼
然後我們在新建一個java類，整合 AbstractProcessor
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.ProcessingEnvironment;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
@AutoService(Processor.class)
public class BuildProcess extends AbstractProcessor {
private Filer mFiler;
private Messager mMessager;
@Override
public synchronized void init(ProcessingEnvironment mProcessingEnvironment) {
super.init(mProcessingEnvironment);
//初始化我們需要的基礎工具
mFiler = processingEnv.getFiler();
mMessager = processingEnv.getMessager();
}
@Override
public Set<String> getSupportedAnnotationTypes() {
Set<String> annotations = new LinkedHashSet<>();
annotations.add(InjectView.class.getCanonicalName());
return annotations;
}
@Override
public SourceVersion getSupportedSourceVersio() {
return SourceVersion.latestSupported();
}
@Override
public boolean process(Set<? extends TypeElement> mSet, RoundEnvironment mRoundEnvironment) {
return false;
}
}
複製程式碼
我們主要關注這4個方法
- init方法作為一個初始化的入口，做一些初始化工具類的操作
- getSupportedAnnotationTypes()，這個方法要求我們返回一個Set集合，從方法名我們應該也能看出來是一組支援註解型別的集合元素，這裡我們把註解類加進去，後續如果要添加註解，這裡需要手動再新增修改
- getSupportedSourceVersio()，返回支援的版本號，一般返回上次支援的版本號即可
- process()，大頭來了，這個方法是整個類的核心，也是實現編譯時註解最關鍵的地方，我們這裡從獲取到註解引數的值供我們呼叫，借鑑一波他人圖來展示一下
@AutoService(Processor.class)也是google出品的一個開源庫，省了我們需要寫配置檔案META-INF的工作。新增依賴
implementation 'com.google.auto.service:auto-service:1.0-rc3' 複製程式碼
首先看看最終需要生成的類，是不是似曾相識的樣子！：
接下來就是實現了，主要的程式碼當然就在process方法裡面了
@Override
public boolean process(Set<? extends TypeElement> mSet, RoundEnvironment mRoundEnvironment) {
Map<TypeElement, List<InjectViewField>> parseHashMap = getParseHashMap(mRoundEnvironment);
for (Map.Entry<TypeElement, List<InjectViewField>> entry : parseHashMap.entrySet()) {
TypeElement typeElement = entry.getKey();
List<InjectViewField> list = entry.getValue();
if (list == null || list.size() == 0) {
continue;
}
// 獲取包名
String packageName = mElementUtils.getPackageOf(typeElement).getQualifiedName().toString();
// 根據舊Java類名建立新的Java檔案
String className = typeElement.getQualifiedName().toString().substring(packageName.length() + 1);
String newClassName = className + "_ViewBinding";
//生成方法
MethodSpec.Builder methodBuilder = MethodSpec.constructorBuilder()
.addModifiers(Modifier.PUBLIC)
.addParameter(ClassName.bestGuess(className), "target");
for (InjectViewField injectViewField : list) {
String packageNameString = injectViewField.getFieldType().toString();
ClassName viewClass = ClassName.bestGuess(packageNameString);
methodBuilder.addStatement
("target.$L=($T)target.findViewById($L)", injectViewField.getFieldName()
, viewClass, injectViewField.getId());
}
TypeSpec typeBuilder = TypeSpec.classBuilder(newClassName)
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(methodBuilder.build())
.build();
JavaFile javaFile = JavaFile.builder(packageName, typeBuilder)
.addFileComment("Generated code from Butter Knife. Do not modify!")
.build();
try {
javaFile.writeTo(mFiler);
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
}
複製程式碼
private Map<TypeElement,List<InjectViewField>> getParseHashMap(RoundEnvironment mRoundEnvironment) {
Map<TypeElement,List<InjectViewField>> map = new HashMap<>();
List<InjectViewField> injectViewFields = new ArrayList<>();
for (Element element :mRoundEnvironment.getElementsAnnotatedWith(InjectView.class)) {
InjectViewField injectViewField = new InjectViewField(element);
injectViewFields.add(injectViewField);
map.put((TypeElement) element.getEnclosingElement(),injectViewFields);
}
return map;
}
複製程式碼
InjectViewField作為一個簡單的實體類封裝一些屬性
public class InjectViewField {
private int id;
private TypeElement mTypeElement;
private String fieldName;
private TypeMirror fieldType;
public InjectViewField(Element element) {
//獲取成員變數名稱mTextView
fieldName = element.getSimpleName().toString();
//獲取成員變數型別 TextView
fieldType = element.asType();
//獲取成員變數具體value R.id.textView
id = element.getAnnotation(InjectView.class).value();
//獲取完整類名
mTypeElement = (TypeElement) element.getEnclosingElement();
}
public int getId() {
return id;
}
public TypeElement getTypeElement() {
return mTypeElement;
}
public String getFieldName() {
return fieldName;
}
public TypeMirror getFieldType() {
return fieldType;
}
}
複製程式碼
這裡生成檔案用到了 javapoet ，這樣就不用自己手動去拼接字串，具體API使用方法，可以進去瞅瞅，也是出自square之手，非常簡便 然後再動動我們的小手，build一下，就能得到我們想要的檔案了~，然後我們看看怎麼使用
public class MainActivity extends AppCompatActivity {
private static final String TAG = "MainActivity";
@InjectView(R.id.textView)
TextView mTextView;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
InjectManager.init(this);
mTextView.setText("i have changed");
}
}
複製程式碼
很簡單吧！，看著和butterknife很類似，實際原理差不多，當然butterknife裡面涉及的還是蠻複雜的，但基本是通的，有興趣的可以去看看原始碼，butterknife，然後我們的InjectManager
public class InjectManager{
private static final String TAG = "InjectManager";
public static void init(Activity mActivity){
//1、獲取全限定類名
String name = mActivity.getClass().getName();
try {
//2、 根據全限定類名獲取通過註解直譯器生成的Java類
Class<?> clazz = mActivity.getClass().getClassLoader().loadClass(name + "_ViewBinding");
//3、 通過反射獲取構造方法並建立例項完成依賴注入
clazz.getConstructor(mActivity.getClass()).newInstance(mActivity);
} catch (Exception e) {
e.printStackTrace();
}
}
}
複製程式碼
有朋友要說了，你這個不也是反射嘛？emmm...確實是通過反射生成對應的檔案物件，但是起碼每個檔案只涉及到了一次反射，而不是像執行時註解，每個註解都需要反射拿到，所以 不要太苛刻了~~忽略忽略。。
大概基本就是這麼多，再來總結一波！
- 新建 java lib 庫，自定義類，繼承AbstractProcessor，最少複寫3個函式（init不需要的可以不復寫）
- 在process方法裡面獲取對應註解的變數、方法等等，存到Map裡，後續可以做一定的快取，減少消耗，使用javapoet，生成java檔案
- 通過反射拿到對應類的物件，執行賦值程式碼
好了，基本大概如此了，當然也有很多需要優化的地方，快取，設計結構等等，有興趣的朋友可以去嘗試嘗試，也是一個好的鍛鍊機會
有疑問的可以留言討論，感謝觀看 謝謝~~