插入式注解处理器

实战：插入式注解处理器

目标：检查是否符合驼式命名法

详细描述查看【深入理解Java虚拟机：JVM高级特性与最佳实践（第3版）】10.4 实战：插入式注解处理器（510页）

1.代码部分

1.注解处理器

NameCheckProcessor

package org.anno;import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.Element;
import javax.lang.model.element.TypeElement;
import java.util.Set;// 可以用"*"表示支持所有Annotations
@SupportedAnnotationTypes("*")
// 只支持JDK 6的Java代码
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class NameCheckProcessor extends AbstractProcessor {private NameChecker nameChecker;/*** 初始化名称检查插件*/@Overridepublic void init(ProcessingEnvironment processingEnv) {super.init(processingEnv);nameChecker = new NameChecker(processingEnv);}/*** 对输入的语法树的各个节点进行名称检查*/@Overridepublic boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {if (!roundEnv.processingOver()) {for (Element element : roundEnv.getRootElements())nameChecker.checkNames(element);}return false;}}

2.命名检查器

NameChecker

package org.anno;import javax.annotation.processing.Messager;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.*;
import javax.lang.model.util.ElementScanner8;import java.util.EnumSet;import static javax.lang.model.element.ElementKind.*;
import static javax.lang.model.element.Modifier.*;
import static javax.tools.Diagnostic.Kind.WARNING;/*** 程序名称规范的编译器插件：<br>* 如果程序命名不合规范，将会输出一个编译器的WARNING信息*/
public class NameChecker {private final Messager messager;NameCheckScanner nameCheckScanner = new NameCheckScanner();NameChecker(ProcessingEnvironment processsingEnv) {this.messager = processsingEnv.getMessager();}/**** 对Java程序命名进行检查，根据《Java语言规范》第三版第6.8节的要求，Java程序命名应当符合下列格式：** <ul>* <li>类或接口：符合驼式命名法，首字母大写。* <li>方法：符合驼式命名法，首字母小写。* <li>字段：* <ul>* <li>类、实例变量: 符合驼式命名法，首字母小写。* <li>常量: 要求全部大写。* </ul>* </ul>*/public void checkNames(Element element) {nameCheckScanner.scan(element);}/*** 名称检查器实现类，继承了JDK 6中新提供的ElementScanner6<br>* 将会以Visitor模式访问抽象语法树中的元素*/private class NameCheckScanner extends ElementScanner8<Void, Void> {/*** 此方法用于检查Java类*/@Overridepublic Void visitType(TypeElement e, Void p) {scan(e.getTypeParameters(), p);checkCamelCase(e, true);super.visitType(e, p);return null;}/*** 检查方法命名是否合法*/@Overridepublic Void visitExecutable(ExecutableElement e, Void p) {if (e.getKind() == METHOD) {Name name = e.getSimpleName();if (name.contentEquals(e.getEnclosingElement().getSimpleName()))messager.printMessage(WARNING, "一个普通方法 " + name + "不应当与类名重复，避免与构造函数产生混淆");checkCamelCase(e, false);}super.visitExecutable(e, p);return null;}/*** 检查变量命名是否合法*/@Overridepublic Void visitVariable(VariableElement e, Void p) {// 如果这个Variable是枚举或常量，则按大写命名检查，否则按照驼式命名法规则检查if (e.getKind() == ENUM_CONSTANT || e.getConstantValue() != null || heuristicallyConstant(e))checkAllCaps(e);elsecheckCamelCase(e, false);return null;}/*** 判断一个变量是否是常量*/private boolean heuristicallyConstant(VariableElement e) {if (e.getEnclosingElement().getKind() == INTERFACE)return true;else if (e.getKind() == FIELD && e.getModifiers().containsAll(EnumSet.of(PUBLIC, STATIC, FINAL)))return true;else {return false;}}/*** 检查传入的Element是否符合驼式命名法，如果不符合，则输出警告信息*/private void checkCamelCase(Element e, boolean initialCaps) {String name = e.getSimpleName().toString();boolean previousUpper = false;boolean conventional = true;int firstCodePoint = name.codePointAt(0);if (Character.isUpperCase(firstCodePoint)) {previousUpper = true;if (!initialCaps) {messager.printMessage(WARNING, "名称" + name + "应当以小写字母开头", e);return;}} else if (Character.isLowerCase(firstCodePoint)) {if (initialCaps) {messager.printMessage(WARNING, "名称" + name + "应当以大写字母开头", e);return;}} elseconventional = false;if (conventional) {int cp = firstCodePoint;for (int i = Character.charCount(cp); i < name.length(); i += Character.charCount(cp)) {cp = name.codePointAt(i);if (Character.isUpperCase(cp)) {if (previousUpper) {conventional = false;break;}previousUpper = true;} elsepreviousUpper = false;}}if (!conventional)messager.printMessage(WARNING, "名称“" + name + "应当符合驼式命名法（Camel Case Names）", e);}/*** 大写命名检查，要求第一个字母必须是大写的英文字母，其余部分可以是下划线或大写字母*/private void checkAllCaps(Element e) {String name = e.getSimpleName().toString();boolean conventional = true;int firstCodePoint = name.codePointAt(0);if (!Character.isUpperCase(firstCodePoint))conventional = false;else {boolean previousUnderscore = false;int cp = firstCodePoint;for (int i = Character.charCount(cp); i < name.length(); i += Character.charCount(cp)) {cp = name.codePointAt(i);if (cp == (int) '_') {if (previousUnderscore) {conventional = false;break;}previousUnderscore = true;} else {previousUnderscore = false;if (!Character.isUpperCase(cp) && !Character.isDigit(cp)) {conventional = false;break;}}}}if (!conventional)messager.printMessage(WARNING, "常量" + name + "应当全部以大写字母或下划线命名，并且以字母开头", e);}}
}

3.不规范命名的代码

package org.anno;public class BADLY_NAMED_CODE {enum colors {red, blue, green;}static final int _FORTY_TWO = 42;public static int NOT_A_CONSTANT = _FORTY_TWO;protected void BADLY_NAMED_CODE() {return;}public void NOTcamelCASEmethodNAME() {return;}
}

2.运行与测试

待编译的类目录：D:\ToolOfProductionData\IDEAFile\DemoTest\src\main\java\org\anno

1.运行测试

注意：因为有包名的缘故，如果直接在包下执行javac或者java 这样是找不到class文件的。

解决：去对应项目的java目录下执行命令 例如：cd D:\ToolOfProductionData\IDEAFile\DemoTest\src\main\java

d:
cd D:\ToolOfProductionData\IDEAFile\DemoTest\src\main\java
javac org/anno/NameChecker.java
有编码问题是则使用：javac -encoding utf-8 org/anno/NameChecker.java
javac org/anno/NameCheckProcessor.javajavac -processor org.anno.NameCheckProcessor org\anno\BADLY_NAMED_CODE.java
有编码问题是则使用：
javac -processor org.anno.NameCheckProcessor -encoding utf-8 org\anno\BADLY_NAMED_CODE.java

运行效果图

注意：javac编译问题

因为有包名的缘故，如果直接在包下执行javac或者java 这样是找不到 class文件的。

解决：去对应项目的java目录下执行命令 例如：D:\ToolOfProductionData\IDEAFile\DemoTest\src\main\java

详细请看：javac编译问题_找不到注释处理程序-CSDN博客

编译条件

待编译的类目录：D:\ToolOfProductionData\IDEAFile\DemoTest\src\main\java\org\anno

1.中文乱码

javac NameChecker.java

改成：

javac -encoding utf-8 NameChecker.java

2.引用其他类的时候，报找不到符号

（1）javac -encoding utf-8 *.java

（2） 换到src\main\java目录下：cd C:\work\workspace\my\my-utils\src\main\java

javac -encoding utf-8 com/my/jvm/processor/NameCheckProcessor.java

3.javac -processor报错

（1）java.lang.NoClassDefFoundError: NameCheckProcessor (wrong name: com/my/jvm/processor/NameCheckProcessor)

javac -processor NameCheckProcessor -encoding utf-8 .\BADLY_NAMED_CODE.java

（2）错误: 找不到注释处理程序 'com.my.jvm.processor.NameCheckProcessor'

javac -processor com.my.jvm.processor.NameCheckProcessor -encoding utf-8 .\BADLY_NAMED_CODE.java

因为有包名的缘故，如果直接在包下执行javac或者java 这样是找不到 class文件的。

解决：

cd  C:\work\workspace\my\my-utils\src\main\javajavac  -processor com.my.jvm.processor.NameCheckProcessor  -encoding utf-8  com\my\jvm\processor\BADLY_NAMED_CODE.java