Open source

Rename bean

Recipe IDorg.openrewrite.java.spring.RenameBean

Artifactorg.openrewrite.recipe:rewrite-spring

Renames a Spring bean, both declaration and references.

Single recipeJavaModerne Source Available License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

3 parameters

2 required1 optional

Parameter	Example	Type	Required
newName	barBean	String	Required
The new name to give the matching bean.
oldName	fooBean	String	Required
The existing name of the bean to rename.
type	foo.MyType	String	Optional
The fully qualified name of the bean type to rename. If omitted, beans are matched by name alone.

Examples

java

Parameter	Value
type	sample.Foo
oldName	foo
newName	bar

java

Before

package sample;

import org.springframework.context.annotation.Configuration;
import sample.MyType;

@Configuration
class Foo {
}

After

package sample;

import org.springframework.context.annotation.Configuration;
import sample.MyType;

@Configuration
class Bar {
}

Diff

@@ -7,1 +7,1 @@

@Configuration
-class Foo {
+class Bar {
}

java

Parameter	Value
type	sample.MyType
oldName	foo
newName	bar

java

Before

package sample;

import org.springframework.context.annotation.Bean;
import sample.MyType;

class A {
    @Bean
    public MyType foo() {
        return new MyType();
    }
}

After

package sample;

import org.springframework.context.annotation.Bean;
import sample.MyType;

class A {
    @Bean
    public MyType bar() {
        return new MyType();
    }
}

Diff

@@ -8,1 +8,1 @@
class A {
    @Bean
-   public MyType foo() {
+   public MyType bar() {
        return new MyType();

java

Parameter	Value
type	sample.MyType
oldName	foo
newName	bar

java

Before

package sample;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import sample.MyType;

@Configuration
class A {
    @Bean
    public String myBean(@Qualifier("foo") MyType myType) {
        return "";
    }
}

After

package sample;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import sample.MyType;

@Configuration
class A {
    @Bean
    public String myBean(@Qualifier("bar") MyType myType) {
        return "";
    }
}

Diff

@@ -11,1 +11,1 @@
class A {
    @Bean
-   public String myBean(@Qualifier("foo") MyType myType) {
+   public String myBean(@Qualifier("bar") MyType myType) {
        return "";

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe RenameBean --recipe-option "type=foo.MyType" --recipe-option "oldName=fooBean" --recipe-option "newName=barBean"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.33.0

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.