注解處理器的的作用

注解處理器可以在編譯時對@Retention值為AnnotationRetention.BINARY(kotlin)\RetentionPolicy.CLASS(java)的注解進行處理 ，實現(xiàn)對注解所在代碼的處理，例如打印日志、生成代碼等。是實現(xiàn)面向切面編程(AOP)的一種方式。

編寫方式

目標

目標

通過注解對person進行實例化，并賦值。

實現(xiàn)

Demo是一個安卓項目。

目錄結(jié)構(gòu)

標記3個部分是javaLibray，作用分別是：

• annotation：注解所在類
• complier：注解處理器所在類
• runtime:用于直接調(diào)用的類

PS:app在依賴著三個的模塊的時候，對complier不要使用api或implementation,而是使用kapt。

依賴

annotation部分

首先是在創(chuàng)建一個注解。

@Retention(value = AnnotationRetention.BINARY)
@Target(AnnotationTarget.FIELD)
annotation class Binding(val text: String) 

這段代碼的主要有兩個注解一個是@Retention，作用就是在什么情況下保留，選擇在編譯時保留。@Target為了方便選擇目標是Field。傳入?yún)?shù)的話是用于給person賦值使用。

complier部分

這部分主要就是注解處理的具體部分。

class BindProcessor : AbstractProcessor() {
    //用于打印消息
    private lateinit var messager: Messager
    //處理Element的工具類
    private lateinit var elementUtils: Elements
    //用于輸出文件
    private lateinit var filer: Filer
    //Type工具類
    private lateinit var typeUtils: Types
    override fun process(
        annotations: MutableSet<out TypeElement>,
        roundEnv: RoundEnvironment
    ): Boolean {  
        //獲取到被binding標記的元素
        roundEnv.getElementsAnnotatedWith(Binding::class.java).filter { it.kind.isField }.forEach {
            val variableElement = it as VariableElement
            val packageOf = elementUtils.getPackageOf(variableElement)
            val annotation = variableElement.getAnnotation(Binding::class.java)
            var element: Element = variableElement
            while (element.kind != ElementKind.CLASS) {
                element = element.enclosingElement
            }
            kotlin.runCatching {
                CodeProcess(
                    variableElement,
                    packageOf,
                    element as TypeElement,
                    annotation.text
                ).createCode(filer)
            }.onFailure { e ->
                messager.printMessage(Diagnostic.Kind.WARNING, e.localizedMessage)
            }
        }

        return true

    }

    override fun init(processingEnv: ProcessingEnvironment) {
        super.init(processingEnv)
        typeUtils = processingEnv.typeUtils
        elementUtils = processingEnv.elementUtils
        filer = processingEnv.filer
        messager = processingEnv.messager

    }

    //標記支持的版本
    override fun getSupportedSourceVersion(): SourceVersion {
        return SourceVersion.latestSupported()
    }
    
     //添加支持的注解有哪些
    override fun getSupportedAnnotationTypes(): MutableSet<String> {
        val annotations: MutableSet<String> = LinkedHashSet()
        annotations.add(Binding::class.java.canonicalName)
        return annotations
    }

}

代碼中可以看到主要重寫的4個方法

• process
  為對注解進行處理的核心方法
• init
  在調(diào)用注解處理器時會執(zhí)行的方法
• getSupportedSourceVersion
  用于確定支持的java版本
• getSupportedAnnotationTypes

process的主要過程就是
1.獲取注解
2.對注解進行分類，獲取注解標記的對應屬性，類，方法等。
3.對獲取到的信息進行處理，就本Demo而言，就是通過filer輸出用于創(chuàng)建的類。代碼通過CodeProcess類來處理信息

class CodeProcess(
    val element: VariableElement,
    pack: PackageElement,
    type: TypeElement,
    var text: String
) {
    var name: String = element.simpleName.toString()
    var packNameString: String = pack.toString()
    var codeClazzName = type.simpleName.toString() + "Binding"
    fun createCode(filer: Filer) {
        //創(chuàng)建方法
        val methodBuild = MethodSpec.methodBuilder("create")
            .addModifiers(Modifier.PUBLIC, Modifier.STATIC)   //設置為公開的靜態(tài)方法
            .returns(ClassName.get(element.asType()))    //輸入返回值類型
            .addStatement(" return new \$T(\$S)", ClassName.get(element.asType()), text)  //加入代碼語句
            .build()
        //創(chuàng)建class
        val typeBuild = TypeSpec.classBuilder(codeClazzName)
            .addModifiers(Modifier.PUBLIC)
            .addMethod(methodBuild)
            .build()
        //輸出java文件
        JavaFile.builder(packNameString, typeBuild)
            .build()
            .writeTo(filer)

    }

    override fun toString(): String {
        return "CodeProcess(element=$element, text='$text', name='$name', packNameString='$packNameString', codeClazzName='$codeClazzName')"
    }
}

代碼創(chuàng)建java文件，使用的時JavaPoet，具體的使用方法可以查看GitHub。其中$T、$S分別是類型和支付字符串的替換占位符。
在上面代碼完成以后,需要把注解處理器注冊到編譯器中。方式是在創(chuàng)建 resources文件。并在內(nèi)創(chuàng)建META-INF、service、javax.annotation.processing.Processor文件。然后在javax.annotation.processing.Processor內(nèi)添加，注解處理器的完整名稱(包名+類名)。

注冊注解處理器

注冊內(nèi)容

runtime部分

這一部分的主要目的就是提供一個對外的統(tǒng)一調(diào)用的方法。對于本Demo來說，就是他通過反射對注解標注的屬性進行實例化和賦值。

class BindingData {
    companion object {

        @JvmStatic
        fun bind(any: Any) {
            val bindingName = any.javaClass.name + "Binding"
            print(bindingName)
            val clazz = Class.forName(bindingName)
            val invoke = clazz.getMethod("create").invoke(null)//調(diào)用靜態(tài)方法
            val fields = any.javaClass.fields
            fields.filter { it.type == invoke.javaClass }.forEach {
                it.isAccessible = true
                it.set(any, invoke)//對屬性進行賦值
            }
        }
    }
}

結(jié)果

class MainActivity : AppCompatActivity() {
    @Binding("張三")
    lateinit var person: Person
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        BindingData.bind(this)
        val tv = findViewById<TextView>(R.id.tv)
        tv.setOnClickListener {
            tv.text = person.name
        }
    }
}

通過這一段文字就可以點擊獲取person的name。

注解處理器Demo地址