项目终于用上了插入式注解，真香！
Java后端技术
共 9460字，需浏览 19分钟
·
2024-06-26 09:19
往期热门文章：
前言
需求
promethus来监控现在公司内使用各版本代码库的比例，希望达到的效果图如下：
问题
@TrisceliVersion
public static final String version = "";
@TrisceliVersion
public static final String version = "1.0.31-SNAPSHOT";
解决
@Setter的实现：
@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.SOURCE)
public @interface Setter {
// 略...
}
@Setter的Retention是SOURCE类型的，也就是说这个注解只在编译期有效，它甚至不会被编入class文件，所以lombok无疑是第一种解析方式，那用什么方式可以在编译期就让注解被解析到并执行我们的解析代码呢？答案就是定义插入式注解处理器（通过JSR-269提案定义的Pluggable Annotation Processing API实现）
@Documented
@Retention(RetentionPolicy.SOURCE) //只在编译期有效，最终不会打进class文件中
@Target({ElementType.FIELD}) //仅允许作用于类属性之上
public @interface TrisceliVersion {
}
AbstractProcessor的处理器：
/**
* {@link AbstractProcessor} 就属于 Pluggable Annotation Processing API
*/
public class TrisceliVersionProcessor extends AbstractProcessor {
private JavacTrees javacTrees;
private TreeMaker treeMaker;
private ProcessingEnvironment processingEnv;
/**
* 初始化处理器
*
* @param processingEnv 提供了一系列的实用工具
*/
@SneakyThrows
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
super.init(processingEnv);
this.processingEnv = processingEnv;
this.javacTrees = JavacTrees.instance(processingEnv);
Context context = ((JavacProcessingEnvironment) processingEnv).getContext();
this.treeMaker = TreeMaker.instance(context);
}
@Override
public SourceVersion getSupportedSourceVersion() {
return SourceVersion.latest();
}
@Override
public Set<String> getSupportedAnnotationTypes() {
HashSet<String> set = new HashSet<>();
set.add(TrisceliVersion.class.getName()); // 支持解析的注解
return set;
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement t : annotations) {
for (Element e : roundEnv.getElementsAnnotatedWith(t)) { // 获取到给定注解的element（element可以是一个类、方法、包等）
// JCVariableDecl为字段/变量定义语法树节点
JCTree.JCVariableDecl jcv = (JCTree.JCVariableDecl) javacTrees.getTree(e);
String varType = jcv.vartype.type.toString();
if (!"java.lang.String".equals(varType)) { // 限定变量类型必须是String类型，否则抛异常
printErrorMessage(e, "Type '" + varType + "'" + " is not support.");
}
jcv.init = treeMaker.Literal(getVersion()); // 给这个字段赋值，也就是getVersion的返回值
}
}
return true;
}
/**
* 利用processingEnv内的Messager对象输出一些日志
*
* @param e element
* @param m error message
*/
private void printErrorMessage(Element e, String m) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, m, e);
}
private String getVersion() {
/**
* 获取version，这里省略掉复杂的代码，直接返回固定值
*/
return "v1.0.1";
}
SPI机制被发现，所以需要定义META.services：
测试
往期热门文章：
1、只用Tomcat，不用Nginx行不行？ 2、听说你还在用Xshell？ 3、惊艳到我的 10个 MySQL高级查询技巧！ 4、我有点想用JDK17了 5、解放大脑：ChatGPT + PlantUML = 不用画图了 6、高逼格的SQL写法：行行比较 7、限流算法哪家强？时间窗口，令牌桶与漏桶算法对比 8、每天都提交代码，那你知道.git目录内部的秘密吗？ 9、我患上了空指针后遗症 10、这10个小技巧让你减少80%的Bug！
评论