如何让Spring Rest 接口中路径参数可选

 更新时间:2021年10月30日 10:56:30   作者:孙亖  
这篇文章主要介绍了如何让Spring Rest 接口中路径参数可选,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

Spring Rest接口路径参数可选

我有一个 Spring Rest 服务,其中有一个路径参数是可选的(实际情况是我原来将参数放到路径中,而另外一个前端通过 body 传给我)。按照传统的方式是把这个服务在代码里面分成两个方法,一个带路径参数,一个不带,但是这样看起来不优雅,让人疑惑。

我试着给 @PathVariable 注解加上 require=false 注解,但是不起作用,返回404错误。

下面的形式就是传统方式:

@RequestMapping(value = "/path/{id}")
public String getResource(@PathVariable String id) {
  return service.processResource(id);
} 
@RequestMapping(value = "/path")
public String getResource() {
  return service.processResource();
}

但是我真的不喜欢这种方式,臃肿。

从 Spring 4 and Java 8 开始(其实和 Java 8 关系不大),在一个方法里面实现可选路径参数变得很简单,如下所示,就是同时定义两个路由:

@RequestMapping(value = {"/path", "/path/{id}")
public String getResource(@PathVariable Optional<String> id) {
  if (id.isPresent()) {
    return service.processResource(id.get());
  } else {
    return service.processResource();
  }
}

确实,在一个方法里面统一业务要优雅得多。

RestFul风格传参

RestFul风格就是所有参数都由/传递,而不是传统的?xx&xx形式

例如:写一个Controller:

package controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class RestfulController {
@RequestMapping("/add")
public String test(int a,int b, Model model){
int res = a+b;
model.addAttribute("msg","结果为"+res);
return "test";
}
}

可以看到出现a,b没找到的错误

在这里插入图片描述

按照传统方式传递参数:?a=1&b=2

在这里插入图片描述

那么按照Restful风格传递参数就应该:在方法参数值前加@PathVariable注解,并在url上直接绑定参数,可以同时设置Request的方法类型(GET、POST、DELETE、OPTIONS、HEAD、PATCH、PUT、TRACE)

@PathVariable:让方法参数的值对应绑定到一个url模板变量上

package controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class RestfulController {
@RequestMapping(value = "/add/{a}/{b}",method = RequestMethod.GET)
public String test(@PathVariable int a,@PathVariable int b, Model model){
int res = a+b;
model.addAttribute("msg","结果为"+res);
return "test";
}
}

再次开启Tomcat,并设定a=1,b=3:

/add/1/3传递参数

在这里插入图片描述

这就是restful风格传参

也可以通过变相的组合注解实现:

  • @PostMapping
  • @GetMapping
  • @PutMapping
  • @DeleteMapping
  • @PatchMapping

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

相关文章

  • Java精品项目瑞吉外卖之登陆的完善与退出功能篇

    Java精品项目瑞吉外卖之登陆的完善与退出功能篇

    这篇文章主要为大家详细介绍了java精品项目-瑞吉外卖订餐系统,此项目过大,分为多章独立讲解,本篇内容为新增菜品和分页查询功能的实现,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • Java适配器模式之如何灵活应对不匹配的接口

    Java适配器模式之如何灵活应对不匹配的接口

    本文介绍了Java中的适配器模式,包括对象适配器模式和接口适配器模式,适配器模式通过将一个类的接口转换成客户期望的另一个接口,解决了不同接口之间的不兼容问题,它提高了系统的灵活性、复用性和解耦性,需要的朋友可以参考下
    2024-10-10
  • Java集合和数组的区别

    Java集合和数组的区别

    本文主要介绍了Java集合和数组的区别。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • 关于web项目读取classpath下面文件的心得分享

    关于web项目读取classpath下面文件的心得分享

    这篇文章主要介绍了关于web项目读取classpath下面文件的心得,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • idea安装与配置及基本用法教程详解

    idea安装与配置及基本用法教程详解

    这篇文章主要介绍了idea安装与配置及基本用法教程详解,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-03-03
  • 一文搞明白Java Spring Boot分布式事务解决方案

    一文搞明白Java Spring Boot分布式事务解决方案

    这篇文章主要介绍了一文搞明白Java Spring Boot分布式事务解决方案,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-07-07
  • JUC系列学习工具类CountDownLatch详解

    JUC系列学习工具类CountDownLatch详解

    这篇文章主要介绍了JUC系列学习工具类CountDownLatch详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可任意参考一下
    2022-08-08
  • Java多线程Runable售票系统实现过程解析

    Java多线程Runable售票系统实现过程解析

    这篇文章主要介绍了Java多线程Runable售票系统实现过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-06-06
  • spring boot拦截器实现IP黑名单实例代码

    spring boot拦截器实现IP黑名单实例代码

    本篇文章主要介绍了spring boot拦截器实现IP黑名单实例代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • Java对接ansible自动运维化平台方式

    Java对接ansible自动运维化平台方式

    这篇文章主要介绍了Java对接ansible自动运维化平台方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04

最新评论