java - 自动生成替换方法
问题描述
在为我正在制作的应用程序创建语言文件时,我遇到了很多样板代码。我目前有一个包含所有语言字符串的类,然后我使用反射将这些字符串写入文件。
我经常遇到的是,我的字符串中有某些要替换的占位符,例如,我可能有这样的字符串:
public static String USER_INFO = "Username: %name% money: %balance%";
我想要实现的是生成一些基于注释的方法,比如我可以使用 lombok 生成 getter/setter 和其他方法。基于上面的字符串,我会有一个名为Arguments
(正确地应该被命名为 Replacers 或更有意义的东西)的注释,如下所示:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.FIELD)
public @interface Arguments {
String[] value();
}
我想做的是添加这样的注释:
@Arguments(
value = {"%balance%", "%name%"}
)
public static String USER_INFO = "Username: %name% - money: %balance%";
并自动生成以下替换方法:
public static String USER_INFONameReplacement(String name) {
return USER_INFO.replace("%name%", name);
}
public static String USER_INFOAllReplacement(String name, String balance) {
return USER_INFO.replace("%name%", name).replace("%balance%", balance);
}
public static String USER_INFOBalanceReplacement(String balance) {
return USER_INFO.replace("%balance%", balance);
}
在做了一些搜索之后,我最终尝试在这样的类中实现 AbstractProcessor:
@SupportedAnnotationTypes(
{"io.github.freakyville.configHelper.annotations.Arguments"})
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@AutoService(Processor.class)
public class SuggestProcessor extends AbstractProcessor {
@Override
public synchronized void init(ProcessingEnvironment env) {
}
@Override
public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) {
for (TypeElement annoation : annoations) {
Set<? extends Element> annotatedElements = env.getElementsAnnotatedWith(annoation);
Map<Boolean, List<Element>> annotatedFields = annotatedElements.stream().collect(
Collectors.partitioningBy(element ->
((ArrayType) element.asType()).getComponentType().getClass().equals(PrimitiveType.class)));
List<Element> setters = annotatedFields.get(true);
if (setters.isEmpty()) {
continue;
}
String className = ((TypeElement) setters.get(0)
.getEnclosingElement()).getQualifiedName().toString();
Map<String, List<String>> setterMap = setters.stream().collect(Collectors.toMap(
setter -> setter.getSimpleName().toString(),
setter -> Arrays.asList(setter.getAnnotation(Arguments.class).value()))
);
try {
writeBuilderFile(className, setterMap);
} catch (IOException e) {
e.printStackTrace();
}
}
return true;
}
private void writeBuilderFile(
String className, Map<String, List<String>> setterMap)
throws IOException {
String packageName = null;
int lastDot = className.lastIndexOf('.');
if (lastDot > 0) {
packageName = className.substring(0, lastDot);
}
String builderSimpleClassName = className
.substring(lastDot + 1);
JavaFileObject builderFile = processingEnv.getFiler()
.createSourceFile(className);
try (PrintWriter out = new PrintWriter(builderFile.openWriter())) {
if (packageName != null) {
out.print("package ");
out.print(packageName);
out.println(";");
out.println();
}
out.print("public class ");
out.print(builderSimpleClassName);
out.println(" {");
out.println();
setterMap.forEach((key, orgArgNames) -> {
for (int i = 0; i < orgArgNames.size(); i++) {
List<String> subList = orgArgNames.subList(0, i + 1);
List<String> argNames = subList.stream().map(v -> v.replace("%", "") + "Replacement").collect(Collectors.toList());
List<String> argsWithTypes = argNames.stream().map(v -> "String " + v).collect(Collectors.toList());
String argumentList = "(" + String.join("", argsWithTypes).substring(0, argsWithTypes.size() - 3) + ")";
String methodName;
if (orgArgNames.size() <= 1) {
methodName = key + "Replace" + subList.stream().map(v -> v.replace("%", "")).collect(Collectors.joining(""));
} else {
methodName = key + "Replace" + subList.stream().map(v -> v.replace("%", "").substring(0, 1).toUpperCase() + v.substring(1)).collect(Collectors.joining(""));
}
out.print(" public static ");
out.print(methodName);
out.print(argumentList);
out.println("{");
StringBuilder replaceSB = new StringBuilder();
replaceSB.append(key);
for (int i1 = 0; i1 < subList.size(); i1++) {
replaceSB
.append(".replace(")
.append("\"")
.append(subList.get(i))
.append("\"")
.append(",")
.append(argNames.get(i))
.append(")");
}
String replace = replaceSB.toString();
out.println("return " + replace + ";");
out.println("}");
out.println("");
}
});
out.println("}");
}
}
}
但我似乎无法让它注册它?
所以我的第一个问题是,如果我想实现这一目标,AbstractProcessor 是否可行?如果不是那怎么办?如果是,那为什么不注册?我正在使用 IntelliJ 并进入设置 -> 构建 -> 编译器并将注释处理器更改为启用并将处理器路径设置为我的 SuggestProcessor
解决方案
Java 注释处理 (APT) 插件旨在生成基于其他类的代码。这些类最终在生成的源文件夹中,然后也被编译。这些 APT 插件是从类路径/构建工具配置中发现的,并且也由 IntelliJ 编译器运行。请记住:APT 用于生成源代码生成,而不是用于替换现有类。Lombok 仍然能够这样做的唯一原因是因为他们非常深入地侵入编译器,并且通过这种方式能够操纵正在编译的类的 AST。
由于这种方法在 Java 的未来版本中存在很大争议且容易出错,因此任何人都不太可能尝试构建基于 APT 的类替换框架或能够做到这一点的 Lombok 扩展(不是这是因为 Lombok 是唯一可以被视为此类 APT 使用“框架”的工具,并且 Lombok 本身根本不是以可扩展的方式构建的)。
结论:APT 可能是要走的路,但您的处理器将不得不创建一个新类,而不是尝试修改现有类。
关于如何创建注释处理器的示例,您可以查看以下存储库:https ://github.com/galberola/java-apt-simple-example
我不确定为什么您当前的注释处理器与您的编译器没有正确关联。如果您使用的是 Maven,您可以尝试在本地为您的处理器安装工件,并将其作为编译依赖项添加到您的其他项目中。不要忘记使用编译器将类注册为注释处理器,我引用的示例项目在这里执行此操作:https ://github.com/galberola/java-apt-simple-example/blob/master/example/ pom.xml#L29-L31。相同的配置也可以应用于其他构建系统。
Java 中没有真正的方法来修改编译下的类,所以如果你真的必须在同一个类中拥有该方法,那么不幸的是,这意味着它无法完成。
推荐阅读
- laravel - Telegram api文件下载问题与扩展
- html - 由 CSS 和 HTML 创建的电子邮件不适用于 gmail 应用 [iOS]
- powershell - 递归删除某些文件夹?
- c# - Outlook 无法在 c# 中读取 ToMailID 和 FromMailID
- ios - ios中的联系人选择器以获取电话号码
- python - 在这种情况下,如何使 python 脚本运行得更快或使用多进程?
- javascript - (Javascript) 在使用 html 和 js 查找代码中的错误时需要帮助
- php - 免费或收费送货 - Woo commerce
- spring-data-mongodb - 使用最新的 Spring Data Mongo 反应时的 Mongo 转换异常
- text-to-speech - 如何为 Windows 8 构建 flite 测试项目?