基于Maven 运行OpenRewrite的快速示例

本篇介绍一个基于Maven 运行OpenRewrite 的快速示例,展示了如何在Maven项目中使用OpenRewrite 进行代码重构。

本篇达成的效果是使用OpenRewrite 对源码自动格式化。

达成效果期望

项目中有一个类AutoFormatDemo ,类的代码如下

复制代码
public class AutoFormatDemo {public static void main(String[]args){System.out.println("Hello, World!");}}

使用OpenRewrite 自动格式化上面的代码。

步骤

  1. 在Maven项目中已经添加OpenRewrite Maven插件, 具体是在pom.xml 的<plugins> 节点添加插件

    org.openrewrite.maven rewrite-maven-plugin 5.34.1
  • 这里的version 可以配置使用最新的版本

命令行运行mvn rewrite:discover 可以查看所有可执行的配方列表, 执行的效果如下:

  1. 激活配方

在运行任何配方之前,需要更新插件配置以将所需配方标记为"active"。

OpenRewrite 官方提供了代码格式化的配方 org.openrewrite.java.format.AutoFormat。关于该配方的详细介绍可以参考:
OpenRewrite配方之代码格式化------org.openrewrite.java.format.AutoFormat

要激活这个配方,可以在pom.xml 中将插件的配置修改为:

复制代码
<plugin>
  <groupId>org.openrewrite.maven</groupId>
  <artifactId>rewrite-maven-plugin</artifactId>
  <version>5.34.1</version>
  <configuration>
    <activeRecipes>
      <recipe>org.openrewrite.java.format.AutoFormat</recipe>
    </activeRecipes>
  </configuration>
</plugin>
  1. 运行配方
    上面激活配方之后, 接下来就可以运行了。在命令行输入如下命令:

    mvn rewrite:run

执行过程中,控制台会输出如下信息:

查看原来的代码,会被格式化成如下:



相关推荐
booboosui14 小时前
安卓 8.1 也能装了:代价是一条黄字和两个静默 bug
android
小满、14 小时前
Java 值传递
java·java 值传递
IT枫斗者枫哥14 小时前
Java 异步导出只测最终行数,为什么下载时仍会少一行?
java·后端
张紫娃14 小时前
idea 如何看一个类的 .class 文件
java·ide·intellij-idea
南宫鑫15 小时前
Java底层实现
java
AI人工智能+电脑小能手15 小时前
IP地址合法性校验,这个Java工具类4个方法纯字符不查DNS
java·网络工具·ip校验·ipv6归一·字符校验
斯维赤15 小时前
SpringBoot接口调不通排查终极方案
java·后端·spring
山楂树の15 小时前
Java BigDecimal笔记
java·开发语言
旋风菠萝16 小时前
HashMap和CurrentHashMap的key可以为空吗
java·数据库·redis
开开心心就好16 小时前
PDF水印怎么去掉?勾选对象再点匹配
java·前端·mysql·支持向量机·pdf·音视频·模拟退火算法