blocks|key|4541732|text|如果您只想为某些控制器添加前缀，我找到了另外两个解决方案|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4541733|选项1-使用spring+SpEL为您的控制器添加一个前缀变量|4541734|@RestController
@RequestMapping(path+=+"${v1API}/users")
public+class+V1FruitsController+{

++++@GetMapping(path+=+"")
++++@ResponseBody
++++public+String+list(){
++++++++return+"[\"Joe\",+\"Peter\"]";
++++}
}|code-block|syntax|javascript|4541735|application.properties|4541736|v1API=/api/v1|4541737|选项2-创建自定义控制器注释|4541738|@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\"]";
++++}
}|4541739|然后测试它|4541740|curl+-X+GET+localhost:8080/api/v1/users|4541741|entityMap^0|0|0|0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|X|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|Y|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|Z|8|@]|9|@]|A|$]]|$1|K|3|L|5|F|7|10|8|@]|9|@]|A|$G|H]]|$1|M|3|N|5|6|7|11|8|@]|9|@]|A|$]]|$1|O|3|P|5|F|7|12|8|@]|9|@]|A|$G|H]]|$1|Q|3|R|5|6|7|13|8|@]|9|@]|A|$]]|$1|S|3|T|5|F|7|14|8|@]|9|@]|A|$G|H]]|$1|U|3|-4|5|6|7|15|8|@]|9|@]|A|$]]]|V|$]]

If you want to add prefix just for some controllers I found two others solutions 

<h3>Option 1 - Use spring SpEL to add a prefix variable for your controllers</h3>

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

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

application.properties

<pre><code>v1API=/api/v1
</code></pre>

<h3>Option 2 - Create a custom controller annotation</h3>

<pre><code>@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\"]";
 }
}
</code></pre>

then test it

<pre><code>curl -X GET localhost:8080/api/v1/users
</code></pre>

blocks|key|34574|text|如果您使用的是spring+boot+2+(spring+framework+5)，则可以替换application.properties中的属性|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|34575|server.contextPath|code-block|syntax|javascript|34576|适用于：|34577|server.servlet.context-path=|34578|entityMap^0|1B|M|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@$9|R|A|S|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|T|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|U|8|@]|D|@]|E|$]]|$1|M|3|N|5|H|7|V|8|@]|D|@]|E|$I|J]]|$1|O|3|-4|5|6|7|W|8|@]|D|@]|E|$]]]|P|$]]

If you are using spring boot 2 (spring framework 5), there is a replacement of the property in your <code>application.properties</code>:

<pre><code>server.contextPath
</code></pre>

for:

<pre><code>server.servlet.context-path=
</code></pre>

blocks|key|4541842|text|将application.properties中的默认路径添加为：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|4541843|server.servlet.contextPath=/mainPath|code-block|syntax|javascript|4541844|这里，/mainPath将是所有控制器的前缀|4541845|entityMap^0|1|M|0|0|3|9|0^^$0|@$1|2|3|4|5|6|7|O|8|@$9|P|A|Q|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|R|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|S|8|@$9|T|A|U|B|C]]|D|@]|E|$]]|$1|M|3|-4|5|6|7|V|8|@]|D|@]|E|$]]]|N|$]]

Add your default path in the <code>application.properties</code> as:

<pre><code>server.servlet.contextPath=/mainPath
</code></pre>

Here <code>/mainPath</code> will be the prefix for all the controller

blocks|key|34761|text|在Spring+Boot+2.3.1中，除了有关更改上下文路径的应用程序属性的其他注释之外，您还可以使用应用程序属性单独设置dispatcher+servlet的前缀。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|34762|spring.mvc.servlet.path=/api|code-block|syntax|javascript|34763|请求映射在您的控制器中不会改变。上下文路径将整个应用程序移动到不同的路径，而servlet路径仅限制由dispatcher+servlet处理的URL。servlet路径相当于web.xml中的servlet映射。可以从任何其他URL访问不使用dispatcher+servlet的其他资源。|34764|如果您有其他没有映射到/api前缀的控制器，那么这将不起作用，除非您为这些控制器声明了另一个具有不同前缀的dispatcher+servlet。|offset|length|style|CODE|34765|entityMap^0|0|0|0|B|4|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|S|8|@]|9|@]|A|$]]|$1|I|3|J|5|6|7|T|8|@$K|U|L|V|M|N]]|9|@]|A|$]]|$1|O|3|-4|5|6|7|W|8|@]|9|@]|A|$]]]|P|$]]

In addition to the other comments about changing the application property for the context path, you can also use an application property to set the prefix for the dispatcher servlet alone, in Spring Boot 2.3.1.
<pre><code>spring.mvc.servlet.path=/api
</code></pre>
The request mappings would not change in your controllers. While context path moves the entire application to a different path, servlet path only limits the URLs that are handled by the dispatcher servlet. The servlet path is the equivalent of the servlet mapping in web.xml. Other resources that do not use
the dispatcher servlet can be accessed from any other URL.
If you have other controllers that are not mapped to the <code>/api</code> prefix, then this will not work, unless you declare a second dispatcher servlet with a different prefix for those controllers.

blocks|key|34618|text|对于那些感兴趣的人，这里是Kotlin对deFreitas'+Option+2+Component的看法，因为我无法在application.yaml中使用spring.data.rest.basePath或server.servlet.contextPath。(这是Spring+Boot+2.1.2和Kotlin+1.13.11)|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|34619|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+=+""
)|code-block|syntax|javascript|34620|如果您使用的是IntelliJ，为了简洁起见，优化导入可能会删除Kotlin注释导入。|34621|entityMap|0|LINK|mutability|MUTABLE|url|https://stackoverflow.com/a/51182494/671896^0|1N|G|26|P|2W|Q|K|T|0|0|0|0^^$0|@$1|2|3|4|5|6|7|U|8|@$9|V|A|W|B|C]|$9|X|A|Y|B|C]|$9|Z|A|10|B|C]]|D|@$9|11|A|12|1|13]]|E|$]]|$1|F|3|G|5|H|7|14|8|@]|D|@]|E|$I|J]]|$1|K|3|L|5|6|7|15|8|@]|D|@]|E|$]]|$1|M|3|-4|5|6|7|16|8|@]|D|@]|E|$]]]|N|$O|$5|P|Q|R|E|$S|T]]]]

For those interested, here is a Kotlin take on <a href="https://stackoverflow.com/a/51182494/671896">deFreitas' Option 2 Component</a> as I was unable to use <code>spring.data.rest.basePath</code> or <code>server.servlet.contextPath</code> in <code>application.yaml</code>. (This is with Spring Boot 2.1.2 and Kotlin 1.13.11)

<pre><code>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 = ""
)
</code></pre>

If you're using IntelliJ, optimizing imports will probably remove the Kotlin annotation imports for brevity.

blocks|key|4541949|text|在application.yml中添加以下内容：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4541950|server:
++servlet:
++++context-path:+"/contextPath"|code-block|syntax|javascript|4541951|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

In application.yml add this:
<pre><code>server:
 servlet:
 context-path: &quot;/contextPath&quot;
</code></pre>

blocks|key|4541867|text|server.servlet.context-path是正确的路径。不是server.servlet.contextPath，不幸的是，它似乎不支持在web.xml中可以像这样做的列表：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|4541868|++++<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>|code-block|syntax|javascript|4541869|entityMap^0|0|R|10|Q|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@$9|N|A|O|B|C]|$9|P|A|Q|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|R|8|@]|D|@]|E|$I|J]]|$1|K|3|-4|5|6|7|S|8|@]|D|@]|E|$]]]|L|$]]

<code>server.servlet.context-path</code> is the correct path. Not <code>server.servlet.contextPath</code>, and unfortunately it doesn't seem to support lists which you could do in web.xml like this: 

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

blocks|key|4541912|text|附加的。如果你使用.yaml，你可以把它写成：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|4541913|server:
++servlet:
++++context-path:+/api|code-block|syntax|javascript|4541914|entityMap^0|9|5|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@$9|N|A|O|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|P|8|@]|D|@]|E|$I|J]]|$1|K|3|-4|5|6|7|Q|8|@]|D|@]|E|$]]]|L|$]]

Additional. If you use <code>.yaml</code>, you could write it as:

<pre><code>server:
 servlet:
 context-path: /api
</code></pre>

I have controller mappings to <code>/user</code> and <code>/order</code>:

<pre><code>@RestController
@RequestMapping("/users")
public class UserController {
 ...
}

@RestController
@RequestMapping("/orders")
public class OrderController {
 ...
}
</code></pre>

I want to access these by URL at <code>http://localhost:8080/api/users</code> and <code>http://localhost:8080/api/orders</code>, respectively.

How do I achieve this in Spring Boot?

How to specify prefix for all controllers in Spring Boot?

Spring Boot

Kotlin

我有到/user和/order的控制器映射@RestController@RequestMapping("/users")public class UserController {    ...}@RestController@RequestMapping("/orders")public class OrderController {    ...}我想分别在http://localhost:8

问如何在Spring Boot中为所有控制器指定前缀？
EN

回答 8

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何在Spring Boot中为所有控制器指定前缀？EN

回答 8

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何在Spring Boot中为所有控制器指定前缀？
EN