springboot 2.6.x 自定义注册 RequestMapping

最新推荐文章于 2024-10-07 15:52:42 发布

食得落

最新推荐文章于 2024-10-07 15:52:42 发布

阅读量4.4k

点赞数 4

分类专栏： spring boot 文章标签： spring boot mvc java

本文链接：https://blog.csdn.net/maple_son/article/details/122572869

版权

spring boot 专栏收录该内容

14 篇文章 1 订阅

订阅专栏

springboot 2.6.x 以上最近版本添加了pathPatternsCondition ,以往的手动注册方式会导致任意请求提示：

java.lang.IllegalArgumentException: 
Expected lookupPath in request attribute "org.springframework.web.util.UrlPathHelper.PATH".

如果你的程序中出来了这样的异常，也说明你的代码或你的依赖包中有自定义注册RequestMapping的逻辑，并且没有得到升级

在新的版本中使用以下方式来自定义注册Spring boot RequestMapping：

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Service;
import org.springframework.util.Assert;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.Map;

@Service
@Slf4j
public class TestRequestMappingService implements InitializingBean {

    @Autowired
    private RequestMappingHandlerMapping handlerMapping;

    private RequestMappingInfo.BuilderConfiguration config = new RequestMappingInfo.BuilderConfiguration();

    /**
     * 核心配置类，因为`RequestMappingHandlerMapping`中config属性未提供公共方法，所以需要自行构建
     * @throws Exception
     */
    @Override
    public void afterPropertiesSet() throws Exception {
        this.config.setTrailingSlashMatch(handlerMapping.useTrailingSlashMatch());
        this.config.setContentNegotiationManager(handlerMapping.getContentNegotiationManager());

        if (handlerMapping.getPatternParser() != null) {
            this.config.setPatternParser(handlerMapping.getPatternParser());
            Assert.isTrue(!handlerMapping.useSuffixPatternMatch() && !handlerMapping.useRegisteredSuffixPatternMatch(),
                    "Suffix pattern matching not supported with PathPatternParser.");
        }
        else {
            this.config.setSuffixPatternMatch(handlerMapping.useSuffixPatternMatch());
            this.config.setRegisteredSuffixPatternMatch(handlerMapping.useRegisteredSuffixPatternMatch());
            this.config.setPathMatcher(handlerMapping.getPathMatcher());
        }
    }

    @RequestMapping
    @ResponseBody
    public ResponseEntity execute(@PathVariable(required = false) Map<String, String> pathVar,
                                  @RequestParam(required = false) Map<String, Object> param,
                                  HttpServletRequest request, HttpServletResponse response) throws Throwable {
        //todo 业务执行逻辑
        return null;
    }

    /**
     * 注册
     * @param pattern
     * @param method
     */
    public void registerMapping(String pattern,String method) throws NoSuchMethodException {
        RequestMappingInfo mappingInfo = RequestMappingInfo.paths(pattern)
                .methods(RequestMethod.valueOf(method))
                .options(this.config)
                .build();
        Method targetMethod = TestRequestMappingService.class.getDeclaredMethod("execute", Map.class, Map.class, HttpServletRequest.class, HttpServletResponse.class);
        handlerMapping.registerMapping(mappingInfo, this, targetMethod);
    }

    /**
     * 取消注册mapping
     * @param pattern
     * @param method
     */
    public synchronized void cancelMapping(String pattern,String method) {
        RequestMappingInfo mappingInfo = RequestMappingInfo.paths(pattern)
                .methods(RequestMethod.valueOf(method))
                .options(this.config)
                .build();
        handlerMapping.unregisterMapping(mappingInfo);
    }
}