【SpringBoot】获取参数

获取参数

• 传递单个参数
• 传递多个参数
• 传递对象
• 后端参数重命名
• 传递数组
• [传递 json 数据](#传递 json 数据)
• [获取 URL 中参数](#获取 URL 中参数)
• 上传文件
• [获取 cookie 和 session](#获取 cookie 和 session)
• • 获取cookie
  • 获取session

传递单个参数

@RequestMapping("/user")
@RestController
public class UserController {

    // 传递单个参数
    @RequestMapping("/r1")
    public String r1(String name) {
        return "name: " + name;
    }
}

运行结果：

传递多个参数

@RequestMapping("/user")
@RestController
public class UserController {

    // 传递多个参数
    @RequestMapping("/r2")
    // 对于参数可能为空的数据，建议使用包装类
    public String r2(String name, Integer age) {
        return "name: " + name + ", age: " + age;
    }
}

传递对象

首先 定义一个 UserInfo 类：

public class UserInfo {
    int id;
    String name;
    int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "UserInfo{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

@RequestMapping("/user")
@RestController
public class UserController {

    // 传递多个参数
    @RequestMapping("/r3")
    public String r3(UserInfo userInfo) {
        return userInfo.toString();
    }
}

后端参数重命名

若前端传递参数使用 name，而后端使用 username 接收，这就会出现接收不到参数的情况：

此时，我们可以使用 @RequestParam 来重命名前后端的参数值：

如果没有传递参数则会报错：

但在实际应用中，可能不需要传递这个参数，但又要不报错，则可以使用如下方式使参数为非必传：

传递数组

传递 json 数据

@RequestMapping("/user")
@RestController
public class UserController {

    // 传递 json数据
    @RequestMapping("/r8")
    // @RequestBody 用于将请求中的数据（如json、xml等格式）转换成 java 对象，并完成数据绑定
    public String r8(@RequestBody UserInfo userInfo) {
        return userInfo.toString();
    }
}

这里使用的工具是 postman：

获取 URL 中参数

上传文件

    // 上传文件
    @RequestMapping("/r7")
    public String r7(MultipartFile file) throws IOException {
        // 获取文件名称
        String fileName = file.getOriginalFilename();
        // 文件上传到指定路径
        file.transferTo(new File("F:/Desktop/tmp/" + fileName));
        return "文件名称：" + fileName;
    }

若报错文件过大，则可到配置文件中作如下修改：

获取 cookie 和 session

简单地说，cookie 和 session 都是用来保存用户登录的会话信息，避免后续操作还要用户登录，而 cookie 是客户端（浏览器）的保存机制，session 则是服务器端的保存机制。

获取cookie

传统方式获取：

@RestController
@RequestMapping("/request")
public class RequestController {

    @RequestMapping("/getCookie")
    public String getCookie(HttpServletRequest request) {
        for (Cookie cookie : request.getCookies()) {
            System.out.println(cookie.getName() + ": " + cookie.getValue());
        }
        return "获取cookie成功";
    }
}

使用注解方式获取 cookie：

@RequestMapping("/getCookie2")
// 获取所有cookie中名为name的cookie
public String getCookie2(@CookieValue("name") String name) {
    return name;
}

获取session

先手动设置 session：

@RequestMapping("setSession")
public String setSession(HttpServletRequest request) {
    HttpSession session = request.getSession();
    session.setAttribute("username", "zhangsan");
    return "session设置成功";
}

传统方式获取 session：

@RequestMapping("getSession")
public String getSession(HttpServletRequest request) {
    HttpSession session = request.getSession();
    String username = (String) session.getAttribute("username");
    return "username:  " + username;
}

使用注解方式获取 session：

    @RequestMapping("getSession2")
    public String getSession2(@SessionAttribute("username") String name) {
        return "name:" + name;
    }