Как установить базовый URL для отдыха при весенней загрузке?

Я пытаюсь смешать mvc и отдых в одном проекте весенней загрузки.

Я хочу установить базовый путь для всех остальных контроллеров (например, example.com/api) в одном месте (я не хочу аннотировать каждый контроллер @RequestMapping('api/products'), вместо этого просто @RequestMapping('/products').

Контроллеры MVC должны быть доступны на example.com/whatever

Является ли это возможным?

(Я не использую Spring Data Rest, просто Spring mvc)

С Spring Boot 1.2+ (<2.0) все, что требуется, - это одно свойство в application.properties:

spring.data.rest.basePath=/api

Ссылка для ссылки: https://docs.spring.io/spring-data/rest/docs/current/reference/html/#getting-started.changing-base-uri

Для 2.x используйте

server.servlet.context-path=/api

Немного поздно, но тот же вопрос привел меня сюда, прежде чем я получил ответ, поэтому я публикую его здесь. Создайте (если у вас его еще нет) application.properties и добавьте

server.contextPath=/api

Итак, в предыдущем примере, если у вас есть RestController, @RequestMapping("/test")вы получите к нему доступ какlocalhost:8080/api/test/{your_rest_method}

источник вопроса: как мне выбрать URL-адрес для моего весеннего загрузочного веб-приложения

Для версии Spring boot framework 2.0.4.RELEASE+. Добавьте эту строку вapplication.properties

server.servlet.context-path=/api

Так как это первое обнаружение проблемы в Google, и я предполагаю, что больше людей будут ее искать. Начиная с Spring Boot 1.4.0 появилась новая опция. Теперь можно определить настраиваемый RequestMappingHandlerMapping, который позволяет определять другой путь для классов, аннотированных с помощью @RestController.

Другая версия с пользовательскими аннотациями, сочетающая @RestController с @RequestMapping, может быть найдена здесь. сообщении блога.

@Configuration
public class WebConfig {

    @Bean
    public WebMvcRegistrationsAdapter webMvcRegistrationsHandlerMapping() {
        return new WebMvcRegistrationsAdapter() {
            @Override
            public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
                return new RequestMappingHandlerMapping() {
                    private final static String API_BASE_PATH = "api";

                    @Override
                    protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) {
                        Class<?> beanType = method.getDeclaringClass();
                        if (AnnotationUtils.findAnnotation(beanType, RestController.class) != null) {
                            PatternsRequestCondition apiPattern = new PatternsRequestCondition(API_BASE_PATH)
                                    .combine(mapping.getPatternsCondition());

                            mapping = new RequestMappingInfo(mapping.getName(), apiPattern,
                                    mapping.getMethodsCondition(), mapping.getParamsCondition(),
                                    mapping.getHeadersCondition(), mapping.getConsumesCondition(),
                                    mapping.getProducesCondition(), mapping.getCustomCondition());
                        }

                        super.registerHandlerMethod(handler, method, mapping);
                    }
                };
            }
        };
    }
}

Я не мог поверить, насколько сложен ответ на этот, казалось бы, простой вопрос. Вот несколько ссылок:

• Весенний билет JIRA
• Еще один ТАК вопрос
• Еще один вопрос SO
• Очень хороший GitRepository, который демонстрирует проблему

Есть много разных вещей, которые следует учитывать:

1. Установив server.context-path=/apiв, application.propertiesвы можете настроить префикс для всего (его server.context-path, а не server.contextPath!)
2. Контроллеры Spring Data, аннотированные @RepositoryRestController, которые предоставляют репозиторий в качестве конечной точки отдыха, будут использовать переменную среды spring.data.rest.base-path в application.properties. Но Плейн @RestControllerэто во внимание не примет. Согласно документации Spring data rest, есть аннотация, @BasePathAwareControllerкоторую вы можете использовать для этого. Но у меня действительно возникают проблемы с Spring-security, когда я пытаюсь защитить такой контроллер. Больше не найдено.

Другой обходной путь - простой трюк. Вы не можете использовать префикс статической String в аннотации, но можете использовать такие выражения:

@RestController
public class PingController {

  /**
   * Simple is alive test
   * @return <pre>{"Hello":"World"}</pre>
   */
  @RequestMapping("${spring.data.rest.base-path}/_ping")
  public String isAlive() {
    return "{\"Hello\":\"World\"}";
  }
}

Для Boot 2.0.0+ это работает для меня: server.servlet.context-path = / api

Нашел чистое решение, которое затрагивает только остальные контроллеры.

@SpringBootApplication
public class WebApp extends SpringBootServletInitializer {

    @Autowired
    private ApplicationContext context;

    @Bean
    public ServletRegistrationBean restApi() {
        XmlWebApplicationContext applicationContext = new XmlWebApplicationContext();
        applicationContext.setParent(context);
        applicationContext.setConfigLocation("classpath:/META-INF/rest.xml");

        DispatcherServlet dispatcherServlet = new DispatcherServlet();
        dispatcherServlet.setApplicationContext(applicationContext);

        ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(dispatcherServlet, "/rest/*");
        servletRegistrationBean.setName("restApi");

        return servletRegistrationBean;
    }

    static public void main(String[] args) throws Exception {
        SpringApplication.run(WebApp.class,args);
    }
}

Spring boot зарегистрирует два сервлета диспетчера - по умолчанию dispatcherServletдля контроллеров и restApiдиспетчер для @RestControllersопределенных в rest.xml:

2016-06-07 09:06:16.205  INFO 17270 --- [           main] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'restApi' to [/rest/*]
2016-06-07 09:06:16.206  INFO 17270 --- [           main] o.s.b.c.e.ServletRegistrationBean        : Mapping servlet: 'dispatcherServlet' to [/]

Пример rest.xml:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
  http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd
  http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

    <context:component-scan base-package="org.example.web.rest"/>
    <mvc:annotation-driven/>

    <!-- Configure to plugin JSON as request and response in method handler -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <ref bean="jsonMessageConverter"/>
            </list>
        </property>
    </bean>

    <!-- Configure bean to convert JSON to POJO and vice versa -->
    <bean id="jsonMessageConverter" class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
    </bean>
</beans>

Но вы не ограничены :

• use XmlWebApplicationContext, вы можете использовать любой другой доступный тип контекста, т.е. AnnotationConfigWebApplicationContext, GenericWebApplicationContext, GroovyWebApplicationContext, ...
• определить jsonMessageConverter, messageConvertersbeans в контексте отдыха, они могут быть определены в родительском контексте

Вы можете создать собственную аннотацию для своих контроллеров:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@RestController
@RequestMapping("/test")
public @interface MyRestController {
}

Используйте его вместо обычного @RestController в ваших классах контроллера и аннотируйте методы с помощью @RequestMapping.

Только что протестировал - работает в Spring 4.2!

Я могу немного опоздать, НО ... Я считаю, что это лучшее решение. Настройте его в своем application.yml (или аналогичном файле конфигурации):

spring:
    data:
        rest:
            basePath: /api

Насколько я помню, это все - все ваши репозитории будут отображаться под этим URI.

Попробуйте использовать PathMatchConfigurer (Spring Boot 2.x):

@Configuration
public class WebMvcConfig implements WebMvcConfigurer  {

    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api", HandlerTypePredicate.forAnnotation(RestController.class));
    }
}

Вы можете создать базовый класс с @RequestMapping("rest")аннотациями и расширить все остальные классы этим базовым классом.

@RequestMapping("rest")
public abstract class BaseController {}

Теперь все классы, расширяющие этот базовый класс, будут доступны по адресу rest/**.

Для тех, кто использует конфигурацию YAML (application.yaml).

Примечание : это работает только дляSpring Boot 2.x.x

server:
  servlet:
    contextPath: /api

Если вы все еще используете Spring Boot 1.x

server:
  contextPath: /api

С Spring-boot 2.x вы можете настроить в application.properties:

spring.mvc.servlet.path=/api

server.servlet.context-path=/apiбыло бы решением, я думаю. У меня была такая же проблема, и это помогло мне решить. Я использовал server.context-path. Однако это казалось устаревшим, и я обнаружил, чтоserver.servlet.context-path теперь решает проблему. Еще один обходной путь, который я нашел, - это добавление базового тега к моим страницам внешнего интерфейса (H5). Надеюсь, это кому-то поможет.

ура

Это решение применимо, если:

1. Вы хотите префикс, RestControllerно неController .

2. Вы не используете Spring Data Rest.

   @Configuration
   public class WebConfig extends WebMvcConfigurationSupport {
   
   @Override
   protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() {
       return new ApiAwareRequestMappingHandlerMapping();
   }
   
   private static class ApiAwareRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
   
       private static final String API_PATH_PREFIX = "api";
   
       @Override
       protected void registerHandlerMethod(Object handler, Method method, RequestMappingInfo mapping) {
           Class<?> beanType = method.getDeclaringClass();
           if (AnnotationUtils.findAnnotation(beanType, RestController.class) != null) {
               PatternsRequestCondition apiPattern = new PatternsRequestCondition(API_PATH_PREFIX)
                       .combine(mapping.getPatternsCondition());
   
               mapping = new RequestMappingInfo(mapping.getName(), apiPattern, mapping.getMethodsCondition(),
                       mapping.getParamsCondition(), mapping.getHeadersCondition(), mapping.getConsumesCondition(),
                       mapping.getProducesCondition(), mapping.getCustomCondition());
           }
           super.registerHandlerMethod(handler, method, mapping);
       }
   }

   }

Это похоже на решение, опубликованное mh-dev, но я думаю, что оно немного чище и должно поддерживаться в любой версии Spring Boot 1.4.0+, включая 2.0.0+.

Per Spring Data REST документации , при использовании application.properties , использовать это свойство , чтобы установить базовый путь:

spring.data.rest.basePath=/api

Но обратите внимание, что Spring использует ослабленную привязку , поэтому можно использовать этот вариант:

spring.data.rest.base-path=/api

... или этот, если вы предпочитаете:

spring.data.rest.base_path=/api

Если вы используете application.yml , вы должны использовать двоеточия для разделителей ключей:

spring:
  data:
    rest:
      basePath: /api

(Для справки, в марте 2018 года был создан соответствующий тикет, чтобы прояснить документы.)

работал server.contextPath = / path

Вы можете создать собственную аннотацию для своих контроллеров:

Используйте его вместо обычного @RestController в ваших классах контроллера и аннотируйте методы с помощью @RequestMapping.

Прекрасно работает в Spring 4.2!