Skip to content

Add NoHttpExchangeAnnotation #910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timtebeek merged 9 commits into from
Jan 27, 2026
Merged

Add NoHttpExchangeAnnotation #910

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6e8afeb
Add NoHttpExchangeAnnotation
nurdy-kim Jan 25, 2026
e693292
Apply suggestions from code review
timtebeek Jan 25, 2026
63f399d
add javadoc for describe receipe
nurdy-kim Jan 25, 2026
203d735
add NoHttpExchangeAnnotation to Recipe.csv
nurdy-kim Jan 25, 2026
16c854e
Apply suggestions from code review
nurdy-kim Jan 25, 2026
8147586
re-order imports
nurdy-kim Jan 25, 2026
7daeb80
Apply formatter
timtebeek Jan 27, 2026
208b8b2
Slight polish
timtebeek Jan 27, 2026
663925f
Merge branch 'main' into main
timtebeek Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 136 additions & 0 deletions src/main/java/org/openrewrite/java/spring/NoHttpExchangeAnnotation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
/*
* Copyright 2026 the original author or authors.
* <p>
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.spring;

import lombok.Getter;
import java.util.Optional;

import org.jspecify.annotations.Nullable;
import org.openrewrite.ExecutionContext;
import org.openrewrite.Preconditions;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.java.AnnotationMatcher;
import org.openrewrite.java.ChangeType;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.Space;

import java.util.Optional;

public class NoHttpExchangeAnnotation extends Recipe {

@Getter
final String displayName = "Remove `HttpExchange` annotations";

@Getter
final String description = "Replace method declaration `@HttpExchange` annotations with `@GetExchange`, `@PostExchange`, etc.";

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return Preconditions.check(
new UsesType<>("org.springframework.web.service.annotation.HttpExchange", false),
new NoHttpExchangeAnnotationVisitor());
}

private static class NoHttpExchangeAnnotationVisitor extends JavaIsoVisitor<ExecutionContext> {
private static final AnnotationMatcher HTTP_EXCHANGE_ANNOTATION_MATCHER = new AnnotationMatcher("@org.springframework.web.service.annotation.HttpExchange");

@Override
public J.Annotation visitAnnotation(J.Annotation annotation, ExecutionContext ctx) {
J.Annotation a = super.visitAnnotation(annotation, ctx);
if (HTTP_EXCHANGE_ANNOTATION_MATCHER.matches(a) && getCursor().getParentOrThrow().getValue() instanceof J.MethodDeclaration) {
Optional<J.Assignment> methodArg = findMethodArgument(a);
Optional<String> httpMethod = methodArg.map(this::extractHttpMethod);
String targetAnnotationClassName = httpMethod.map(this::toExchangeAnnotation).orElse(null);

if (targetAnnotationClassName == null) {
return a;
}

maybeRemoveImport("org.springframework.web.service.annotation.HttpExchange");

if (a.getArguments() != null) {
a = a.withArguments(ListUtils.map(a.getArguments(), arg ->
methodArg.get().equals(arg) ? null : arg));
}

maybeAddImport("org.springframework.web.service.annotation." + targetAnnotationClassName);
a = (J.Annotation)new ChangeType(
"org.springframework.web.service.annotation.HttpExchange",
"org.springframework.web.service.annotation." + targetAnnotationClassName,
false
).getVisitor().visit(a, ctx, getCursor().getParentOrThrow());

if (a != null && a.getArguments() != null && a.getArguments().size() == 1) {
a = a.withArguments(ListUtils.map(a.getArguments(), arg -> {
if (arg instanceof J.Assignment && ((J.Assignment)arg).getVariable() instanceof J.Identifier) {
J.Identifier ident = (J.Identifier)((J.Assignment)arg).getVariable();
if ("value".equals(ident.getSimpleName()) || "url".equals(ident.getSimpleName())) {
return ((J.Assignment)arg).getAssignment().withPrefix(Space.EMPTY);
}
}
return arg;
}));
}
}
return a != null ? a : annotation;
}

private Optional<J.Assignment> findMethodArgument(J.Annotation annotation) {
if (annotation.getArguments() == null) {
return Optional.empty();
}

return annotation.getArguments().stream()
.filter(arg -> arg instanceof J.Assignment &&
((J.Assignment)arg).getVariable() instanceof J.Identifier &&
"method".equals(((J.Identifier)((J.Assignment)arg).getVariable()).getSimpleName()))
.map(J.Assignment.class::cast)
.findFirst();
}

private @Nullable String extractHttpMethod(J.@Nullable Assignment assignment) {
if (assignment == null) {
return null;
}

if (assignment.getAssignment() instanceof J.Literal) {
Object value = ((J.Literal)assignment.getAssignment()).getValue();
if (value instanceof String) {
return (String)value;
}
}

return null;
}

private @Nullable String toExchangeAnnotation(String method) {
switch (method) {
case "GET":
case "POST":
case "PUT":
case "PATCH":
case "DELETE":
return method.charAt(0) + method.toLowerCase().substring(1) + "Exchange";
default:
return null;
}
}
}
}
234 changes: 234 additions & 0 deletions src/test/java/org/openrewrite/java/spring/NoHttpExchangeAnnotationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
/*
* Copyright 2024 the original author or authors.
* <p>
* Licensed under the Moderne Source Available License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://docs.moderne.io/licensing/moderne-source-available-license
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.spring;

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.InMemoryExecutionContext;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.java.Assertions.java;

class NoHttpExchangeAnnotationTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec.recipe(new NoHttpExchangeAnnotation())
.parser(JavaParser.fromJavaVersion()
.classpathFromResources(new InMemoryExecutionContext(), "spring-web-6.+"));
}

@DocumentExample
@Test
void getExchange() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "GET", value = "/api/users")
String getUsers();
}
""",
"""
import org.springframework.web.service.annotation.GetExchange;

interface UserApi {
@GetExchange("/api/users")
String getUsers();
}
"""
)
);
}

@Test
void postExchange() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "POST", value = "/api/users")
String postUser();
}
""",
"""
import org.springframework.web.service.annotation.PostExchange;

interface UserApi {
@PostExchange("/api/users")
String postUser();
}
"""
)
);
}

@Test
void putExchange() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "PUT", value = "/api/users/{id}")
String putUser();
}
""",
"""
import org.springframework.web.service.annotation.PutExchange;

interface UserApi {
@PutExchange("/api/users/{id}")
String putUser();
}
"""
)
);
}

@Test
void patchExchange() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "PATCH", value = "/api/users/{id}")
String patchUser();
}
""",
"""
import org.springframework.web.service.annotation.PatchExchange;

interface UserApi {
@PatchExchange("/api/users/{id}")
String patchUser();
}
"""
)
);
}

@Test
void deleteExchange() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "DELETE", value = "/api/users")
String deleteUser();
}
""",
"""
import org.springframework.web.service.annotation.DeleteExchange;

interface UserApi {
@DeleteExchange("/api/users")
String deleteUser();
}
"""
)
);
}

@Test
void methodOnlyWithoutValue() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "GET")
String getUsers();
}
""",
"""
import org.springframework.web.service.annotation.GetExchange;

interface UserApi {
@GetExchange
String getUsers();
}
"""
)
);
}

@Test
void noMethodArgument() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange("/api/users")
String getUsers();
}
"""
)
);
}

@Test
void multipleMethods() {
rewriteRun(
java(
"""
import org.springframework.web.service.annotation.HttpExchange;

interface UserApi {
@HttpExchange(method = "GET", value = "/api/users")
String getUsers();

@HttpExchange(method = "POST", value = "/api/users")
String createUser();

@HttpExchange(method = "DELETE", value = "/api/users/{id}")
void deleteUser();
}
""",
"""
import org.springframework.web.service.annotation.DeleteExchange;
import org.springframework.web.service.annotation.GetExchange;
import org.springframework.web.service.annotation.PostExchange;

interface UserApi {
@GetExchange("/api/users")
String getUsers();

@PostExchange("/api/users")
String createUser();

@DeleteExchange("/api/users/{id}")
void deleteUser();
}
"""
)
);
}
}
Loading