javapoet的认识

这几天接触到了javapoet的知识，总的来说就是在编译时期生成java文件。一开始刚接触到的时候，觉得很黑科技，也确实，这方面的知识，不是很了解，今天就来做点笔记，方便大家学习。 这里是square公司的第三方库。想了解其使用方法，可以去github上面学习下。

javapoet，可以生成java文件的api，在各大框架里面也是使用的很频繁啊，像butterKnife、Dagger之类的啊。可以在源码里面找到其相关的用法。

咱们就从hello world!说起~

先上结果图，大家才有心思往下面去了解。

这个图展示的是，hello world 这个类是在编译的时候动态生成的。下面就具体来说说是如何生成的。

 MethodSpec main = MethodSpec.methodBuilder("main") //main代表方法名
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)//Modifier 修饰的关键字
                .returns(void.class)
                .addStatement("$T.out.println($S)", System.class,"Hello World")//添加代码，这里$T和$S后面会讲，这里其实就是添加了System,out.println("Hello World");
                .build();
        TypeSpec typeSpec = TypeSpec.classBuilder("HelloWorld")//HelloWorld是类名
                .addModifiers(Modifier.FINAL,Modifier.PUBLIC)
                .addMethod(main)  //在类中添加方法
                .build();
        JavaFile javaFile = JavaFile.builder("com.example.helloworld", typeSpec)
                .build();
        try {
            javaFile.writeTo(processingEnv.getFiler()); //生成java doc
        }catch (Exception e){
            e.printStackTrace();
        }

这段代码就是生成hello world 类的。

在项目中，我们需要使用自定义注解，这里我们就可以使用javapoet来生成java文件，不影响项目的逻辑，很多框架都是基于这个来做的。

ok,既然需要注解了，我们就自定义一个注解吧：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface  Test {
    String value() default "";
}

然后，处理注解的话，需要实现 AbstractProcessor这个类，实现其中的几个方法，具体操作，自行google~

AutoService(Processor.class)
public class MyClass extends AbstractProcessor{

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return Collections.singleton(Test.class.getCanonicalName());
    }
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        Set<? extends Element> elements=roundEnvironment.getElementsAnnotatedWith(Test.class);
        for(Element element:elements){
            if(element.getKind()!= ElementKind.CLASS){
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,"only support class");
            }
        }
        MethodSpec main = MethodSpec.methodBuilder("main") //main代表方法名
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)//Modifier 修饰的关键字
                .returns(void.class)
                .addStatement("$T.out.println($S)", System.class,"Hello World")//添加代码，这里$T和$S后面会讲，这里其实就是添加了System,out.println("Hello World");
                .build();
        TypeSpec typeSpec = TypeSpec.classBuilder("HelloWorld")//HelloWorld是类名
                .addModifiers(Modifier.FINAL,Modifier.PUBLIC)
                .addMethod(main)  //在类中添加方法
                .build();
        JavaFile javaFile = JavaFile.builder("com.example.helloworld", typeSpec)
                .build();
        try {
            javaFile.writeTo(processingEnv.getFiler()); //生成java doc
        }catch (Exception e){
            e.printStackTrace();
        }
        return false;
    }
}

这边的就是处理注解的完整代码了。然后我们再看Activity里面的代码

@Test("测试")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        try{
            Class clazz=Class.forName("com.example.helloworld.HelloWorld");
            Method method=clazz.getMethod("main");
            method.invoke(clazz);
        }catch (Exception e){
            e.printStackTrace();
        }
    }
}

通过反射的方式，运行刚刚生成的hello world类。

这里就把生成的hello world里面的打印字符串给打印出来了。是不是很厉害~

最后就是项目的地址了 https://github.com/zhairui/JavaPoetTest