webentwicklung-frage-antwort-db.com.de

Wie kann man ein Präfix für alle Controller in Spring Boot angeben?

Ich habe Controller-Zuordnungen zu /user und /order:

@RestController
@RequestMapping("/users")
public class UserController {
    ...
}

@RestController
@RequestMapping("/orders")
public class OrderController {
    ...
}

Ich möchte auf diese per URL unter http://localhost:8080/api/users bzw. http://localhost:8080/api/orders zugreifen.

Wie erreiche ich das im Spring Boot? 

39
Murali

Sie können eine Zuordnung zum Stammkontextpfad Ihrer Spring-Boot-Anwendung zu /api/* in Ihrer benutzerdefinierten Konfiguration bereitstellen. 

import org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration;
import org.springframework.boot.context.embedded.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.DispatcherServlet;

@Configuration
public class DispatcherServletCustomConfiguration {

    @Bean
    public DispatcherServlet dispatcherServlet() {
        return new DispatcherServlet();
    }

    @Bean
    public ServletRegistrationBean dispatcherServletRegistration() {
        ServletRegistrationBean registration = new ServletRegistrationBean(
                dispatcherServlet(), "/api/");
        registration.setName(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME);
        return registration;
    }
}

oder fügen Sie dies Ihrem application.properties im src\main\resources-Ordner hinzu

server.contextPath=/api/*

Mehr finden Sie hier Spring Boot Context Root und hier Servlet-Mapping zu DispatcherServlet hinzufügen

41
Tomasz Janek

Wenn Sie ein Präfix nur für einige Controller hinzufügen möchten, habe ich zwei andere Lösungen gefunden 

Option 1 - Verwenden Sie Spring SpEL, um eine Präfixvariable für Ihre Controller hinzuzufügen

@RestController
@RequestMapping(path = "${v1API}/users")
public class V1FruitsController {

    @GetMapping(path = "")
    @ResponseBody
    public String list(){
        return "[\"Joe\", \"Peter\"]";
    }
}

application.properties

v1API=/api/v1

Option 2 - Erstellen Sie eine benutzerdefinierte Controller-Anmerkung

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
@RequestMapping("/api/v1")
public @interface V1APIController {
    @AliasFor(annotation = Component.class)
    String value() default "";
}


@V1APIController
public class UserController {

    @RequestMapping("/users")
    @ReponseBody
    public String index(){
        return "[\"Joe\", \"Peter\"]";
    }
}

dann testen Sie es

curl -X GET localhost:8080/api/v1/users
12
deFreitas

Wenn Sie Federstiefel 2 (Federrahmen 5) verwenden, wird die Eigenschaft in Ihrem application.properties ersetzt:

server.contextPath

zum:

server.servlet.context-path=
2
Eduardo

Fügen Sie Ihren Standardpfad in das application.properties wie:

server.servlet.contextPath=/mainPath

Hier /mainPath ist das Präfix für alle Controller

2
Bishal Jaiswal

Für Interessenten ist hier eine Kotlin-Option auf die Option 2-Komponente von deFreitas , da ich spring.data.rest.basePath oder server.servlet.contextPath nicht in application.yaml verwenden konnte. (Dies gilt für Spring Boot 2.1.2 und Kotlin 1.13.11)

package com.myproject.controller

import org.springframework.core.annotation.AliasFor
import org.springframework.stereotype.Component
import org.springframework.web.bind.annotation.RequestMapping

import kotlin.annotation.MustBeDocumented
import kotlin.annotation.Retention
import kotlin.annotation.Target
import kotlin.annotation.AnnotationRetention

@Target(AnnotationTarget.CLASS, AnnotationTarget.FILE)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
@Component
@RequestMapping("/api/v1")
annotation class V1ApiController(
    @get:AliasFor(annotation = Component::class)
    val value: String = ""
)

Wenn Sie IntelliJ verwenden, werden bei der Optimierung von Importen die Kotlin-Annotationsimporte der Kürze halber entfernt.

0
geeves

server.servlet.context-path ist der richtige Pfad. Nicht server.servlet.contextPath, und leider unterstützt es keine Listen, die Sie in der Datei web.xml wie folgt erstellen könnten:

    <servlet>
        <description>Servlet used by Spring MVC to handle all requests into the application</description>
        <servlet-name>spring</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring-servlet.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>spring</servlet-name>
        <url-pattern>/app1/*</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>spring</servlet-name>
        <url-pattern>/app2/*</url-pattern>
    </servlet-mapping>
0
Gary Tessman