前言
上篇主要講解了注解的基本操作，以及一個(gè)運(yùn)行時(shí)注解的小例子绰寞，今天我們主要來(lái)說(shuō)道說(shuō)道注解中另一種實(shí)現(xiàn)方式到逊，編譯時(shí)注解（CLASS）铣口，不同于上篇例子的運(yùn)行時(shí)注解（RUNTIME），需要在代碼運(yùn)行時(shí)觉壶，反射拿到注解的參數(shù)值脑题，然后再把值綁定回去，這樣反射畢竟消耗性能铜靶。著名的ButterKnife就是用的編譯時(shí)注解叔遂，利用APT在編譯時(shí)生成文件，再去賦值旷坦，就不會(huì)有性能消耗問(wèn)題啦~
1.編譯時(shí)注解
因?yàn)榫幾g時(shí)注解需要用到AbstractProcessor這個(gè)類(lèi)掏熬，而這個(gè)是在JDK里面的佑稠，所以我們需要Android Stuio中新建一個(gè)Java lib
建好之后秒梅，我們新建一個(gè)注解類(lèi)
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.FIELD)
public @interface InjectView {
int value();
}
然后我們?cè)谛陆ㄒ粋€(gè)java類(lèi)，集成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);
//初始化我們需要的基礎(chǔ)工具
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;
}
}
我們主要關(guān)注這4個(gè)方法
- init方法作為一個(gè)初始化的入口舌胶，做一些初始化工具類(lèi)的操作
- getSupportedAnnotationTypes()捆蜀，這個(gè)方法要求我們返回一個(gè)Set集合，從方法名我們應(yīng)該也能看出來(lái)是一組支持注解類(lèi)型的集合元素幔嫂，這里我們把注解類(lèi)加進(jìn)去辆它，后續(xù)如果要添加注解，這里需要手動(dòng)再添加修改
- getSupportedSourceVersio()履恩，返回支持的版本號(hào)锰茉，一般返回上次支持的版本號(hào)即可
-
process()，大頭來(lái)了切心，這個(gè)方法是整個(gè)類(lèi)的核心飒筑，也是實(shí)現(xiàn)編譯時(shí)注解最關(guān)鍵的地方，我們這里從獲取到注解參數(shù)的值供我們調(diào)用绽昏，借鑒一波他人圖來(lái)展示一下
image.png
@AutoService(Processor.class)也是google出品的一個(gè)開(kāi)源庫(kù)协屡，省了我們需要寫(xiě)配置文件META-INF的工作。添加依賴(lài)
implementation 'com.google.auto.service:auto-service:1.0-rc3'
首先看看我們我們最終需要生成的類(lèi)：
生成額外的java類(lèi)來(lái)進(jìn)行賦值操作全谤，避免反射帶來(lái)的風(fēng)險(xiǎn)
主要的代碼當(dāng)然就在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();
// 根據(jù)舊Java類(lèi)名創(chuàng)建新的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作為一個(gè)簡(jiǎn)單的實(shí)體類(lèi)封裝一些屬性
public class InjectViewField {
private int id;
private TypeElement mTypeElement;
private String fieldName;
private TypeMirror fieldType;
public InjectViewField(Element element) {
//獲取成員變量名稱(chēng)mTextView
fieldName = element.getSimpleName().toString();
//獲取成員變量類(lèi)型 TextView
fieldType = element.asType();
//獲取成員變量具體value R.id.textView
id = element.getAnnotation(InjectView.class).value();
//獲取完整類(lèi)名
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肤晓，這樣就不用自己手動(dòng)去拼接字符串，具體API使用方法认然，可以進(jìn)去瞅瞅补憾，也是出自square之手，非常簡(jiǎn)便
然后再動(dòng)動(dòng)我們的小手卷员，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");
}
}
很簡(jiǎn)單吧子刮！威酒，看著和butterknife很類(lèi)似窑睁，實(shí)際原理差不多，當(dāng)然butterknife里面涉及的還是蠻復(fù)雜的葵孤，但基本是通的担钮，有興趣的可以去看看源碼，butterknife尤仍，然后我們的InjectManager
public class InjectManager {
private static final String TAG = "InjectManager";
public static void init(Activity mActivity){
//1箫津、獲取全限定類(lèi)名
String name = mActivity.getClass().getName();
try {
//2、 根據(jù)全限定類(lèi)名獲取通過(guò)注解解釋器生成的Java類(lèi)
Class<?> clazz = mActivity.getClass().getClassLoader().loadClass(name + "_ViewBinding");
//3宰啦、 通過(guò)反射獲取構(gòu)造方法并創(chuàng)建實(shí)例完成依賴(lài)注入
clazz.getConstructor(mActivity.getClass()).newInstance(mActivity);
} catch (Exception e) {
e.printStackTrace();
}
}
}
有人要說(shuō)了苏遥，你這個(gè)不也是反射嘛？emmm...我竟無(wú)法反駁赡模。田炭。。漓柑。確實(shí)是通過(guò)反射生成對(duì)應(yīng)的文件對(duì)象教硫，但是起碼每個(gè)文件只涉及到了一次反射，而不是像運(yùn)行時(shí)注解辆布，每個(gè)注解都需要反射拿到瞬矩，所以 不要太苛刻了~~忽略忽略。锋玲。
大概基本就是這么多景用，再來(lái)總結(jié)一波！
- 新建java lib庫(kù)惭蹂，自定義類(lèi)伞插，繼承AbstractProcessor，最少?gòu)?fù)寫(xiě)3個(gè)函數(shù)（init不需要的可以不復(fù)寫(xiě)）
- 在process方法里面獲取對(duì)應(yīng)注解的變量剿干、方法等等蜂怎，存到Map里，后續(xù)可以做一定的緩存置尔，減少消耗杠步，使用javapoet，生成java文件
- 通過(guò)反射拿到對(duì)應(yīng)類(lèi)的對(duì)象榜轿，執(zhí)行賦值代碼
好了幽歼，基本大概如此了，當(dāng)然也有很多需要優(yōu)化的地方谬盐，緩存甸私，設(shè)計(jì)結(jié)構(gòu)等等，有興趣的朋友可以去嘗試嘗試飞傀，也是一個(gè)好的鍛煉機(jī)會(huì)
有疑問(wèn)的可以留言討論皇型，感謝觀看 謝謝~~
