Spring Boot (JAR) с несколькими сервлетами диспетчера для разных API REST с помощью Spring Data REST

Я нашел решение некоторое время назад, но забыл поделиться им здесь, поэтому спасибо, Ян, что напомнил мне об этом.

Я решил это, создав и зарегистрировав несколько сервлетов диспетчеров с новыми контекстами веб-приложений с разными конфигурациями (RepositoryRestMvcConfiguration) и общим родительским элементом, который является контекстом корневого приложения для приложения Spring Boot. Чтобы включить модули API автоматически в зависимости от различных jar-файлов, включенных в путь к классам, я эмулировал то, что Spring Boot делает более или менее.

Проект разделен на несколько модулей gradle. Что-то вроде этого:

• проект-сервер
• проект-api-autoconfigure
• проект-модуль-а-API
• проект-модуль-b-api
• ...
• проект-модуль-н-API

Модуль project-server является основным. Он объявляет зависимость от project-api-autoconfigure и в то же время исключает транзитивные зависимости project-api-autoconfigure от project-module-? -api модуль (ы).

Внутри project-server.gradle:

dependencies {
    compile (project(':project-api-autoconfigure')) {
        exclude module: 'project-module-a-api'
        exclude module: 'project-module-b-api'
        ...
    }
    ...
}

project-api-autoconfigure зависит от всех модулей API, поэтому зависимости в project-api-autoconfigure.gradle будут выглядеть следующим образом:

dependencies {
    compile project(':project-module-a-api')
    compile project(':project-module-b-api')
    ...
}

project-api-autoconfigure - это то место, где я создаю компоненты сервлета диспетчера с их собственным контекстом веб-приложения для каждого модуля API, но эти конфигурации зависят от классов конфигурации каждого модуля API, которые находятся внутри каждого модуля API. банка.

Я создал абстрактный класс, от которого наследуются все классы автоконфигурации:

public abstract class AbstractApiModuleAutoConfiguration<T> {

    @Autowired
    protected ApplicationContext applicationContext;

    @Autowired
    protected ServerProperties server;

    @Autowired(required = false)
    protected MultipartConfigElement multipartConfig;

    @Value("${project.rest.base-api-path}")
    protected String baseApiPath;

    protected DispatcherServlet createApiModuleDispatcherServlet() {
        AnnotationConfigWebApplicationContext webContext = new AnnotationConfigWebApplicationContext();
        webContext.setParent(applicationContext);
        webContext.register(getApiModuleConfigurationClass());
        return new DispatcherServlet(webContext);
    }

    protected ServletRegistrationBean createApiModuleDispatcherServletRegistration(DispatcherServlet apiModuleDispatcherServlet) {
        ServletRegistrationBean registration = new ServletRegistrationBean(
                apiModuleDispatcherServlet,
                this.server.getServletMapping() + baseApiPath + "/" + getApiModulePath() + "/*");

        registration.setName(getApiModuleDispatcherServletBeanName());
        if (this.multipartConfig != null) {
            registration.setMultipartConfig(this.multipartConfig);
        }
        return registration;
    }

    protected abstract String getApiModuleDispatcherServletBeanName();

    protected abstract String getApiModulePath();

    protected abstract Class<T> getApiModuleConfigurationClass();

}

Итак, теперь класс автоконфигурации для модуля A будет выглядеть примерно так:

@Configuration
@ConditionalOnClass(ApiModuleAConfiguration.class)
@ConditionalOnProperty(prefix = "project.moduleA.", value = "enabled")
public class ApiModuleAAutoConfiguration extends AbstractApiModuleAutoConfiguration<ApiModuleAConfiguration> {

    public static final String API_MODULE_A_DISPATCHER_SERVLET_BEAN_NAME = "apiModuleADispatcherServlet";
    public static final String API_MODULE_A_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME = "apiModuleADispatcherServletRegistration";

    @Value("${project.moduleA.path}")
    private String apiModuleAPath;

    @Bean(name = API_MODULE_A_DISPATCHER_SERVLET_BEAN_NAME)
    public DispatcherServlet apiModuleADispatcherServlet() {
        return createApiModuleDispatcherServlet();
    }

    @Bean(name = API_MODULE_A_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
    public ServletRegistrationBean apiModuleADispatcherServletRegistration() {
        return createApiModuleDispatcherServletRegistration(apiModuleADispatcherServlet());
    }

    @Override
    protected String getApiModuleDispatcherServletBeanName() {
        return API_MODULE_A_DISPATCHER_SERVLET_BEAN_NAME;
    }

    @Override
    protected String getApiModulePath() {
        return apiModuleAPath;
    }

    @Override
    protected Class<ApiModuleAConfiguration> getApiModuleConfigurationClass() {
        return ApiModuleAConfiguration.class;
    }

}

И теперь ваши классы конфигурации ApiModuleAConfiguration, ApiModuleBConfiguration ... будут в каждом модуле api project-module-a-api, модуль-проект-b-api ...

Они могут быть RepositoryRestMvcConfiguration, могут расширяться от него, или они могут быть любым другим классом конфигурации, который импортирует конфигурацию Spring Data REST.

И последнее, но не менее важное: я создал различные скрипты gradle внутри основного модуля project-server для загрузки на основе свойства, переданного в gradle для имитации профилей Maven. Каждый сценарий объявляет в качестве зависимостей модули api, которые необходимо включить. Выглядит это примерно так:

- project-server
    /profiles/
        profile-X.gradle
        profile-Y.gradle
        profile-Z.gradle

и, например, profile-X включает модули API A и B:

dependencies {
    compile project(':project-module-a-api')
    compile project(':project-module-b-api')
}

processResources {
    from 'src/main/resources/profiles/profile-X'
    include 'profile-x.properties'
    into 'build/resources/main'
}

Другие профили могут включать разные модули API.

Профили загружаются из project-server.gradle следующим образом:

loadProfile()

processResources {
    include '**/*'
    exclude 'profiles'
}

dependencies {
        compile (project(':project-api-autoconfigure')) {
            exclude module: 'project-module-a-api'
            exclude module: 'project-module-b-api'
            ...
        }
        ...
    }

...

def loadProfile() {
    def profile = hasProperty('profile') ? "${profile}" : "dev"
    println "Profile: " + profile
    apply from: "profiles/" + profile + ".gradle"
}

И это все более-менее. Надеюсь, это поможет вам, Ян.

Ваше здоровье.