自动 URL 前缀

什么意思呢？

在如下项目结构中：

——top.conanan.demo
————api
——————v1
————————HelloController
——————v2
————————Hello2Controller

HelloController 如下：

@RestController
@RequestMapping("/v1/hello")
public class HelloController {

    @PostMapping("/test")
    public String test() {
        return "hello world";
    }
}

当我们要访问 test 接口时，请求的 url 为：host:port/v1/hello/test

那么如何不用写 v1或v2呢？

可以重写WebMvcRegistrations接口的getRequestMappingHandlerMapping()方法

@Configuration// 必须加上 @Configuration
public class AutoPrefixConfiguration implements WebMvcRegistrations {

    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        return new AutoPrefixUrlMapping();
    }
}

/**
 * RequestMappingHandlerMapping Spring MVC 用于处理 @RequestMapping 的类
 */
public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping {

    @Value("${missyou.api-package}")
    public String apiPackage;


    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {

        RequestMappingInfo requestMappingInfo = super.getMappingForMethod(method, handlerType);

        // 这里除了自己写的 @RequestMapping 等注解和系统的 /error 不为 null，其余都为 null（会自动生成需要 RequestMapping）
        if (requestMappingInfo == null){
            return null;
        }

        // 这里只拦截如 com.lin.missyou.api 的包下的 @RequestMapping，
        // 其他的 Spring 默认配置的 @RequestMapping 都直接放掉（如, /error）
        String packageName = handlerType.getPackage().getName();
        if (!packageName.startsWith(apiPackage))
            return requestMappingInfo;


        // 这里才是拦截到"自己"添加 @RequestMapping 注解的方法
        String prefix = getPrefix(handlerType);
        // 注意这里的 RequestMappingInfo 只有静态方法可以操作该类
        // combine 联合。拼接前缀和 @RequestMapping 注解的 value
        return RequestMappingInfo.paths(prefix).build().combine(requestMappingInfo);


    }

    private String getPrefix(Class<?> handlerType){
        // 获取的包名如：com.lin.missyou.api.v1
        String packageName = handlerType.getPackage().getName();
        String dotPath = packageName.replace(apiPackage, "");
        return dotPath.replaceAll("\\.", "/");
    }
}

missyou:
  api-package: com.lin.missyou.api