Links

Replace DTO method parameters with data elements

org.openrewrite.java.migrate.DontOverfetchDto
Replace method parameters that have DTOs with their data elements when only the specified data element is used.

Recipe source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-migrate-java
  • version: 2.9.0

Options

Type
Name
Description
Example
String
dtoType
The fully qualified name of the DTO.
animals.Dog
String
dtoDataElement
Replace the DTO as a method parameter when only this data element is used.
name

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.DontOverfetchDtoExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.DontOverfetchDtoExample
displayName: Replace DTO method parameters with data elements example
recipeList:
- org.openrewrite.java.migrate.DontOverfetchDto:
dtoType: animals.Dog
dtoDataElement: name
Now that com.yourorg.DontOverfetchDtoExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.9.0 in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.DontOverfetchDtoExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.9.0")
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.DontOverfetchDtoExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-migrate-java</artifactId>
<version>2.9.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe DontOverfetchDtoExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors