Java Annotation Processor

Java

本篇内容意图介绍什么是Java Annotation Processor（注解处理器），我们可以用它来做什么？如何编写它？

基础知识

首先要说明的是：我们不是在讨论在运行时如何使用注解（运行时=应用程序运行的时间），而注解处理是发生在编译时（编译时间= Java编译器编译Java源代码的时间）。

做什么？

使用注解处理器我们可以在编译Java源代码时生成我们所想要的Java文件，最熟悉的例子便是我们经常使用的Lombok插件，当然，Lombok插件是直接在我们的字节码文件上进行修改，而我们今天介绍的是如何生成新的Java文件。

所以我们应该如何在编译时使用@annotation生成想要的Java文件呢？

案例

假设我们现在开设了一个水果店，里面有各种各样的水果，苹果，香蕉，橘子.....，当客人需要某种水果时，我们将返回对应水果的价格，于是我们有了以下的例子：

水果接口

public interface Fruit {

    /**
     * 获取水果价格
     *
     * @return 水果价格
     */
    Float getPrice();
}

苹果

public class Apple implements Fruit {

    @Override
    public Float getPrice() {
        return 3F;
    }
}

香蕉

public class Banana implements Fruit{

    @Override
    public Float getPrice() {
        return 8F;
    }
}

由于类型会有很多，我们需要一个工厂类

public class FruitFactory {

  public static Fruit create(String id) {
    if("banana".equals(id)) {
      return new Banana();
    }
    if("apple".equals(id)) {
      return new Apple();
    }
    throw new IllegalArgumentException("Unknown id = " + id);
  }

}

水果订单

public class OrderFruit {

    /**
     * 获取水果价格
     *
     * @param fruitName 水果名称
     * @return 水果价格
     */
    public Float order(String fruitName){
        return FruitFactory.create(fruitName).getPrice();
    }
}

显然，以上是我们工厂模式的经典写法，看上去多么美好，那么还有什么问题吗？

假设我们多加了一种水果，那么就要修改FruitFactory，每次加一种水果，每次都要修改，当然你可能认为这无伤大雅，我也是如此认为，不过毕竟这只是个案例不是吗？我们就这样姑且认为它有问题吧～

如何改进我们的案例？

假设我们像Lombok这样有一个注解，比如叫做@Factory，当我们在水果类上加上该注解，编译时便会自动通过这些加了@Factory注解的水果类生成一个水果工厂，就像这样：

@Factory
public class Apple implements Fruit {

    @Override
    public Float getPrice() {
        return 3F;
    }
}

@Factory(id = "banana", type = Fruit.class)
public class Banana implements Fruit{

    @Override
    public Float getPrice() {
        return 8F;
    }
}

public class FruitFactory {
  
  public static Fruit create(String id) {
    if("banana".equals(id)) {
      return new Banana();
    }
    if("apple".equals(id)) {
      return new Apple();
    }
    throw new IllegalArgumentException("Unknown id = " + id);
  }
  
}

注意，这个FruitFactory是在编译时期自动生成的！

那么，怎么才能做到这样的效果呢？该我们的Java Annotation Processor登场啦！