Springboot接收Get参数实践过程

 更新时间:2024年12月09日 16:19:35   作者:梅坞茶坊  
本文主要介绍了在Spring Boot中如何接收不同类型的请求参数,包括在路径中直接传递参数、跟在问号后面传递参数、使用Map接收参数、接收数组以及使用对象接收参数等方法

一、参数直接在路径中

1.假设请求地址是如下这种 RESTful 风格

hangge 这个参数值直接放在路径里面:

http://localhost:8080/helloworld/张三

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloWorldController {

    @GetMapping("/helloworld/{name}")
    public String helloworld(@PathVariable("name") String name) {
        return "获取到的name是:" + name;
    }


}

二、参数跟在 ? 号后面

1.获取参数的基本方法

(1)假设请求地址是如下这种传统方式,参数跟在问号后面:

http://localhost:8080/helloworld1?name=张三

(2)Controller 可以这么获取该参数:

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld1")
    public String helloworld1(@RequestParam("name") String name) {
        return "获取到的name是:" + name;
    }
}

2.参数没有传递的情况

(1)如果没有传递参数 Controller 将会报错,我们可以使用 required = false 标注参数是非必须的。

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld2")
    public String helloworld2(@RequestParam(name = "name", required = false) String name) {
        return "获取到的name是:" + name;
    }
}

(2)或者可以指定个默认值,当没有传递参数时自动使用默认值:

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld3")
    public String helloworld3(@RequestParam(name = "name", defaultValue = "xxx") String name) {
        return "获取到的name是:" + name;
    }
}

3.使用 map 来接收参数

(1)Controller 还可以直接使用 map 来接收所有的请求参数:

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
import java.util.Map;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld4")
    public String helloworld4(@RequestParam Map<String, Object> params) {
        return "name:" + params.get("name") + "<br>age:" + params.get("age");
    }
}

(2)下面是一个简单的测试样例:

4.接收一个数组

(1)假设请求地址是如下这种,有多个同名参数:

http://localhost:8080/helloworld5?name=zhangsan&name=lisi

(2)我们可以定义一个数组类型的参数来接收:

import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld5")
    public String helloworld5(@RequestParam("name") String[] names) {
        String result = "";
        for(String name:names){
            result += name + "<br>";
        }
        return result;
    }
}

附:使用对象来接收参数

1.基本用法

(1)如果一个 get 请求的参数太多,我们构造一个对象来简化参数的接收方式:

import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld6")
    public String helloworld6(User user) {
        return "name:" + user.getName() + "<br> age:" + user.getAge();
    }
}

(2)User 类的定义如下,到时可以直接将多个参数通过 getter、setter 方法注入到对象中去:

public class User {
    private String name;
    private Integer age;
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public Integer getAge() {
        return age;
    }
 
    public void setAge(Integer age) {
        this.age = age;
    }
}

(3)下面是一个简单的测试样例:

(4)如果传递的参数有前缀,且前缀与接收实体类的名称相同,那么参数也是可以正常传递的:

2.指定参数前缀

(1)如果传递的参数有前缀,且前缀与接收实体类的名称不同相,那么参数无法正常传递:

(2)我们可以结合 @InitBinder 解决这个问题,通过参数预处理来指定使用的前缀为 u.

除了在 Controller 里单独定义预处理方法外,我们还可以通过 @ControllerAdvice 结合 @InitBinder 来定义全局的参数预处理方法,方便各个 Controller 使用。具体做法参考我之前的文章:

  • SpringBoot - @ControllerAdvice的使用详解3(请求参数预处理 @InitBinder)
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.*;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld7")
    public String helloworld7(@ModelAttribute("u") User user) {
        return "name:" + user.getName() + "<br> age:" + user.getAge();
    }
 
    @InitBinder("u")
    private void initBinder(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("u.");
    }
}

(3)重启程序可以看到参数以及成功接收了:

3.构造多个对象来接收参数

(1)如果一个 get 请求的参数分属不同的对象,也可以使用多个对象来接收参数:

import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.GetMapping;
 
@RestController
public class HelloController {
    @GetMapping("/helloworld8")
    public String helloworld8(User user, Phone phone) {
        return "name:" + user.getName() + "<br> age:" + user.getAge()
                + "<br> number:" + phone.getNumber();
    }
}

(2)新增的 Phone 类定义如下:

public class Phone {
    private String number;
 
    public String getNumber() {
        return number;
    }
 
    public void setNumber(String number) {
        this.number = number;
    }
}

(3)下面是一个简单的测试样例:

总结

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

相关文章

  • java仿windows记事本功能完整版

    java仿windows记事本功能完整版

    这篇文章主要为大家详细介绍了java仿windows记事本功能完整版,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-03-03
  • SpringBoot同一个方法操作多个数据源保证事务一致性

    SpringBoot同一个方法操作多个数据源保证事务一致性

    本文探讨了在Spring Boot应用中,如何在同一个方法中操作多个数据源并保证事务的一致性,由于声明式事务的限制,直接使用@Transactional注解无法满足需求,文章介绍了解决方案:编程式事务,它允许在代码级别更灵活地管理事务,确保多数据源操作的事务一致性
    2024-11-11
  • MyBatis传入多个参数时parameterType的写法

    MyBatis传入多个参数时parameterType的写法

    这篇文章主要介绍了MyBatis传入多个参数时parameterType的写法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-12-12
  • Spring Boot整合Redis的完整步骤

    Spring Boot整合Redis的完整步骤

    这篇文章主要给大家介绍了关于Spring Boot整合Redis的完整步骤,文中通过示例代码介绍的非常详细,对大家学习或者使用Spring Boot具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-05-05
  • SpringBoot中处理跨域请求CORS的全面指南

    SpringBoot中处理跨域请求CORS的全面指南

    跨域资源共享是一种安全机制,它允许Web应用程序在一个域上的资源请求另一个域上的资源,下面就跟随小编一起来深入了解下SpringBoot中处理跨域请求CORS的具体操作吧
    2025-04-04
  • java实现6种字符串数组的排序(String array sort)

    java实现6种字符串数组的排序(String array sort)

    这篇文章主要介绍了java实现6种字符串数组的排序(String array sort),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • SpringBoot开发中的组件和容器详解

    SpringBoot开发中的组件和容器详解

    这篇文章主要介绍了SpringBoot开发中的组件和容器详解,SpringBoot 提供了一个内嵌的 Tomcat 容器作为默认的 Web 容器,同时还支持其他 Web 容器和应用服务器,需要的朋友可以参考下
    2023-09-09
  • 浅谈一下Java线程组ThreadGroup

    浅谈一下Java线程组ThreadGroup

    ThreadGroup是为了方便线程管理出现了,可以统一设定线程组的一些属性,比如setDaemon,设置未处理异常的处理方法,设置统一的安全策略等等,需要的朋友可以参考下
    2023-05-05
  • 超详细讲解Java秒杀项目用户验证模块的实现

    超详细讲解Java秒杀项目用户验证模块的实现

    这是一个主要使用java开发的秒杀系统,项目比较大,所以本篇只实现了用户验证模块,代码非常详尽,感兴趣的朋友快来看看
    2022-03-03
  • Java连接各种数据库的方法

    Java连接各种数据库的方法

    这篇文章主要介绍了Java连接各种数据库的方法,实例分析了java连接MySQL、SQL Server、Sysbase、Oracle、PostgreSQL及DB2等数据库的技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-02-02

最新评论