纯净、安全、绿色的下载网站

首页|软件分类|下载排行|最新软件|IT学院

当前位置:首页IT学院IT技术

根据目录结构自动配置Url前缀 SpringBoot根据目录结构自动配置Url前缀方式

三毛村滴雪鱼粉   2021-11-19 我要评论
想了解SpringBoot根据目录结构自动配置Url前缀方式的相关内容吗,三毛村滴雪鱼粉在本文为您仔细讲解根据目录结构自动配置Url前缀的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:SpringBoot目录结构,配置Url前缀,下面大家一起来学习吧。

在很多其他框架中,比如Python的Flask、node.js的KOA,Controller要想能够响应前端的请求都需要我们主动去注册到应用程序上。而Spring不需要我们自己去注册,由Spring通过扫描注解的方式去主动发现

自定义RequestMappingInfo

Spring中的RequestMappingHandlerMapping专门来负责处理标注了@RequestMapping的控制器。创建一个类继承并覆盖其中的方法,从而实现对默认机制的修改。

覆盖其中的getMappingForMethod方法,这个方法的返回值RequestMappingInfo就包含了请求的Url,修改RequestMappingInfo中的Url从而修改路由中的Url。

package com.lin.missyou.hack;
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;
public class AutoPrefixUrlMapping extends RequestMappingHandlerMapping {
    @Value("${missyou.api-package}")
    private String apiPackagePath ;		//从配置文件中获取根包的路径
    @Override
    protected RequestMappingInfo getMappingForMethod(Method method, Class<?> handlerType) {
        RequestMappingInfo requestMappingInfo = super.getMappingForMethod(method, handlerType);
        if(null != requestMappingInfo){
        	//获取url前缀
            String prefix = getPrefix(handlerType);		
            //根据url前缀生成RequestMappingInfo并与原有的RequestMappingInfo合并
            RequestMappingInfo mappingInfo = RequestMappingInfo.paths(prefix).build().combine(requestMappingInfo);		
            return mappingInfo;
        }
        return requestMappingInfo;
    }
    private String getPrefix(Class<?> handlerType){
        String packageName = handlerType.getPackage().getName();	//获取控制器所在包路径
        String dotPath = packageName.replaceAll(this.apiPackagePath,"");	//将包路径中多于的部分截取掉
        return dotPath.replace(".","/");		//将包路径中的.替换成/
    }
}

通过接口的形式发现类

创建一个配置类AutoPrefixConfiguration将AutoPrefixUrlMapping加入到容器。配置类AutoPrefixConfiguration实现接口WebMvcRegistrations并覆盖其中的getRequestMappingHandlerMapping方法

package com.lin.missyou.core.config;
import com.lin.missyou.hack.AutoPrefixUrlMapping;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
@Component
public class AutoPrefixConfiguration implements WebMvcRegistrations {
    @Override
    public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
        return new AutoPrefixUrlMapping();
    }
}

在配置文件中指定根包

missyou.api-package = com.lin.missyou.api

SprinBoot的 发现机制 有两种。一种是在控制器上标注特定注解,例如上一篇博文 SpringBoot全局异常处理中在GlobalExceptionAdvice 上标注@ControllerAdvice。另外一种是实现特定接口并覆盖其中的特定方法,例如上面的AutoPrefixConfiguration。

测试一下

在这里插入图片描述

访问结果,访问路径/v1/banner/test可以访问到该控制器

在这里插入图片描述

将访问路径改为/banner/test就访问不到了

在这里插入图片描述

将BannerController移动到sample文件夹下访问路径/v1/sample/banner/test可以访问到该控制器

在这里插入图片描述

这个方法存在一些争议。一方面认为根据目录结构自动生成url虽然比较简单,少写了一些代码,但是无法通过控制器上标注的@RequestMapping中的参数直接看出url,代码的可读性不是太好。

另一方面认为,这个方法大大的简化了我们代码的编写,同时更加易于维护,控制器随意调整所在目录都不需要去修改代码。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。


相关文章

猜您喜欢

  • C++ 中国象棋 C++ 中国象棋的实现流程详解

    想了解C++ 中国象棋的实现流程详解的相关内容吗,MAX在码字在本文为您仔细讲解C++ 中国象棋的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:C++,中国象棋,C++,象棋,下面大家一起来学习吧。..
  • RedisTemplat分布式锁 聊聊使用RedisTemplat实现简单的分布式锁的问题

    想了解聊聊使用RedisTemplat实现简单的分布式锁的问题的相关内容吗,郝瑞杰在本文为您仔细讲解RedisTemplat分布式锁的相关知识和一些Code实例,欢迎阅读和指正,我们先划重点:RedisTemplat分布式锁,Redis分布式锁,下面大家一起来学习吧。..

网友评论

Copyright 2020 www.mwhsoft.com 【绿色软件站】 版权所有 软件发布

声明:所有软件和文章来自软件开发商或者作者 如有异议 请与本站联系 点此查看联系方式