SpringBoot优雅接收前端请求参数的详细过程

更新时间：2023年06月26日 15:45:49 作者：新垣不结衣

这篇文章主要介绍了SpringBoot如何优雅接收前端请求参数，我们可以通过@RequestParm注解去绑定请求中的参数，将（查询参数或者form表单数据）绑定到controller的方法参数中，本文结合示例代码给大家讲解的非常详细,需要的朋友可以参考下

@RequestParm

我们可以通过@RequestParm注解去绑定请求中的参数，将（查询参数或者form表单数据）绑定到controller的方法参数中，通俗点说就是，我们可以在get请求和post请求中使用改注解，get请求中会从查询参数中获取参数，post请求会从form表单或者查询参数中获取参数

默认情况下，方法参数上使用该注解说明这个参数是必传的，但是我们可以通过required = false来设置是否必传，或者通过defaultValue设置默认值。
如果类型不是Sting类型的话，会自动进行转换
可以将参数类型声明为list，同一个参数名解析多个参数值

1.使用Get请求

    /**
     *GET http://localhost:8080/api/person/getPerson?id=1
     */
    @GetMapping("/getPerson")
    public String getPerson(@RequestParam(value = "id",required = false,defaultValue = "2") Integer id) {
        log.info("id:{}", id);
        return "";
    }

2.使用Post请求

    /**
     * POST http://localhost:8080/api/person/postPerson
     * Content-Type: application/x-www-form-urlencoded
     *
     * id=1
     */
    @PostMapping("/postPerson")
    public String postPerson(@RequestParam("id") String id) {
        log.info("id:{}", id);
        return "";
    }

3.使用Map接收

    /**
     *POST http://localhost:8080/api/person/postPersonMap
     * Content-Type: application/x-www-form-urlencoded
     *
     * id=1
     */
    @PostMapping("/postPersonMap")
    public String postPersonMap(@RequestParam HashMap<String,String> param) {
        log.info("param:{}",param.toString());
        return "";
    }

4.使用List接收

    /**
     *可以通过两种方式传递list
     * 第一种传递到param中：
     * POST http://localhost:8080/api/person/postPersonList?param=1,2,3,4
     *
     * 第二种传递到form表单中：
     * POST http://localhost:8080/api/person/postPersonList
     * Content-Type: application/x-www-form-urlencoded
     *
     * param=1,2,3,4,5
     */
    @PostMapping("/postPersonList")
    public String postPersonList(@RequestParam List<String> param) {
        log.info("param:{}",param);
        return "";
    }

5.什么都不加

如果不加的话，前端可以不传id。默认：get请求通过param传递，post请求通过form表单传递

    /**
     * GET http://localhost:8080/api/person/getPerson?id=1
     */
    @GetMapping("/getPersonById")
    public String getPersonById(Integer id) {
        log.info("id:{}", id);
        return "";
    }

@RequestBody

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的)；

如果参数未传的话，引用类型默认是null，基本类型为默认值

注：一个请求，只有一个RequestBody；一个请求，可以有多个RequestParam。

### test postPersonByJson
POST http://localhost:8080/api/person/postPersonByJson
Content-Type: application/json
{
  "id": 1,
  "name": "tom",
  "age": 12,
  "ADDRESS": "beijing"
}

默认json的key和属性名称必须要匹配的，并且大小写敏感

如果有别名的话可以使用@JsonAlias注解或者使用@JsonProperty注解如下：

    /**
     * 地址
     */
    @JsonAlias(value = {"ADDRESS"})
    private String adress;

    /**
     * 地址
     */
   @JsonProperty("ADDRESS")
    private String adress;

服务端接收如下：

    @PostMapping("/postPersonByJson")
    public Person postPersonByJson(@RequestBody Person person) {
        log.info("person:{}", person);
        return person;
    }

HttpEntity

HttpEntity 和@RequestBody使用相同，多了一个header

### test httpEntity
POST http://localhost:8080/api/person/accounts
Content-Type: application/json
{
  "id": 1,
  "name": "tom",
  "age": 12,
  "ADDRESS": "beijing"
}

    /**
     * HttpEntity 和@RequestBody使用相同，多了一个header
     *
     * @param entity
     */
    @PostMapping("/accounts")
    public void handle(HttpEntity<Person> entity) {
        log.info("请求头部为：{}，请求体为：{}", entity.getHeaders(), entity.getBody());
    }

@RequestHeader

@RequestHeader 主要用于接收前端header中的参数，可以获取指定的header属性，也可以通过Map统一接收请求头中的参数

### test header
GET http://localhost:8080/api/person/getPersonHeader
Accept-Encoding: deflate
Keep-Alive: 11
### test headerByMap
GET http://localhost:8080/api/person/getPersonHeaderByMap
Accept-Encoding: deflate
Keep-Alive: 11

    /**
     * 接收header参数
     */
    @GetMapping("/getPersonHeader")
    public void getPersonHeader(@RequestHeader("Accept-Encoding") String encoding,
                                @RequestHeader("Keep-Alive") long keepAlive) {
        log.info("Accept-Encoding:{},Keep-Alive:{}", encoding, keepAlive);
    }
    /**
     * map接收header参数
     * 使用map接收key值会变成小写
     */
    @GetMapping("/getPersonHeaderByMap")
    public void getPersonHeader(@RequestHeader Map<String, String> param) {
        param.forEach((key, value) -> {
            log.info("key:{},value:{}", key, value);
        });
        log.info("Accept-Encoding:{},Keep-Alive:{}", param.get("accept-encoding"), param.get("keep-alive"));
    }

@PathVariable

使用@PathVariable注解可以获取url中的参数，也可以使用正则表达式提取url中的多个变量

### test PathVariable
GET http://localhost:8080/api/person/1
### test PathVariable  regular expression
GET http://localhost:8080/api/person/express/spring-web-3.0.5.jar

    /**
     * 获取url中的参数
     */
    @GetMapping("/{id}")
    public void getPersonById(@PathVariable String id) {
        log.info("id:{}", id);
    }
    /**
     * 通过正则表达式获取url中name，version，ext等信息
     */
    @GetMapping("/express/{name:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{ext:\\.[a-z]+}")
    public void handle(@PathVariable String name, @PathVariable String version, @PathVariable String ext) {
        log.info("name：{},version:{},ext:{}", name, version, ext);
    }

@ModelAttribute

@ModelAttribute可以作用在方法上和方法参数上，

标记在方法的参数上，会将客户端传递过来的参数按名称注入到指定对象中

标记在方法上，会在每一个@RequestMapping标注的方法前执行。

###test modelAttribute
POST http://localhost:8080/api/person/postPersonByModel/123
Content-Type: application/x-www-form-urlencoded
name=tom&age=14&address=北京
###test getModelAttribute
GET http://localhost:8080/api/person/getPersonByModel/456?name=tom&age=14&address=北京

    @PostMapping("/postPersonByModel/{id}")
    public void postPersonByModel(@ModelAttribute Person person) {
        log.info("person:{}", person);
    }
    @GetMapping("/getPersonByModel/{id}")
    public void getPersonByModel(@ModelAttribute Person person) {
        log.info("person:{}", person);
    }

或者将@ModelAttribute注解放到方法上，如果有公共参数需要进行处理，可以使用@ModelAttribute进行前置操作例如：

### testModelAttribute
POST http://localhost:8080/api/person/testModelAttribute
Content-Type: application/x-www-form-urlencoded
token: 123
name=tom&age=14&address=北京

    @ModelAttribute
    public void userInfo(ModelMap modelMap, HttpServletRequest request) {
        log.info("执行modelAttribute方法");
        //模拟通过token获取userId的过程
        String id = request.getHeader("token").toString();
        modelMap.addAttribute("userId", id);
    }
    @PostMapping("/testModelAttribute")
    public void testModelAttribute(@ModelAttribute("userId") String userId, Person person) {
        log.info("userId:{}", userId);
    }

到此这篇关于SpringBoot如何优雅接收前端请求参数的文章就介绍到这了,更多相关SpringBoot接收前端请求参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

IDEA 2019.2.2配置Maven3.6.2打开Maven项目出现 Unable to import Maven
这篇文章主要介绍了IDEA 2019.2.2配置Maven3.6.2打开Maven项目出现 Unable to import Maven project的问题,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
Java-Java5.0注解全面解读
这篇文章主要介绍了Java-Java5.0注解全面解读，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
完美解决idea没有tomcat server选项的问题
这篇文章主要介绍了完美解决idea没有tomcat server选项的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-01-01
Java实战之敏感词过滤器
这篇文章主要介绍了Java实战之敏感词过滤器,文中有非常详细的代码示例,对正在学习java的小伙伴们有非常好的帮助,需要的朋友可以参考下
2021-04-04
SSH框架网上商城项目第17战之购物车基本功能
这篇文章主要为大家详细介绍了SSH框架网上商城项目第17战之购物车基本功能的实现过程，感兴趣的小伙伴们可以参考一下
2016-06-06
Java中Object类常用的12个方法(小结)
Java 中的 Object 方法在面试中是一个非常高频的点，本文主要介绍了Java中Object类常用的12个方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-12-12
SpringBoot3文件管理操作方法
这篇文章主要介绍了SpringBoot3文件管理,本文案例只围绕普通文件和Excel两种类型进行代码实现，包括工程搭建、上传下载操作，需要的朋友可以参考下
2023-08-08
详解Java实践之适配器模式
在计算机编程中，适配器模式（有时候也称包装样式或者包装）将一个类的接口适配成用户所期待的。一个适配允许通常因为接口不兼容而不能在一起工作的类工作在一起，做法是将类自己的接口包裹在一个已存在的类中
2021-06-06
Java超详细分析泛型与通配符
本篇文章带大家认识Java语法泛型与通配符，泛型和通配符是一个非常抽象的概念，简单来说，两者都可以将类型作为“参数”进行传递，不过泛型是在你知道传入什么类型的时候使用的，而通配符是你不确定传入什么类型的时候使用，本文将介绍泛型与通配符的使用及两者间的区别
2022-03-03
Java的字符串常量池StringTable详解
这篇文章主要介绍了Java的字符串常量池StringTable详解,JVM为了提高性能和减少内存开销,在实例化字符串常量的时候进行了一些优化,为了减少在JVM中创建的字符串的数量,字符串类维护了一个字符串池,需要的朋友可以参考下
2023-11-11