Bagaimana cara mengatur url dasar untuk istirahat di musim semi boot?

Saya mencoba untuk mencampur MVC dan istirahat dalam satu proyek boot musim semi.

Saya ingin menetapkan jalur dasar untuk semua pengontrol lainnya (mis. Example.com/api) di satu tempat (saya tidak ingin membubuhi keterangan setiap pengontrol dengan @RequestMapping('api/products'), sebagai gantinya, hanya @RequestMapping('/products').

Pengontrol Mvc harus dapat diakses melalui example.com/whatever

Apa itu mungkin?

(Saya tidak menggunakan pegas data rest, hanya pegas mvc)

Dengan Spring Boot 1.2+ (<2.0) yang dibutuhkan hanyalah satu properti di application.properties:

spring.data.rest.basePath=/api

tautan ref: https://docs.spring.io/spring-data/rest/docs/current/reference/html/#getting-started.changing-base-uri

Untuk 2.x, gunakan

server.servlet.context-path=/api

Agak terlambat tetapi pertanyaan yang sama membawa saya ke sini sebelum mencapai jawabannya jadi saya mempostingnya di sini. Buat (jika Anda masih belum memilikinya) sebuah application.properties dan tambahkan

server.contextPath=/api

Jadi pada contoh sebelumnya jika Anda memiliki RestController dengan @RequestMapping("/test")Anda akan mengaksesnya sepertilocalhost:8080/api/test/{your_rest_method}

sumber pertanyaan: bagaimana cara memilih url untuk aplikasi web boot musim semi saya

Untuk versi kerangka boot musim semi 2.0.4.RELEASE+. Tambahkan baris ini keapplication.properties

server.servlet.context-path=/api

Karena ini adalah serangan Google pertama untuk masalah ini dan saya berasumsi lebih banyak orang akan mencari ini. Ada opsi baru sejak Spring Boot '1.4.0'. Sekarang dimungkinkan untuk menentukan RequestMappingHandlerMapping kustom yang memungkinkan untuk menentukan jalur berbeda untuk kelas yang dianotasi dengan @RestController

Versi berbeda dengan anotasi khusus yang menggabungkan @RestController dengan @RequestMapping dapat ditemukan di entri blog ini

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

Saya tidak percaya betapa rumitnya jawaban atas pertanyaan yang tampaknya sederhana ini. Berikut beberapa referensinya:

• Tiket Musim Semi JIRA
• Pertanyaan SO lainnya
• Namun pertanyaan SO lainnya
• GitRepository yang sangat bagus yang menampilkan masalahnya

Ada banyak hal berbeda yang perlu dipertimbangkan:

1. Dengan mengatur server.context-path=/apidi application.propertiesAnda dapat mengkonfigurasi awalan untuk semuanya . (Server.context-pathnya bukan server.contextPath!)
2. Pengontrol Spring Data yang dianotasi dengan @RepositoryRestController yang mengekspos repositori sebagai endpoint lainnya akan menggunakan variabel lingkungan spring.data.rest.base-pathdi application.properties. Tapi jelas @RestControllertidak akan memperhitungkan ini. Menurut dokumentasi pegas data rest, ada anotasi @BasePathAwareControlleryang dapat Anda gunakan untuk itu. Tetapi saya memiliki masalah sehubungan dengan Spring-security ketika saya mencoba mengamankan pengontrol semacam itu. Itu tidak ditemukan lagi.

Solusi lain adalah trik sederhana. Anda tidak dapat memberi awalan String statis dalam anotasi, tetapi Anda dapat menggunakan ekspresi seperti ini:

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

Untuk Boot 2.0.0+ ini berfungsi untuk saya: server.servlet.context-path = / api

Saya menemukan solusi bersih, yang hanya memengaruhi pengontrol istirahat.

@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 akan mendaftarkan dua servlet dispatcher - default dispatcherServletuntuk pengontrol, dan restApidispatcher untuk @RestControllersditentukan di 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 [/]

Contoh 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>

Tapi, Anda tidak terbatas pada :

• gunakan XmlWebApplicationContext, Anda dapat menggunakan jenis konteks lain yang tersedia, yaitu. AnnotationConfigWebApplicationContext, GenericWebApplicationContext, GroovyWebApplicationContext, ...
• mendefinisikan jsonMessageConverter, messageConverterskacang dalam konteks istirahat, mereka dapat didefinisikan dalam konteks induk

Anda dapat membuat anotasi khusus untuk pengontrol Anda:

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

Gunakan ini sebagai ganti @RestController biasa pada kelas pengontrol Anda dan anotasi metode dengan @RequestMapping.

Baru saja diuji - berfungsi di Spring 4.2!

Saya mungkin agak terlambat, TAPI ... Saya yakin ini adalah solusi terbaik. Siapkan di application.yml Anda (atau file konfigurasi analogis):

spring:
    data:
        rest:
            basePath: /api

Seperti yang saya ingat, itu saja - semua repositori Anda akan ditampilkan di bawah URI ini.

Coba gunakan PathMatchConfigurer (Spring Boot 2.x):

@Configuration
public class WebMvcConfig implements WebMvcConfigurer  {

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

Anda dapat membuat kelas dasar dengan @RequestMapping("rest")penjelasan dan memperluas semua kelas lainnya dengan kelas dasar ini.

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

Sekarang semua kelas yang memperluas kelas dasar ini dapat diakses di rest/**.

Bagi mereka yang menggunakan konfigurasi YAML (application.yaml).

Catatan : ini hanya berfungsi untukSpring Boot 2.x.x

server:
  servlet:
    contextPath: /api

Jika Anda masih menggunakan Spring Boot 1.x

server:
  contextPath: /api

Dengan spring-boot 2.x Anda dapat mengonfigurasi di application.properties:

spring.mvc.servlet.path=/api

server.servlet.context-path=/apiakan menjadi solusi yang saya kira. Saya memiliki masalah yang sama dan ini membuat saya terselesaikan. Saya menggunakan server.context-path. Namun, itu sepertinya sudah usang dan saya menemukan itu server.servlet.context-pathmenyelesaikan masalah sekarang. Solusi lain yang saya temukan adalah menambahkan tag dasar ke halaman ujung depan (H5) saya. Saya harap ini membantu seseorang di luar sana.

Bersulang

Solusi ini berlaku jika:

1. Anda ingin memberi awalan RestControllertetapi tidak Controller.

2. Anda tidak menggunakan 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);
       }
   }

   }

Ini mirip dengan solusi yang diposting oleh mh-dev, tetapi menurut saya ini sedikit lebih bersih dan ini harus didukung pada versi apa pun dari Spring Boot 1.4.0+, termasuk 2.0.0+.

Per dokumen REST Data Musim Semi , jika menggunakan application.properties , gunakan properti ini untuk menyetel jalur dasar Anda:

spring.data.rest.basePath=/api

Tetapi perhatikan bahwa Spring menggunakan ikatan santai , sehingga variasi ini dapat digunakan:

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

... atau yang ini jika Anda lebih suka:

spring.data.rest.base_path=/api

Jika menggunakan application.yml , Anda akan menggunakan titik dua untuk pemisah kunci:

spring:
  data:
    rest:
      basePath: /api

(Sebagai referensi, tiket terkait dibuat pada Maret 2018 untuk mengklarifikasi dokumen.)

server yang berfungsi.contextPath = / jalur

Anda dapat membuat anotasi khusus untuk pengontrol Anda:

Gunakan ini sebagai ganti @RestController biasa pada kelas pengontrol Anda dan anotasi metode dengan @RequestMapping.

Berfungsi dengan baik di Spring 4.2!