android 使用apt(编译时注解) 自动生成第三方的狗皮膏药代码

    在日常的Android项目开发中，免不了集成大量第三方库，由于各个公司开发风格不一，导致在项目集成过程中东粘一块西粘一块，对于有代码洁癖的人来说无疑是场灾难，面对第三方库如此强大的代码侵入性，我们无所适从，只能尽量整合，用良好的编码结构来规避混乱，不过java也为我们提供了一套在编译期自动生成代码的利器，让我们不再面对那些某些狗皮膏药似的代码，以微信登录为例(抛砖引玉)，做微信登录的朋友都知道集成它要强制编写一个WXEntryActivity类，包名还有一定规范，必须是apk包名下的.wxapi下，实在不能接受这种写法的朋友可以继续往下看，当然看完这篇文章，那么你对ButterKnife(通过自动生成代码),XUtils(通过反射实现比ButterKnife逊色)等诸多注解框架的核心原理也就知道了。

       首先为什么我们要自动生成微信Activity，直接写上去不是更方便吗？答案是为了抽取到基准库，我们作为开发人员都有自己的库文件，当需要开发项目时直接把库集成进来就可以了，而第三方微信的集成如登录，支付在正常情况下需要已知包名的情况下去书写类文件，而底层库不依赖于具体项目而存在，抽取有诸多不便。大致思路如下：首先我们在底层库中创建一个activity，在这个activity中完成微信登录后的所有操作逻辑并发出回调，对于上层用户(项目开发者)来说，他只关心微信的最终openId是否能得到，至于中间的过程就交给底层框架来处理，框架负责发出登录请求，接收微信返回并回馈给上层项目，最大限度实现解耦，现在切入正题。

---

 

 第一步：创建整个项目架构，如图：

       

 我们把整个项目拆分成四个部分。

1. android application模块—相当于主项目。
2. 注解模块— java库模块(定义注解的模块，因为annotation属于java范畴，所以只要是java工程即可)。
3. 注解编译模块—(同样是java模块，因为需要使用java及第三方的注解处理api)。
4. 核心库模块— (android库，因为核心库涉及到UI，网络以及抽取的基类如BaseActivity等，所以必须是android库)。

对于模块的拆分因人而异，不过在实际项目中模块的拆分我觉得是很有必要的，他可以灵活搭配，适度取舍。甚至以上这种拆分我都闲太集中，我们完全可以把apt-lib拆分为net library，ui library, utils library,还有各种thirdpart library，甚至可以更细，谁都不知道实际项目需要用到什么，当把没必要的库引入到了项目中，不但增加了包体大小，同时也影响了审美，对代码洁癖者来说是无法忍受的，不过在这里我就只用四个模块吧。

• apt-android 依赖 apt-lib
• apt-lib 依赖 apt-annotations 
• apt-android 编译期依赖apt-compiler  (就是在编译的时候使用apt-compiler来产生java代码在apt-android下的gradle配置中只要加上annotationProcessor project(':apt-compile')

• apt-compiler 依赖apt-annotations 同时也依赖部分第三方jar 
  compile 'com.squareup:javapoet:1.9.0’    (生成java类的关键库,提供了很多非常简洁的api)
  compile 'com.google.auto.service:auto-service:1.0-rc3’
  compile 'com.google.auto:auto-common:0.8’ 
  compile project(':apt-annotations’)
  
  
  

package com.late.apt.annotations;

import java.lang.annotation.Retention;

import java.lang.annotation.Target;

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.SOURCE)

public @interface WXActvityGenerator {

    //声明该注解所要生成的包名规则

    String getPackageName();

    //声明该注解所生成java类需要继承哪个父类

    Class<?> getSupperClass();

package com.late.apt.lib;

import android.os.Bundle;

import android.support.annotation.Nullable;

import android.support.v7.app.AppCompatActivity;

public class WXTemplateActivity extends AppCompatActivity {

    @Override

    protected void onCreate(@Nullable Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        //执行登录回调逻辑，包括请求token,获取openid,回给真实项目模块

    }

}

package com.xhl.apt;

import android.os.Bundle;

import android.support.v7.app.AppCompatActivity;

import com.late.apt.annotations.WXActvityGenerator;

import com.late.apt.lib.WXTemplateActivity;

@WXActvityGenerator(

        getPackageName = "com.xhl.apt",

        getSupperClass = WXTemplateActivity.class

)

public class MainActivity extends AppCompatActivity {

    @Override

    protected void onCreate(Bundle savedInstanceState) {

        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_main);

    }

}

这个类是java包中的专门处理注解的抽象类，我们只要实现process方法即可拿到注解上的元素信息，接着丢给一个注解元素访问者即AnnotationVisitor，我们通过他的visit+类型这类方法就可以拿到注解中定义的元素值，也就是packageName与需要继承的类。

最后我们编译工程就会发现我们的WXEntryActivity神不知鬼不觉的出现在了项目中，而且不用被你看见就可以使用他，毕竟眼不见为净。

而相关的处理逻辑我们已经在模板类中执行，这些逻辑是通用的，不管在哪个项目里都一样。等有新项目我们只要引入包，配置下依赖，配置下清单文件，再写个注解即可，根本不用重复在写登录分享逻辑了。

在这里只是以生成微信特有类为例来使用了一下apt，其实在我们的项目中apt还可以干更多的事，比如根据json文件自动生成java类，都是可以在编译期来实现的，再也不用你手写javaBean了，当然网上有这种工具，那如果我们自己实现岂不是很牛逼？

ButterKnife作为非常知名的注解框架也是使用了这一原理，无非就多了些处理逻辑，本质是一样的,我们来简单看下源码。

这就相当于我们的apt-annotations库，只是butterknife定义的注解多了点而已，注解本质就是为了识别属性与提供属性值而存在的。

这个类就是执行绑定的整个逻辑的库，本质最终处理还是会走findViewById(R.id.btn);

public final class ButterKnife {

}

在来看butterknife的compiler包

附github地址: https://github.com/lategege/apt-android/tree/master

在本文结尾向ButterKnife的作者致敬，让程序员摆脱了很多重复的没意义的代码，实属丰功伟绩。