Làm thế nào để đặt url cơ sở cho phần còn lại trong khởi động mùa xuân?

Tôi đang cố gắng kết hợp mvc và nghỉ ngơi trong một dự án khởi động mùa xuân duy nhất.

Tôi muốn đặt đường dẫn cơ sở cho tất cả các bộ điều khiển nghỉ (ví dụ: example.com/api) ở một nơi duy nhất ( @RequestMapping('api/products')thay vào đó, tôi không muốn chú thích từng bộ điều khiển bằng @RequestMapping('/products').

Bộ điều khiển Mvc phải có thể truy cập được bằng example.com/w Anything

Có khả thi không?

(Tôi không sử dụng phần còn lại dữ liệu mùa xuân, chỉ sử dụng mùa xuân mvc)

Với Spring Boot 1.2+ (<2.0), tất cả những gì cần là một thuộc tính duy nhất trong application.properties:

spring.data.rest.basePath=/api

liên kết tham chiếu: https://docs.spring.io/spring-data/rest/docs/current/reference/html/#getting-started.chacting-base-uri

Đối với 2.x, sử dụng

server.servlet.context-path=/api

Hơi muộn nhưng câu hỏi tương tự đã đưa tôi đến đây trước khi đạt được câu trả lời nên tôi đăng nó ở đây. Tạo (nếu bạn vẫn chưa có) một application.properties và thêm

server.contextPath=/api

Vì vậy, trong ví dụ trước nếu bạn có RestController bên @RequestMapping("/test")mình, bạn sẽ truy cập nó nhưlocalhost:8080/api/test/{your_rest_method}

nguồn câu hỏi: làm cách nào để chọn url cho ứng dụng web khởi động mùa xuân của tôi

Đối với phiên bản khung khởi động mùa xuân 2.0.4.RELEASE+. Thêm dòng này vàoapplication.properties

server.servlet.context-path=/api

Vì đây là lần đầu tiên google giải quyết vấn đề và tôi cho rằng sẽ có nhiều người tìm kiếm vấn đề này hơn. Có một tùy chọn mới kể từ Spring Boot '1.4.0'. Bây giờ có thể xác định một RequestMappingHandlerMapping tùy chỉnh cho phép xác định một đường dẫn khác cho các lớp được chú thích bằng @RestController

Bạn có thể tìm thấy một phiên bản khác với các chú thích tùy chỉnh kết hợp @RestController với @RequestMapping tại bài đăng trên blog này

@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);
                    }
                };
            }
        };
    }
}

Tôi không thể tin được câu trả lời cho câu hỏi tưởng chừng đơn giản này lại phức tạp đến mức nào. Dưới đây là một số tài liệu tham khảo:

• Vé mùa xuân JIRA
• Một câu hỏi SO khác
• Tuy nhiên, một câu hỏi SO khác
• GitRepository rất hay hiển thị sự cố

Có nhiều điều khác nhau cần xem xét:

1. Bằng cách cài đặt server.context-path=/apitrong application.propertiesbạn có thể định cấu hình tiền tố cho mọi thứ . (Server.context-path của nó không phải server.contextPath!)
2. Bộ điều khiển Spring Data được chú thích bằng @RepositoryRestController để hiển thị một kho lưu trữ dưới dạng điểm cuối còn lại sẽ sử dụng biến môi trường spring.data.rest.base-pathtrong application.properties. Nhưng đơn giản @RestControllersẽ không tính đến điều này. Theo tài liệu phần còn lại dữ liệu mùa xuân, có một chú thích @BasePathAwareControllermà bạn có thể sử dụng cho việc đó. Nhưng tôi gặp sự cố liên quan đến Spring-security khi cố gắng bảo vệ một bộ điều khiển như vậy. Nó không được tìm thấy nữa.

Một cách giải quyết khác là một thủ thuật đơn giản. Bạn không thể đặt trước một Chuỗi tĩnh trong một chú thích, nhưng bạn có thể sử dụng các biểu thức như sau:

@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\"}";
  }
}

Đối với Boot 2.0.0+, điều này phù hợp với tôi: server.servlet.context-path = / api

Tôi đã tìm thấy một giải pháp sạch, chỉ ảnh hưởng đến bộ điều khiển nghỉ.

@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);
    }
}

Khởi động mùa xuân sẽ đăng ký hai servlet điều phối viên - mặc định dispatcherServletcho bộ điều khiển và trình restApiđiều phối cho @RestControllersđược xác định trong 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 [/]

Ví dụ 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>

Tuy nhiên, bạn không bị giới hạn ở :

• sử dụng XmlWebApplicationContext, bạn có thể sử dụng bất kỳ loại ngữ cảnh nào khác có sẵn, tức là. AnnotationConfigWebApplicationContext, GenericWebApplicationContext, GroovyWebApplicationContext, ...
• xác định jsonMessageConverter, messageConvertersbean trong ngữ cảnh nghỉ, chúng có thể được xác định trong ngữ cảnh mẹ

Bạn có thể tạo chú thích tùy chỉnh cho bộ điều khiển của mình:

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

Sử dụng nó thay vì @RestController thông thường trên các lớp bộ điều khiển của bạn và chú thích các phương thức với @RequestMapping.

Vừa được thử nghiệm - hoạt động trong Spring 4.2!

Tôi có thể đến muộn một chút, NHƯNG ... Tôi tin rằng đó là giải pháp tốt nhất. Thiết lập nó trong application.yml của bạn (hoặc tệp cấu hình tương tự):

spring:
    data:
        rest:
            basePath: /api

Như tôi có thể nhớ đó là nó - tất cả các kho của bạn sẽ được hiển thị bên dưới URI này.

Hãy thử sử dụng PathMatchConfigurer (Spring Boot 2.x):

@Configuration
public class WebMvcConfig implements WebMvcConfigurer  {

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

Bạn có thể tạo một lớp cơ sở với @RequestMapping("rest")các chú thích và mở rộng tất cả các lớp khác của bạn với lớp cơ sở này.

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

Bây giờ tất cả các lớp mở rộng lớp cơ sở này sẽ có thể truy cập được tại rest/**.

Đối với những người sử dụng cấu hình YAML (application.yaml).

Lưu ý : điều này chỉ hoạt động choSpring Boot 2.x.x

server:
  servlet:
    contextPath: /api

Nếu bạn vẫn đang sử dụng Spring Boot 1.x

server:
  contextPath: /api

Với spring-boot 2.x, bạn có thể cấu hình trong application.properties:

spring.mvc.servlet.path=/api

server.servlet.context-path=/apisẽ là giải pháp tôi đoán. Tôi đã có cùng một vấn đề và điều này đã được tôi giải quyết. Tôi đã sử dụng server.context-path. Tuy nhiên, điều đó dường như không được dùng nữa và tôi thấy rằngserver.servlet.context-path giải quyết được vấn đề ngay bây giờ. Một giải pháp khác mà tôi tìm thấy là thêm thẻ cơ sở vào các trang giao diện người dùng (H5) của tôi. Tôi hy vọng giúp đỡ ai đó ngoài kia.

Chúc mừng

Giải pháp này áp dụng nếu:

1. Bạn muốn tiền tố RestControllernhưng không được Controller.

2. Bạn không sử dụng 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);
       }
   }

   }

Điều này tương tự như giải pháp được đăng bởi mh-dev, nhưng tôi nghĩ giải pháp này gọn gàng hơn một chút và điều này sẽ được hỗ trợ trên bất kỳ phiên bản nào của Spring Boot 1.4.0+, bao gồm cả 2.0.0+.

Mỗi tài liệu REST dữ liệu mùa xuân , nếu sử dụng application.properties , hãy sử dụng thuộc tính này để đặt đường dẫn cơ sở của bạn:

spring.data.rest.basePath=/api

Nhưng lưu ý rằng Spring sử dụng liên kết thư giãn , vì vậy biến thể này có thể được sử dụng:

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

... hoặc cái này nếu bạn thích:

spring.data.rest.base_path=/api

Nếu sử dụng application.yml , bạn sẽ sử dụng dấu hai chấm cho các dấu phân tách chính:

spring:
  data:
    rest:
      basePath: /api

(Để tham khảo, một phiếu liên quan đã được tạo vào tháng 3 năm 2018 để làm rõ các tài liệu.)

server.contextPath = / path đã hoạt động

Bạn có thể tạo chú thích tùy chỉnh cho bộ điều khiển của mình:

Sử dụng nó thay vì @RestController thông thường trên các lớp bộ điều khiển của bạn và chú thích các phương thức với @RequestMapping.

Hoạt động tốt trong Spring 4.2!