org.openrewrite.java.spring.boot2.ChangeEmbeddedServletContainerCustomizer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rewrite-spring Show documentation
Eliminate legacy Spring patterns and migrate between major Spring Boot versions. Automatically.
There is a newer version: 5.19.0
/*
 * Copyright 2021 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * https://www.apache.org/licenses/LICENSE-2.0
 * 
 * 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.boot2;

import org.openrewrite.*;
import org.openrewrite.internal.ListUtils;
import org.openrewrite.internal.lang.Nullable;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.JavaParser;
import org.openrewrite.java.search.UsesType;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.TypeUtils;

import static java.util.Objects.requireNonNull;

public class ChangeEmbeddedServletContainerCustomizer extends Recipe {

    @Nullable
    private static J.ParameterizedType webFactoryCustomizerIdentifier;

    private static final String DEPRECATED_INTERFACE_FQN = "org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer";

    @Override
    public String getDisplayName() {
        return "Adjust configuration classes to use the `WebServerFactoryCustomizer` interface";
    }

    @Override
    public String getDescription() {
        return "Find any classes implementing `EmbeddedServletContainerCustomizer` and change the interface to " +
                "`WebServerFactoryCustomizer`.";
    }

    @Override
    public TreeVisitor getVisitor() {
        return Preconditions.check(new UsesType<>(DEPRECATED_INTERFACE_FQN, false), new JavaIsoVisitor() {
            @Override
            public J.ClassDeclaration visitClassDeclaration(J.ClassDeclaration classDecl, ExecutionContext ctx) {
                J.ClassDeclaration c = super.visitClassDeclaration(classDecl, ctx);

                c = c.withImplements(
                        ListUtils.map(c.getImplements(), i -> {
                            if (TypeUtils.isOfClassType(i.getType(), DEPRECATED_INTERFACE_FQN)) {
                                maybeAddImport("org.springframework.boot.web.server.WebServerFactoryCustomizer");
                                maybeAddImport("org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory");
                                maybeRemoveImport(DEPRECATED_INTERFACE_FQN);
                                return getWebFactoryCustomizerIdentifier(ctx);
                            }
                            return i;
                        })
                );

                return c;
            }
        });
    }

    private static J.ParameterizedType getWebFactoryCustomizerIdentifier(ExecutionContext ctx) {
        // Really no need to use a JavaTemplate in this recipe, we just compile a stubbed out class and extract
        // the J.ParameterizedType from the class's stub's implements.
        if (webFactoryCustomizerIdentifier == null) {
            JavaParser parser = JavaParser
                    .fromJavaVersion()
                    .classpathFromResources(ctx, "spring-boot-2.*")
                    .build();
            J.CompilationUnit cu = parser.parse(
                    "import org.springframework.boot.web.server.WebServerFactoryCustomizer;\n" +
                            "import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;\n" +
                            "public abstract class Template implements WebServerFactoryCustomizer {}"
            )
                .map(J.CompilationUnit.class::cast)
                .findFirst()
                .get();

            webFactoryCustomizerIdentifier = (J.ParameterizedType) requireNonNull(cu.getClasses()
                    .get(0).getImplements()).get(0);
        }

        return webFactoryCustomizerIdentifier.withId(Tree.randomId());
    }
}