SpringBoot多Controller如何添加URL前缀

在Spring Boot应用中，我们经常会遇到需要为多个Controller添加统一URL前缀的场景。例如，我们可能希望将所有与用户相关的接口都放在/api/user路径下，而将所有与订单相关的接口都放在/api/order路径下。本文将详细介绍如何在Spring Boot中为多个Controller添加统一的URL前缀。

1. 使用@RequestMapping注解

最简单的方式是在每个Controller类上使用@RequestMapping注解，并指定一个统一的前缀。例如：

@RestController
@RequestMapping("/api/user")
public class UserController {

    @GetMapping("/info")
    public String getUserInfo() {
        return "User Info";
    }

    @GetMapping("/profile")
    public String getUserProfile() {
        return "User Profile";
    }
}

在这个例子中，UserController中的所有接口都会自动加上/api/user前缀。例如，getUserInfo方法的访问路径将是/api/user/info。

优点

• 简单直接，易于理解和实现。
• 每个Controller可以独立管理自己的前缀。

缺点

• 如果Controller数量较多，手动为每个Controller添加前缀会比较繁琐。
• 如果前缀需要统一修改，需要逐个修改每个Controller的@RequestMapping注解。

2. 使用@Configuration和RequestMappingHandlerMapping

如果你希望为多个Controller添加统一的前缀，而不想在每个Controller上手动添加@RequestMapping注解，可以通过自定义RequestMappingHandlerMapping来实现。

实现步骤

1. 创建一个配置类：在这个配置类中，我们可以自定义RequestMappingHandlerMapping，并为所有Controller添加统一的前缀。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

@Configuration
public class WebConfig {

    @Bean
    public RequestMappingHandlerMapping requestMappingHandlerMapping() {
        RequestMappingHandlerMapping handlerMapping = new RequestMappingHandlerMapping();
        handlerMapping.setUseTrailingSlashMatch(false);
        handlerMapping.setUseSuffixPatternMatch(false);
        handlerMapping.setOrder(0);
        handlerMapping.setPathPrefix("/api", c -> c.isAnnotationPresent(RestController.class));
        return handlerMapping;
    }
}

在这个配置类中，我们通过setPathPrefix方法为所有带有@RestController注解的Controller添加了/api前缀。

1. Controller类：Controller类不需要做任何修改，仍然可以像往常一样定义接口。

@RestController
public class UserController {

    @GetMapping("/user/info")
    public String getUserInfo() {
        return "User Info";
    }

    @GetMapping("/user/profile")
    public String getUserProfile() {
        return "User Profile";
    }
}

在这个例子中，UserController中的接口会自动加上/api前缀，因此getUserInfo方法的访问路径将是/api/user/info。

优点

• 可以统一管理所有Controller的前缀，避免手动为每个Controller添加前缀。
• 前缀的修改只需在配置类中进行，无需修改每个Controller。

缺点

• 实现相对复杂，需要对Spring MVC的内部机制有一定的了解。
• 如果需要对不同的Controller应用不同的前缀，配置会变得更加复杂。

3. 使用@ControllerAdvice和@ModelAttribute

另一种方式是通过@ControllerAdvice和@ModelAttribute来为所有Controller添加统一的前缀。这种方式适用于需要在所有Controller的请求路径前添加统一前缀的场景。

实现步骤

1. 创建一个ControllerAdvice类：在这个类中，我们可以通过@ModelAttribute方法为所有Controller的请求路径添加前缀。

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;

@ControllerAdvice
public class GlobalControllerAdvice {

    @ModelAttribute
    public void addPrefix(RequestMapping requestMapping) {
        String[] paths = requestMapping.value();
        for (int i = 0; i < paths.length; i++) {
            paths[i] = "/api" + paths[i];
        }
    }
}

在这个ControllerAdvice类中，我们通过@ModelAttribute方法为所有@RequestMapping注解的路径添加了/api前缀。

1. Controller类：Controller类不需要做任何修改，仍然可以像往常一样定义接口。

@RestController
public class UserController {

    @GetMapping("/user/info")
    public String getUserInfo() {
        return "User Info";
    }

    @GetMapping("/user/profile")
    public String getUserProfile() {
        return "User Profile";
    }
}

在这个例子中，UserController中的接口会自动加上/api前缀，因此getUserInfo方法的访问路径将是/api/user/info。

优点

• 可以统一管理所有Controller的前缀，避免手动为每个Controller添加前缀。
• 实现相对简单，不需要深入了解Spring MVC的内部机制。

缺点

• 这种方式只能为所有Controller添加统一的前缀，无法为不同的Controller应用不同的前缀。
• 如果需要对不同的Controller应用不同的前缀，这种方式不适用。

4. 使用ServletContext设置全局前缀

如果你希望在整个应用中为所有请求路径添加统一的前缀，可以通过配置ServletContext来实现。

实现步骤

1. 在application.properties中配置前缀：

server.servlet.context-path=/api

在这个配置中，我们通过server.servlet.context-path属性为整个应用设置了/api前缀。

1. Controller类：Controller类不需要做任何修改，仍然可以像往常一样定义接口。

@RestController
public class UserController {

    @GetMapping("/user/info")
    public String getUserInfo() {
        return "User Info";
    }

    @GetMapping("/user/profile")
    public String getUserProfile() {
        return "User Profile";
    }
}

在这个例子中，UserController中的接口会自动加上/api前缀，因此getUserInfo方法的访问路径将是/api/user/info。

优点

• 配置简单，只需在application.properties中设置即可。
• 适用于整个应用的前缀设置，无需修改任何Controller代码。

缺点

• 这种方式只能为整个应用设置统一的前缀，无法为不同的Controller应用不同的前缀。
• 如果需要对不同的Controller应用不同的前缀，这种方式不适用。

5. 总结

在Spring Boot中，为多个Controller添加统一的URL前缀有多种实现方式，每种方式都有其优缺点。选择哪种方式取决于具体的需求和场景：

• 如果只需要为少数几个Controller添加前缀，使用@RequestMapping注解是最简单直接的方式。
• 如果需要为多个Controller添加统一的前缀，并且希望统一管理，可以使用@Configuration和RequestMappingHandlerMapping。
• 如果需要为所有Controller添加统一的前缀，并且希望实现简单，可以使用@ControllerAdvice和@ModelAttribute。
• 如果需要为整个应用设置统一的前缀，可以使用ServletContext配置。

根据实际需求选择合适的方式，可以有效地简化代码管理，提高开发效率。