SpringBoot根据目录结构自动生成路由前缀的实现代码

程序员文章站 2022-03-28 23:34:22

目录前言本文介绍如何根据目录结构给requestmapping添加路由前缀（覆盖requestmappinghandlermapping中的getmappingformethod方法，修改其中的url...

前言

本文介绍如何根据目录结构给requestmapping添加路由前缀（覆盖requestmappinghandlermapping中的getmappingformethod方法，修改其中的url），如下图的实际访问路径为：/v1/test/test。

具体实现

配置文件指定基础包

application.properties

api-package = com.coisini.springbootlearn.controller

自动补全路由前缀处理类

autoprefixurlmapping.java

import org.springframework.beans.factory.annotation.value;
import org.springframework.web.servlet.mvc.method.requestmappinginfo;
import org.springframework.web.servlet.mvc.method.annotation.requestmappinghandlermapping;
import java.lang.reflect.method;
import java.util.objects;

/**
 * @description 自动补全路由前缀处理类
 *      requestmappinghandlermapping 负责处理标注了@requestmapping的控制器
 * @author coisini
 * @date aug 10, 2021
 * @version 1.0
 */
public class autoprefixurlmapping extends requestmappinghandlermapping {

    /**
     * 读取基础包配置
     */
    @value("${api-package}")
    private string bathapipackagepath;

    /**
     * 重写方法路由获取
     * @param method
     * @param handlertype
     * @return
     */
    @override
    protected requestmappinginfo getmappingformethod(method method, class<?> handlertype) {
        requestmappinginfo mappinginfo = super.getmappingformethod(method, handlertype);
        if (objects.nonnull(mappinginfo)) {
            string prefix = this.getprefix(handlertype);
            /**
             * requestmappinginfo.paths(prefix).build() 根据前缀生成mappinginfo
             * combine(mappinginfo) 拼接原来的mappinginfo
             */
            return requestmappinginfo.paths(prefix).build().combine(mappinginfo);
        }

        return mappinginfo;
    }

    /**
     * 获取方法路由前缀
     * @param handletype
     * @return
     */
    private string getprefix(class<?> handletype) {
        string packagename = handletype.getpackage().getname();
        string dotpath = packagename.replace(this.bathapipackagepath, "").replace(".","/");
        return dotpath;
    }

}

自动补全路由前缀配置类

autoprefixconfiguration.java

/**
 * @description 自动补全路由前缀配置类
 * 通过接口的形式主动发现
 * @author coisini
 * @date aug 10, 2021
 * @version 1.0
 */
@component
public class autoprefixconfiguration implements webmvcregistrations {
    @override
    public requestmappinghandlermapping getrequestmappinghandlermapping() {
        return new autoprefixurlmapping();
    }
}

测试类

@restcontroller
@requestmapping("/test")
public class testcontroller {

    @getmapping(value = "/test")
    public string test(){
        return "hello";
    }

}