SpringMVC控制器方法支持的参数类型

最新推荐文章于 2024-01-10 14:16:33 发布
最新推荐文章于 2024-01-10 14:16:33 发布
阅读量826 收藏 1
点赞数
文章标签： java spring springmvc
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_50105465/article/details/112130351
版权

控制器方法支持的参数类型
首先定义一个控制器，使用@RestController，根据方法返回值类型，返回字符串网页，或是 json 序列 化对象：
package org.example.demo.controller;
import org.springframework.web.bind.annotation.RequestMapping;
Import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/arg")
public class TestArgumentsController { }

该控制器中定义的请求映射方法
@PathVariable
@GetMapping("/owners/{ownerId}/pets/{petId}")
public String findPet(@PathVariable Long ownerId, @PathVariable Long petId) {
return “主人id：”+ownerId+", 宠物id："+petId;
}
说明：
 {}是将服务路径 URI 中的部分定义为变量，之后在方法参数中获取该路径变量。更多格式可参考 URI格式。
 请求 /arg/owners/1/pets/2 ，显示的网页内容为： 主人id：1, 宠物id：2 。
 变量已经定义了为Long长整形，所以不能转换为Long的 URI 都会报错，如请求 /arg/owners/abc/pets/2 就会报错，响应状态码400。
 变量名ownerId，petId必须和 URI 中的定义名称一致。

@RequestParam
请求数据要绑定到某个简单对象
 URL 中的请求数据queryString
 请求头，Content-Type为表单默认提交的格式 application/x-www-form-urlencoded ，请求体中 的数据
 请求头，Content-Type为 multipart/form-data ，请求体中的数据。 form-data 可以提交文本 数据，也可以提交二进制文件。
以上简单对象包括：基本数据类型、包装类型、MultipartFile（接收二进制文件）
注：@RequestParam注解参数默认为 required=true ，如果不传该参数就会报错，需要指定 为： @RequestParam(required = false)
示例一
通过 post 请求，请求数据的键分别为 username 和 password ，指定为queryString，或 Content-Type为表单数据类型， form-data 都可以
@PostMapping("/login")
public Object login(@RequestParam String username, @RequestParam String password){
log.debug(“获取到请求路径参数：username={}, password={}”, username, password);
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

示例二：通过 post 请求，请求数据的键为 count ，指定为非必须输入。
@PostMapping("/param2")
public Object param2(@RequestParam(required = false) Integer count){
Map map = new HashMap<>();
map.put(“count”, count);
return map;
}
注：
 注意以上代码使用包装类型 Integer ，如果使用 int ，不传入键为 count 的请求数据就会报错，因为 null 无法转换为 int。
 必填的请求数据可以使用基本数据类型，可以不传的参数，都要使用包装类型。
示例三：
通过 post 请求，使用 form-data 提交一个键为 file 的二进制文件，需要注意整个请求数据 大小不能超过10m，单个文件大小不超过1m。（这是 SpringBoot 的默认设置，修改需要通过 src/main/resources/application.properties 文件配置）
@PostMapping("/register")
public Object register(@RequestParam String username,
@RequestParam String password,
@RequestParam MultipartFile file) throws IOException {
log.debug(“获取到请求路径参数：username={}, password={}”, username, password);
log.debug(“头像信息，名称={}, 内容={}”, file.getOriginalFilename(),
new String(file.getBytes()));
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

POJO对象
POJO（Plain Ordinary Java Object）：简单的 java 对象，实际就是属性提供了Getter，Setter方法的 普通对象。 使用 java 对象和使用@RequestParam注解非常类似，只是有点细节不同：
 @RequestParam是以方法参数变量名和传入的键对应，POJO对象作为方法参数时，是以POJO对 象中的属性名对应传入的键
 @RequestParam默认必须传入该请求数据，而 POJO 对象是根据请求数据来填充属性，如果请求 数据没有，则属性就是默认值（new对象时每个属性的默认值）
示例一：简单的包装类型，和使用@RequestParam结果一样
@PostMapping("/login/pojo1")
public Object loginPojo1(String username, String password){
log.debug(“获取到请求路径参数：username={}, password={}”, username, password);
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}
示例二：使用自定义 POJO 类，通过SpringMVC框架自动解析请求数据并设置到对象中。
//springmvc自动实例化user对象，根据请求key获取值，注入到user对象的属性中
@PostMapping("/login/pojo2")
public Object loginPojo2(User user){
log.debug(“获取到请求路径参数：username={}, password={}”,
user.getUsername(), user.getPassword());
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}
示例三：POJO 对象同样可以直接获取 form-data 方式的数据，包括二进制文件
@PostMapping("/register/pojo")
public Object register(User user,
MultipartFile file) throws IOException {
log.debug(“获取到请求路径参数：username={}, password={}”,
user.getUsername(), user.getPassword());
log.debug(“头像信息，名称={}, 内容={}”, file.getOriginalFilename(),
new String(file.getBytes()));
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

@RequestBody
当请求的数据类型Content-Type为 application/json 时，需要显示的使用@RequestBody注解。
@PostMapping("/json")
public Object json(@RequestBody User user){
log.debug(“用户信息为：{}”, user);
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

@RequestPart
对于请求的数据类型Content-Type为 multipart/form-data 时，二进制文件除了以上 @RequestParam和 POJO 对象的方式外，还可以使用@RequestPart。
@PostMapping("/file")
public Object file(@RequestPart MultipartFile file) throws IOException {
log.debug(“头像信息，名称={}, 内容={}”, file.getOriginalFilename(),
new String(file.getBytes()));
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

Servlet API
在控制器方法参数中，可以使用Servlet相关API，SpringMVC会自动将相关Servlet对象装配到方法参数 中，如 HttpServletRequest 、 HttpServletResponse 、 HttpSession 等。

package org.example.controller;

import org.example.model.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

@RestController
@RequestMapping("/arg")
public class TestArgumentController {

private static final Logger log = LoggerFactory.getLogger(TestArgumentController.class);
@GetMapping("/holiday/{day}")
public Object holiday(@PathVariable String day){
    log.debug("获取到请求路径参数："+day);
    Map<String, Object> map = new HashMap<>();
    map.put("苟和章", true);
    return map;
}
@PostMapping("/login")
public Object login(@RequestParam String username, @RequestParam String password){
    log.debug("获取到请求路径参数：username={}, password={}", username, password);
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

@PostMapping("/login2")//完成代码及测试，Integer改为int，重新测试

// public Object login2(@RequestParam(required = false) Integer i){
public Object login2(@RequestParam(required = false) int i){
log.debug(“获取到请求路径参数：i=”+i);
Map<String, Object> map = new HashMap<>();
map.put(“ok”, true);
return map;
}

@PostMapping("/register")
public Object register(@RequestParam String username,
                       @RequestParam String password,
                       @RequestParam MultipartFile file) throws IOException {
    log.debug("获取到请求路径参数：username={}, password={}", username, password);
    log.debug("头像信息，名称={}, 内容={}", file.getOriginalFilename(),
            new String(file.getBytes()));
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

@PostMapping("/login/pojo1")
public Object loginPojo1(String username, String password){
    log.debug("获取到请求路径参数：username={}, password={}", username, password);
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

//springmvc自动实例化user对象，根据请求key获取值，注入到user对象的属性中
@PostMapping("/login/pojo2")
public Object loginPojo2(User user){
    log.debug("获取到请求路径参数：username={}, password={}",
            user.getUsername(), user.getPassword());
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

@PostMapping("/register/pojo")
public Object register(User user,
                       MultipartFile file) throws IOException {
    log.debug("获取到请求路径参数：username={}, password={}",
            user.getUsername(), user.getPassword());
    log.debug("头像信息，名称={}, 内容={}", file.getOriginalFilename(),
            new String(file.getBytes()));
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

@PostMapping("/json")
public Object json(@RequestBody User user){
    log.debug("用户信息为：{}", user);
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

@PostMapping("/file")
public Object file(@RequestPart MultipartFile file) throws IOException {
    log.debug("头像信息，名称={}, 内容={}", file.getOriginalFilename(),
            new String(file.getBytes()));
    Map<String, Object> map = new HashMap<>();
    map.put("ok", true);
    return map;
}

}

package org.example.model;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;

@Getter
@Setter
@ToString
public class User {
private String username;
private String password;
}

小艺小艺
关注
Spring Mvc支持的参数类型
weixin_47371330的博客
09-14 429
Spring Mvc支持的参数类型 Serlvet API的请求响应类型： ServletRequest or HttpServletRequest. ServletResponse HttpServletResponse [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-T1oio39S-1599541496204)(imges/image-20200908111527561.png)] Session object (Servlet API): of type Ht
Spring MVC中支持的参数类型和返回值类型
GuessHat的博客
09-11 576
Spring MVC中支持的参数类型和返回值类型 1.Spring MVC支持的参数类型 支持原始的Servlet和HttpServlet Session对象 @PathVariable注解修饰的参数，用于获取url模板变量 目的其实是返回没有进行变量修饰的参数，例如要拿到地址栏中最后的1： http://localhost:8080/rc/demo2/1 具体代码 @RequestMapping("/demo2/{a}") public String m2(@PathVariable(
SpringMVC支持的默认参数类型
最新发布
m0_58751118的博客
01-10 482
这些类型只要写在方法参数中就可以使用了。
Spring MVC控制器方法参数类型
weixin_30631587的博客
08-20 129
HttpServletRequest Spring会自动将 Servlet API 作为参数传过来 HttpServletResponse InputStream 相当于request.getInputStream() 获取请求区内容字节流 OutputStream 相当于request.getOutputStream() 获取响应区内容字...
SpringMVC（三）获取控制器参数
Sadlay的博客
11-13 460
SpringMVC获取控制器参数 在无注解下获取参数 在没有注解的情况下，SpringMVC也可以获取参数，且参数允许为空，唯一的要求是参数名称和HTTP请求的参数名称保持一致。 package com.lay.mvc.controller; import org.springframework.stereotype.Controller; import org.springframework....
Springmvc请求处理方法参数
05-17
在Spring MVC框架中，请求处理方法是控制器类中定义的方法，它们用于接收并处理来自客户端的HTTP请求。这些方法通常使用`@RequestMapping`注解来指定一个或多个URL映射，以便当用户发起匹配的HTTP请求时，Spring MVC...
SpringMVC的返回值和参数类型
wkh18891843165的博客
08-16 393
传统的基于Spring Framework的web开发需要大量的 xml 配置，在有SpringBoot以后，Web开发的效 率得到了很大的提升，几乎大部分配置可以使用默认约定的规则。我们基于SpringBoot的项目来进行 SpringMVC的学习 概述 SpringMVC框架围绕 DispatcherServlet（前端控制器） 这个核心展开， DispatcherServlet 是SpringMVC框架的总导演、总策划，它负责截获请求并将其分派给相应的处理器处理。 MVC设计模式介绍 MVC（Mo.
SpringMVC处理方法的其他参数类型：Locale与Principal
本文主要介绍了SpringMVC框架中的一些核心概念和特性，特别是关于控制器处理方法的参数类型，包括对`java.util.Locale`和`java.security.Principal`的支持。此外，还简要概述了SpringMVC 3.0的新特性以及框架的基本...
(代码)SpringMVC第4讲：参数传递类型
06-29
首先，Spring MVC支持的基本参数类型包括字符串、整型、浮点型等基本数据类型，以及它们的包装类。例如，通过在控制器方法的参数中声明`String name`，Spring MVC会自动将请求URL中的查询参数或表单数据映射到该参数...
springmvc可以接受的参数类型
播客的博客
09-02 493
复习一下springmvc可以接收的参数类型： 1. 默认的类型 request, response, session, model 在controller方法中看自己需不需要, 可以随意添加, 删掉 2. 简单的类型(string, double,integer,boolean等) 要求: 页面上input框的name属性值必须等于方法中接收的参数的变量名称 3. pojo类型: 要
深入理解Spring MVC－获取控制器参数
weixin_43404791的博客
04-21 366
在处理器运行的过程中会调度控制器的方法，只是他在进入控制器方法之前会对HTTP的参数和上下文进行解析，将他们转化为控制器所需要的参数。这一步是处理器首先需要做的事情,只是大部分情况下不需要自己去开发这一步，因为SpringMVC已经提供了大量的转换规则，通过这些规则就能够非常简易的获取大部分的参数。正如之前章节一样，大部分情况下，我们并不在意如何获取参数，那是因为之前的场景都比较简单，在实际的开发...
springmvc，5种类型参数传递
weixin_44239550的博客
01-04 196
两个需要注解的地方，一个是给参数定义别名的时候，定了别名是给前端用的。另一个是声明集合的时候。pojo类嵌套的时候被嵌套的需要写全，比如address.city。
Spring MVC(八)--控制器接受简单列表参数
weixin_30307921的博客
10-04 129
有些场景下需要向后台传递一个数组，比如批量删除传多个ID的情况，可以使用数组传递，数组中的ID元素为简单类型，即基本类型。 现在我的测试场景是：要从数据库中查询minId<id<maxId且id!=noId的数据，所以我需要向后台传递的参数有minId、maxId、noId，这三参数通过数组传递到后台，步骤如下： 1、创建页面 为了简单起见，在页面我只创建了一个按钮去触发查询这个...
springmvc处理器方法的参数
MrDAW的博客
08-19 466
springmvc处理器方法的参数 处理器方法可以包含以下四类参数，这些参数会在系统调用时由系统自动赋值.所以我们可以在方法内直 接使用。以下是这四类参数: HttpServletRequest HttpServletResponse HttpSession 请求中所携带的请求参数 准备工作：创建新的控制器ParamController.java和前端页面hello.jsp页面 package com.daw.controller; import com.daw.pojo.Team;
SpringMVC 中控制器方法的可用参数类型和返回类型
阿猫_ACat 的博客
06-26 1394
SpringMVC 中控制器方法的参数列表可接受以下类型的参数, 并当该方法被调用时, SpringMVC 框架可使得方法能够获得正确的参数: javax.servlet.ServletRequest 或 javax.servlet.http.HttpServletRequest; javax.servlet.ServletRequest 或 javax.servlet.http.HttpSer...
spring mvc中的控制器方法中的参数从哪里传进来？
a55684471的博客
11-21 344
编写控制器方法的时候很奇怪，spring是怎么知道你控制器方法的参数类型，并且注入正确的对象呢？ 比如下面这样 @RequestMapping(value="/register", method=GET) public String showRegistrationForm(Model model) { model.addAttribute(new Spitter...
Spring MVC控制器参数列表高级使用
不再更新，新博客 chgl16.space
12-01 269
支持参数列表同时映射HTTP参数为POJO和基本数据类型共存 如下 @RequestMapping(value = "/addBook", method = RequestMethod.POST) @ResponseBody public String addBook(@RequestParam("storeId") int storeId, Book book) throws IOExc...
Spring MVC控制器方法参数类型及对象
Jack_Hwa的博客
07-01 782
Spring MVC控制器方法参数类型及对象Spring MVC控制器方法参数类型及对象 Spring MVC控制器方法参数类型及对象 HttpServletRequest Spring会自动将 Servlet API 作为参数传过来 HttpServletResponse InputStream 相当于request.getInputStream() 获取请求区内容字节流 OutputStream 相当于request.getOutputStream() 获取响应区内容字节流 Reader request
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值