SpringMVC-REST风格简介及RESTful入门案例

目录

一、REST简介

二、RESTful入门案例

三、@RequestBody、@RequestParam、@PathVariable的区别与应用

---

一、REST简介

REST简介（Representational State Transfer），表现形式状态转换

传统风格资源描述形式

http://localhost/user/getById?id=1

http://localhost/user/saveUser

REST风格描述形式

http://localhost/user/1

http://localhost/user

优点：

1、隐藏资源的访问行为，无法通过地址得知对资源是何种操作

2、书写简化 

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作

http://localhost/users           查询全部用户信息 GET(查询)

http://localhost/users/1        查询指定用户信息 GET(查询)

http://localhost/users           添加用户信息        POST(新增/保存)

http://localhost/users           修改用户信息        PUT(修改/更新)

http://localhost/users/1        删除用户信息        DELETE(删除)

注意事项：

上述行为是约定方式，约定不是规范，可以打破，所以称为REST风格，而不是REST规范

描述模块名称通常使用负数，也就是加s的格式描述，表示此类资源，而非单个资源，例如：users、books、accounts......

二、RESTful入门案例

import com.itheima.domain.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
public class UserController {

    //设置当前请求方法为POST，表示REST风格中的添加操作
    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(){
        System.out.println("user save...");
        return "{'module':'user save'}";
    }

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

    //设置当前请求方法为PUT，表示REST风格中的修改操作
    @RequestMapping(value = "/users",method = RequestMethod.PUT)
    @ResponseBody
    public String update(@RequestBody User user){
        System.out.println("user update..."+user);
        return "{'module':'user update'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
    @ResponseBody
    public String getById(@PathVariable Integer id){
        System.out.println("user getById..."+id);
        return "{'module':'user getById'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    @RequestMapping(value = "/users",method = RequestMethod.GET)
    @ResponseBody
    public String getAll(){
        System.out.println("user getAll...");
        return "{'module':'user getAll'}";
    }

}

在postman修改相应的请求方式，对应相应的操作。

1、设定http请求动作（动词）

    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(){
        System.out.println("user save...");
        return "{'module':'user save'}";
    }

    @RequestMapping(value = "/users",method = RequestMethod.PUT)
    @ResponseBody
    public String update(@RequestBody User user){
        System.out.println("user update..."+user);
        return "{'module':'user update'}";
    }

2、设定请求参数（路径变量）

    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

名称：@RequestMapping

类型：方法注解

位置：SpringMVC控制器方法定义上方

作用：设置当前控制器方法请求访问路径

范例：

    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(){
        System.out.println("user save...");
        return "{'module':'user save'}";
    }

属性

value(默认)：请求访问路径

method：http请求动作，标准动作（GET/POST/PUT/DELETE）

名称：@PathVariable

类型：形参注解

位置：SpringMVC控制器方法形参定义前面

作用：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一 一对应

范例：

    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

三、@RequestBody、@RequestParam、@PathVariable的区别与应用

区别：

■ @RequestParam用于接收url地址传参或表单传参

■ @RequestBody用于接收json数据

■ @PathVariable用于接收路径参数，使用{参数名称}描述路径参数

应用：

■ 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广

■ 如果发送非json格式数据，选用@RequestParam接收请求参数

■ 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值