@PathVariable注解的使用及源码解析

前言

@PathVariable 注解是我们进行JavaEE开发，最常见的几个注解之一，这篇博文我们以案例和源码相结合，帮助大家更好的了解@PathVariable 注解

使用案例

1.获取 URL 上的值

@RequestMapping("/id/{id}")
public Object getId(@PathVariable(value = "id") Integer id) {
    return id;
}

2.获取 URL 上的多个值

多个值以 / 分割，可以相邻也可以不相邻

2.1 多个值相邻
@GetMapping("/info/{id}/{name}")
public Object getInfo(@PathVariable(value = "id") Integer id, @PathVariable(value = "name") String name) {
    return "id:" + id + ",name:" + name;
}

2.1 多个值不相邻
@GetMapping("/info/{id}/delimiter/{name}")
public Object getDelimiterInfo(@PathVariable(value = "id") Integer id, @PathVariable(value = "name") String name) {
    return "id:" + id + ",name:" + name;
}

3. 不指定value（name）

@RequestMapping("/default/{id}")
public Object getDefaultId(@PathVariable Integer id) {
    return id;
}

4. 使用 Map 接受多个 URL 上的值

@GetMapping("/info_map/{id}/{name}")
public Object getInfoToMap(@PathVariable Map<String, Object> map) {
    StringBuilder sb = new StringBuilder();
    map.forEach((key, value) -> sb.append(key).append(":").append(value).append(","));
    return sb.substring(0, sb.length() - 1);
}

源码解析

 InvocableHandlerMethod#getMethodArgumentValues

参数的处理分为两个阶段：

  1. 判断当前环境中存在的resolvers，是否支持解析当前参数
  2. 处理参数

判断是否支持解析当前参数

我的环境中存在27个resolvers，通过命名我们大概可以猜测出 PathVariableMethodArgumentResolver、PathVariableMapMethodArgumentResolver 是处理 @PathVariable 注解的 resolver 

PathVariableMethodArgumentResolver#supportsParameter
@Override
public boolean supportsParameter(MethodParameter parameter) {
    if (!parameter.hasParameterAnnotation(PathVariable.class)) {
        return false;
    }
    if (Map.class.isAssignableFrom(parameter.nestedIfOptional().getNestedParameterType())) {
        PathVariable pathVariable = parameter.getParameterAnnotation(PathVariable.class);
        return (pathVariable != null && StringUtils.hasText(pathVariable.value()));
    }
    return true;
}

如果参数存在 @PathVariable 注解，并且指定了 value（name），则支持解析

PathVariableMapMethodArgumentResolver#supportsParameter
@Override
public boolean supportsParameter(MethodParameter parameter) {
    PathVariable ann = parameter.getParameterAnnotation(PathVariable.class);
    return (ann != null && Map.class.isAssignableFrom(parameter.getParameterType()) &&
            !StringUtils.hasText(ann.value()));
}

如果参数存在 @PathVariable 注解，并且未指定了 value（name），则支持解析

处理参数

接来下我们将重点分析 PathVariableMethodArgumentResolver 的 resolveArgument 方法，PathVariableMapMethodArgumentResolver 的 resolveArgument 方法大家可以自行阅读，相关源码如下：

大概分为以下五个步骤:

  1. 构建NamedValueInfo对象
  2. 处理Spel表达式
  3. 解析参数
  4. 处理默认值
  5. 类型转换
  6. 给 Request 域赋值
构建NamedValueInfo对象

创建NamedValueInfo对象

@PathVariable 注解的默认值是 ValueConstants.DEFAULT_NONE，并且无法手动设置

更新NamedValueInfo对象

updateNamedValueInfo 方法主要针对 @PathVariable 注解未指定 value（name）的情况，比如上文中的案例3，NamedValueInfo对象的 name 属性值为方法的参数名

处理Spel表达式

默认情况下，@PathVariable 注解是不支持解析 Spel 表达式的，我们通过源码分析一下。

如果 resolver 的 configurableBeanFactory 或 expressionContext 属性为 null ，则不进行Spel表达式的解析工作

RequestMappingHandlerAdapter#getDefaultArgumentResolvers

默认注册 PathVariableMethodArgumentResolver 使用的是无参构造方法，也就是  configurableBeanFactory 和 expressionContext 属性为 null，所以默认情况下，@PathVariable 注解不支持解析Spel表达式。可能有的小伙伴说我可以利用 WebMvcConfigurer ，自定义一个resolver，这里存在一个优先级问题，自定义的 resolver 优先级低于 mvc 手动注册的 resolver，所以一般情况下 @PathVariable 注解都不支持解析Spel表达式

我们可以看到手动注册的 resolver 优先级很低，一般情况下都是利用 mvc 内置的 resolver 进行解析

如何让 @PathVariable 注解支持解析 Spel 表达式 ?
替换内置的 PathVariableMapMethodArgumentResolver
@SpringBootApplication
@PropertySource("classpath:keys.properties")
public class BootApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BootApplication.class);

        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();

        RequestMappingHandlerAdapter adapter = context.getBean(RequestMappingHandlerAdapter.class);

        List<HandlerMethodArgumentResolver> resolvers = adapter.getArgumentResolvers();
        if (!CollectionUtils.isEmpty(resolvers)) {
            try {
                List<HandlerMethodArgumentResolver> newResolvers = new ArrayList<>();

                for (HandlerMethodArgumentResolver resolver : resolvers) {

                    if (resolver instanceof PathVariableMethodArgumentResolver) {
                        PathVariableMethodArgumentResolver pathVariableMethodArgumentResolver = new PathVariableMethodArgumentResolver();

                        Field factoryField = AbstractNamedValueMethodArgumentResolver.class.getDeclaredField("configurableBeanFactory");
                        factoryField.setAccessible(true);
                        factoryField.set(pathVariableMethodArgumentResolver, beanFactory);

                        Field expressionField = AbstractNamedValueMethodArgumentResolver.class.getDeclaredField("expressionContext");
                        expressionField.setAccessible(true);
                        expressionField.set(pathVariableMethodArgumentResolver, new BeanExpressionContext(beanFactory, new RequestScope()));

                        newResolvers.add(pathVariableMethodArgumentResolver);
                    } else {
                        newResolvers.add(resolver);
                    }
                }

                adapter.setArgumentResolvers(Collections.unmodifiableList(newResolvers));

            } catch (Exception ignore) {
            }
        }
    }
}

这里我们引用了一个 keys.properties 文件，为下文中演示解析Spel表达式做准备，文件明细如下

key=a
解析 ${}
@RequestMapping("/spel_1/{a}/{b}")
public Object spel1(@PathVariable(value = "${key}") String key) {
    return key;
}

解析 #{}

创建 RequestKey

@Component
public class RequestKey {

    private String key = "b";

    public String getKey() {
        return key;
    }

    public void setKey(String key) {
        this.key = key;
    }
}

接口及响应

@RequestMapping("/spel_2/{a}/{b}")
public Object spel2(@PathVariable(value = "#{requestKey['key']}") String key) {
    return key;
}

参数解析

主要就是获取 URL 上的值

处理默认值

@PathVariable 注解不支持设置默认值，源码这里又处理默认值，感觉有点突兀。其实这里使用了模板模式，@RequestParam 注解的处理步骤是和 @PathVariable 注解一致的，然而 @RequestParam 注解是可以设置默认值的。我的上一篇博文写了@RequestParam 注解的使用和源码解析，有兴趣的小伙伴可以阅读一下，它们的处理流程基本是一致的，就是细节有差别。博文链接 ： @RequestParam注解的使用及源码解析

类型转换

SpringBoot 会提前内置很多 convert，当存在一个 convert 可以将当前类型转换为目标类型，则会进行转换。案例演示：

创建实体类 Dog

public class Dog {

    private String name;

    public Dog(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                '}';
    }
}

创建配置类 WebConfig

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new Converter<String, Dog>() {
            @Override
            public <U> Converter<String, U> andThen(Converter<? super Dog, ? extends U> after) {
                return Converter.super.andThen(after);
            }

            @Override
            public Dog convert(String source) {
                return new Dog(source);
            }
        });
    }

}

接口及响应

@GetMapping("/convert/{dog}")
public String getDog(@PathVariable(value = "dog") Dog dog) {
    return dog.toString();
}

给 Request 域赋值

案例演示
@GetMapping("/attribute/{id}")
public String getAttribute(@PathVariable(value = "id") Integer id, HttpServletRequest request) {
    return request.getAttribute(View.PATH_VARIABLES).toString();
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/748628.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Kubernetes Artemis系列 | 使用 ArtemisCloud Operator 部署 artemis

Kubernetes Artemis系列 | 使用 ArtemisCloud Operator 部署 artemis

目录 一、ArtemisCloud Operator 介绍二、部署ArtemisCloud Operator三、使用 ArtemisCloud Operator 部署 artemis四、管理队列五、缩减规模时消息迁移 一、ArtemisCloud Operator 介绍 ArtemisCloud Operator 是一个用于管理和部署云端基础设施的工具。它基于 Kubernetes 平…
阅读更多...
精益软件开发：从理念到实践

精益软件开发：从理念到实践

目录 前言1. 精益软件开发的起源与背景1.1 精益制造的起源1.2 精益思想在软件开发中的应用 2. 精益软件开发的核心原则2.1 消除浪费2.2 强调学习和持续改进2.3 快速交付2.4 尊重团队成员 3. 实施精益软件开发的方法3.1 精简流程3.2 持续反馈和迭代3.3 持续集成和持续交付3.4 建…
阅读更多...
Vue 学习之 axios

Vue 学习之 axios

目录 执行安装命令&#xff1a;npm install axios 使用的时候导入 axios以data&#xff0c;params&#xff0c;headers传参方式的区别 axios封装 是一个基于 promise 的 网络请求库&#xff0c;作用于浏览器和 node.js 中。使用Axios可以在前端项目中发送各种方式的HTTP请求…
阅读更多...
chromium源码魔改思路

chromium源码魔改思路

1.首先确定需要要改动的JS的API 比如要改动navigator.webdriver false 2.在官网查找JS的API https://developer.mozilla.org/zh-CN/docs/Web/Guide 3.在chromium源码官网查找源码 https://source.chromium.org/chromium/chromium/src 直接修改webdriver()返回值即可 4.然后…
阅读更多...
idea常用配置 | 快捷注释

idea常用配置 | 快捷注释

idea快速注释 一、类上快速注释 &#xff08;本方法是IDEA环境自带的&#xff0c;设置特别方便简单易使用&#xff09; 1、偏好设置->编辑器->文件和代码模版 | File-Settings-Editor-File and Code Templates 2、右下方的“描述”中有相对应的自动注注释配置格式 贴…
阅读更多...
Actor-agnostic Multi-label Action Recognition with Multi-modal Query

Actor-agnostic Multi-label Action Recognition with Multi-modal Query

标题&#xff1a;基于多模态查询的非特定行为者多标签动作识别 源文链接&#xff1a;https://openaccess.thecvf.com/content/ICCV2023W/NIVT/papers/Mondal_Actor-Agnostic_Multi-Label_Action_Recognition_with_Multi-Modal_Query_ICCVW_2023_paper.pdfhttps://openaccess.t…
阅读更多...
Java研学-Shiro安全框架(二)

Java研学-Shiro安全框架(二)

四 Shiro 鉴权 1 介绍 授权功能&#xff1a;就是为用户分配相关的权限的过程&#xff1b;鉴权功能&#xff1a;判断当前访问用户是否有某个资源的访问权限的过程。我们的权限管理系统是基于角色的权限管理&#xff0c;所以在系统中应该需要下面三个子模块&#xff1a;用户管理…
阅读更多...
Theta方法：一种时间序列分解与预测的简化方法

Theta方法：一种时间序列分解与预测的简化方法

Theta方法整合了两个基本概念:分解时间序列和利用基本预测技术来估计未来的价值。 每个数据科学爱好者都知道&#xff0c;时间序列是按一定时间间隔收集或记录的一系列数据点。例如&#xff0c;每日温度或经济指标的月值。把时间序列想象成不同成分的组合&#xff0c;趋势(数据…
阅读更多...
观测云产品更新 | Pipelines、智能监控、日志数据访问等

观测云产品更新 | Pipelines、智能监控、日志数据访问等

观测云更新 Pipelines 1、Pipelines&#xff1a;支持选择中心 Pipeline 执行脚本。 2、付费计划与账单&#xff1a;新增中心 Pipeline 计费项&#xff0c;统计所有命中中心 Pipeline 处理的原始日志的数据大小。 监控 1、通知对象管理&#xff1a;新增权限控制。配置操作权…
阅读更多...
PCL 使用列文伯格-马夸尔特法计算变换矩阵

PCL 使用列文伯格-马夸尔特法计算变换矩阵

目录 一、算法原理1、计算过程2、主要函数3、参考文献二、代码实现三、结果展示本文由CSDN点云侠原创，原文链接。如果你不是在点云侠的博客中看到该文章，那么此处便是不要脸的爬虫与GPT。 一、算法原理 1、计算过程 2、主要函数 void pcl
阅读更多...
民用无人驾驶航空器运营合格证怎么申请

民用无人驾驶航空器运营合格证怎么申请

随着科技的飞速发展&#xff0c;无人机已经从遥不可及的高科技产品飞入了寻常百姓家。越来越多的人想要亲自操纵无人机&#xff0c;探索更广阔的天空。但是&#xff0c;飞行无人机可不是简单的事情&#xff0c;你需要先获得无人机许可证&#xff0c;也就是今天所要讲的叫民用无…
阅读更多...
免费可视化工具为何成为数据分析新宠？

免费可视化工具为何成为数据分析新宠？

免费可视化工具为何越来越受欢迎&#xff1f;在当今数据驱动的时代&#xff0c;数据分析和展示已成为各行各业不可或缺的核心能力。然而&#xff0c;传统的数据处理和可视化工具往往价格昂贵&#xff0c;且使用门槛较高&#xff0c;这为许多中小企业和个人用户带来了不小的困扰…
阅读更多...
微信浏览器自动从http跳转到https的坑

微信浏览器自动从http跳转到https的坑

只要访问过同地址的https地址&#xff0c;就只能一直https了&#xff0c;无法再用https访问了&#xff0c;只能全站加上https才行。
阅读更多...
电脑怎么设置锁屏密码？这3个方法你知道吗

电脑怎么设置锁屏密码？这3个方法你知道吗

在日常生活中&#xff0c;电脑已成为我们工作和娱乐的重要工具。为了保护个人信息和数据安全&#xff0c;设置锁屏密码是必不可少的一步。通过设置锁屏密码&#xff0c;您可以有效防止未经授权的访问&#xff0c;确保电脑上的隐私和数据不被泄露。本文将详细介绍电脑怎么设置锁…
阅读更多...
【CSS in Depth 2 精译】1.5 渐进式增强

【CSS in Depth 2 精译】1.5 渐进式增强

文章目录 1.5 渐进式增强1.5.1 利用层叠规则实现渐进式增强1.5.2 渐进式增强的选择器1.5.3 利用 supports() 实现特性查询启用浏览器实验特性 1.5 渐进式增强 要用好 CSS 这样一门不断发展演进中的语言&#xff0c;其中一个重要的因素就是要与时俱进&#xff0c;及时了解哪些功…
阅读更多...
使用Python进行大数据处理Dask与Apache Spark的对比

使用Python进行大数据处理Dask与Apache Spark的对比

&#x1f47d;发现宝藏 前些天发现了一个巨牛的人工智能学习网站&#xff0c;通俗易懂&#xff0c;风趣幽默&#xff0c;忍不住分享一下给大家。【点击进入巨牛的人工智能学习网站】。 使用Python进行大数据处理Dask与Apache Spark的对比 随着数据量的增加和数据处理需求的增长…
阅读更多...
旅游管理系统源码小程序

旅游管理系统源码小程序

便捷旅行&#xff0c;尽在掌握 旅游管理系统是一款基于FastAdminElementUNIAPP开发的多端&#xff08;微信小程序、公众号、H5&#xff09;旅游管理系统&#xff0c;拥有丰富的装修组件、多端分享、模板消息、电子合同、旅游攻略、旅游线路及相关保险预订等功能&#xff0c;提…
阅读更多...
[leetcode]avoid-flood-in-the-city 避免洪水泛滥

[leetcode]avoid-flood-in-the-city 避免洪水泛滥

. - 力扣&#xff08;LeetCode&#xff09; class Solution { public:vector<int> avoidFlood(vector<int>& rains) {vector<int> ans(rains.size(), 1);set<int> st;unordered_map<int, int> mp;for (int i 0; i < rains.size(); i) {i…
阅读更多...
Redis实战—基于setnx的分布式锁与Redisson

Redis实战—基于setnx的分布式锁与Redisson

本博客为个人学习笔记&#xff0c;学习网站与详细见&#xff1a;黑马程序员Redis入门到实战 P56 - P63 目录 分布式锁介绍 基于SETNX的分布式锁 SETNX锁代码实现 修改业务代码 SETNX锁误删问题 SETNX锁原子性问题 Lua脚本 编写脚本 代码优化 总结 Redisson 前言…
阅读更多...
Hadoop简单应用程序实例

Hadoop简单应用程序实例

Hadoop是一个分布式系统基础架构&#xff0c;主要用于大数据的存储和处理。它允许使用简单的编程模型跨集群处理和生成大数据集。Hadoop主要由HDFS&#xff08;Hadoop Distributed FileSystem&#xff0c;分布式文件系统&#xff09;和MapReduce编程模型两部分组成。 准备工作…
阅读更多...
最新文章

Copyright @ 2022~2023