OpenRewrite Recipe Writer FAQs

Name: OpenRewrite Recipe Writer
Author: openrewrite

Question 1

When should I use a declarative YAML recipe instead of Java?

Accepted Answer

You should use a declarative YAML recipe when your transformation can be achieved by composing existing recipes together. Use imperative Java recipes only when you need complex logic, conditional transformations, or custom analysis.

Question 2

What is a Lossless Semantic Tree (LST)?

Accepted Answer

An LST is a specialized type of abstract syntax tree used by OpenRewrite that preserves all original source information, including whitespace, formatting, and comments, allowing for 'lossless' automated refactoring.

Question 3

How do I ensure my OpenRewrite recipe is safe?

Accepted Answer

Safety is ensured by following the 'Do No Harm' principle, performing referential equality checks to return unchanged LSTs if no change is needed, and writing comprehensive tests using the RewriteTest framework.

Question 4

What is an OpenRewrite recipe?

Accepted Answer

An OpenRewrite recipe is an automated refactoring operation that modifies source code by transforming its Lossless Semantic Tree (LST), ensuring that changes are made safely while preserving original formatting and comments.

Question 5

What is the benefit of using JavaTemplate?

Accepted Answer

JavaTemplate allows you to define code changes using standard Java syntax strings rather than manually constructing LST elements, which significantly reduces the complexity and error rate of imperative recipe development.

OpenRewrite Recipe Writer

OpenRewrite Recipe Writer

主要功能

使用场景

主要功能

使用场景