为什么awt
Java SDK附带了java.awt.Robot
类,该类允许键盘和鼠标输入的自动化以及屏幕捕获的创建。 当您要编写一个模拟用户输入的小型测试应用程序时,或者只想自动化一些重复文本的输入时,此功能非常有用。 但是您不想每次都编写一个完整的Java应用程序。
另一方面,ANTLR是解析器生成器,使我们能够创建“特定于域的语言”(DSL)。 借助ANTLR,我们可以开发一个简单的DSL,它为java.awt.Robot
每种方法提供一个命令。 从那时起,我们可以轻松地为各种简单的自动化任务编写脚本。
第一步是发明新的“ DSL”的语法:
- 不同的“陈述”应以分号分隔。
- 每个语句应包含一个“命令”和该命令的几个参数。
- 注释应该跨越多行(使用类似C的注释/ *…* /,或者仅直到行尾为止。
一个简单的文件可能如下所示:
/*
* A simple example demonstrating the basic features.
*/
delay 300; // sleep for 300ms
mouseMove 20,30;
createScreenCapture 100,100,200,200 file=/home/siom/capture.png;
mouseClick button1;
keyboardInput "Test";
delay 400;
有了这些要求,我们就可以开始写下语法了:
grammar Robot;instructions:(instruction ';')+EOF;instruction:instructionDelay |instructionMouseMove |instructionCreateScreenCapture |instructionMouseClick |instructionKeyboardInput;
我们将语法命名为“机器人”,并定义第一条规则instructions
,以便我们拥有一个或多个指令,后跟一个分号作为指令分隔符,直到到达文件末尾(EOF)。 我们要支持的指令作为规则instruction
一部分列出。 不同规则之间的管道表示逻辑或,即这些规则中只有一个必须匹配。
最简单的规则是instructionDelay
之一:
instructionDelay:'delay' paramMs=INTEGER;
...
INTEGER:[0-9]+;
该规则以命令“ delay”开头,后跟唯一一个以整数形式指定要Hibernate的毫秒数的参数。 令牌INTEGER
显示在规则下方。 它只是定义了我们希望至少有一个介于0到9之间的数字。 为了便于以后处理参数,我们将参数分配给名为paramMs
的单独树节点。
进行屏幕截图的规则如下所示:
instructionCreateScreenCapture:'createScreenCapture' x=INTEGER ',' y=INTEGER ',' w=INTEGER ',' h=INTEGER 'file=' file=FILENAME;
...
FILENAME:FileNameChar+;
fragment FileNameChar:[a-zA-Z0-9/\\:_-$~.];
紧随其后的是关键字createScreenCapture
,用户必须在屏幕上应捕获的矩形的左上点提供两个坐标。 接下来的两个坐标表示矩形的宽度和高度。 最后,用户必须提供捕获图像的文件名。
文件名由片段FileNameChar
的一个或多个字符组成。 该fragment
定义了文件名应允许的所有字符。
使用maven,我们现在可以将此语法存储为src/main/antlr4
文件夹中的Robot.g4
文件,并利用相应的maven插件生成Java词法分析器和解析器:
<build><plugins><plugin><groupId>org.antlr</groupId><artifactId>antlr4-maven-plugin</artifactId><version>${antlr.version}</version><executions><execution><goals><goal>antlr4</goal></goals></execution></executions></plugin>...</plugins>
</build><dependencies><dependency><groupId>org.antlr</groupId><artifactId>antlr4-runtime</artifactId><version>${antlr.version}</version></dependency>...
</dependencies>
要在我们自己的代码中使用生成的类,必须依赖antlr4-runtime
。
方法execute()
将输入文件的Path
作为参数,然后解析并执行它:
public void execute(Path inputPath) throws IOException, AWTException {RobotLexer lexer = new RobotLexer(new ANTLRInputStream(new FileInputStream(inputPath.toFile())));RobotParser parser = new RobotParser(new CommonTokenStream(lexer));final Robot robot = new Robot();parser.addParseListener(new RobotBaseListener() {@Overridepublic void exitInstructionDelay(@NotNull RobotParser.InstructionDelayContext ctx) {int delayParam = Integer.parseInt(ctx.paramMs.getText());LOGGER.info("delay(" + delayParam + ")");robot.delay(delayParam);}...});parser.instructions();
}
文件的内容通过ANTLRInputStream
转发到由ANTLR生成的RobotLexer
。 在词法分析器解析文件并生成令牌流之后,可以将该流传RobotParser
实际的RobotParser
。
为了对传入的指令做出React,添加了ParseListener
。 幸运的是,ANTLR已经创建了一个基本侦听器,该侦听器使用空的实现来实现所有回调方法。 因此,我们只需要重写我们要处理的方法。 当ANTLR为每个解析器规则创建一个回调方法时,我们可以覆盖例如方法exitInstructionDelay()
。 生成的代码传递的参数的类型为RobotParser.InstructionDelayContex
。 正如我们之前在语法中将参数分配给单独的节点一样,此上下文对象具有字段paramMs
。 它的getText()
方法以String
返回此参数的值。 我们只需要将其转换为整数值,然后将其传递给Robot
实例的delay()
方法即可。
下面的块中显示了规则instructionCreateScreenCapture
的实现:
@Override
public void exitInstructionCreateScreenCapture(@NotNullRobotParser.InstructionCreateScreenCaptureContext ctx) {int x = Integer.parseInt(ctx.x.getText());int y = Integer.parseInt(ctx.y.getText());int w = Integer.parseInt(ctx.w.getText());int h = Integer.parseInt(ctx.h.getText());LOGGER.info("Rectangle rectangle = new Rectangle(" + x + "," + y + "," + w + "," + h + ")");Rectangle rectangle = new Rectangle(x, y, w, h);LOGGER.info("createScreenCapture(rectangle);");BufferedImage bufferedImage = robot.createScreenCapture(rectangle);File output = new File(ctx.file.getText());LOGGER.info("Save file to " + output.getAbsolutePath());try {ImageIO.write(bufferedImage, "png", output);} catch (IOException e) {throw new RuntimeException("Failed to write image file: " + e.getMessage(), e);}
}
原理与上一条指令所示的相同。 传入的上下文对象的每个参数都有一个字段,这些字符串值必须转换为整数值。 有了这些信息,我们就可以构造一个Rectangle
对象,调用Robot
的createScreenCapture()
方法并存储其BufferedImage
。
结论
为AWT的机器人创建专用DSL比预期容易。 所提供的maven插件从语法文件中创建所有必需的类,并与之平滑地集成到构建过程中。 生成的DSL可用于自动化简单的鼠标和键盘任务,包括创建屏幕截图。
- PS:源代码可从github获得 。
翻译自: https://www.javacodegeeks.com/2015/04/creating-a-dsl-for-awts-robot.html
为什么awt