restful风格

前言

这个笔记来自黑马程序员的SpringBoot,里面是老师的笔记,这里给写了下来

restful风格

REST简介

* REST表现形式状态转换

	传统风格资源描述形式

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

		http://localhost/user/saveUser

	REST风格描述形式

		http://localhost/user/1

		http://localhost/user
* 优点:
	* 隐藏资源的访问行为,无法通过地址得知对资源是何种操作
	* 书写简化

REST风格简介

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
http:localhost/users 查询全部用户信息 GET(查询)
http:localhost/users/1 查询指定用户信息 GET(查询)
http:localhost/users 添加用户信息 POST(新增/保存)
http:localhost/users 修改用户信息 PUT(修改/更新)
http:localhost/users/1 删除用户信息 DELETE(删除)

根据REST风格对资源进行访问称为RESTful

注意事项:
上述行为是约定方式,约定不是规范,可以打破,所以称RESt风格,而不是REST规范
描述模块的名称通常使用复数,也就是加s的格式描述,表示此类资源,而非单个资源,例如:users、books、accounts…

	@Controller
	public class Controller{

		@RequestMapping(value="/users",method = RequestMethod.POST)
	    @ResponseBody
	    public String save(){
	        System.out.println("user save...");
	        return "{'module':' user save'}";
	    } 
	
	    @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(value="/users",method = RequestMethod.PUT)
	    @ResponseBody
	    public String update(@RequestBody User user){
	        System.out.println("user update..."+user);
	        return "{'module':' user update'}";
	    }
	    @RequestMapping(value="/users/{id}",method = RequestMethod.GET)
	    @ResponseBody
	    public String getById(@PathVariable Integer id){
	        System.out.println("user getById..."+id);
	        return "{'module':' user getById'}";
	    }
	    @RequestMapping(value="/users",method = RequestMethod.GET)
	    @ResponseBody
	    public String getAll(){
	        System.out.println("user getAll...");
	        return "{'module':' user getAll'}";
	    }
	}

步骤:
1.设置http请求动作(动词)
2.设定请求参数(路径变量)

RESTful快速开发

名称:@RequestMapping
类型:方法注解
位置:SpringMVC控制器方法定义上方
作用:设置当前控制器方法请求访问路径
属性:
value(默认):请求访问路径
method:http请求动作,标准动作(GET/POST/PUT/DELETE)

名称:@PathVariable
类型:形参注解
位置:SpringMVC控制器方法形参定义前面
作用:绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应

@Requestbody @Requestparam @PathVariable
区别:
@Requestparam用于接收url地址传参或表单传参
@Requestbody用于接收json数据
@PathVariable用于接收路径参数,使用{参数名称}描述路径参数
应用:
后期开发中,发送请求参数超过1个时,以json格式为主,@Requestbody应用较广
如果发送非json格式数据,选用@Requestparam接收请求参数
采用RESTful进行开发,当参数数量较小时,例如一个,可以采用@PathVariable接收请求路径变量,通常用于传递id值

名称:@RestController
类型:类注解
位置:基于SpringMVC的RESTful开发控制器类定义上方
作用:设置当前控制器类为RESTful风格,等同于@Controller与@ResponseBody两个注解组合功能
范例:

@RestController
		public class BookController {
		}

名称:@GetMapping @PostMapping @PutMapping @DeleteMapping
类型:方法注解
位置:基于SpringMVC的RESTful开发控制器方法定义上方
作用:设置当前控制器方法请求访问路径与请求动作,每种对应一个动作请求,例如@GetMapping对应GET请求
范例:

@GetMapping("/{id}")
    	public String getById(@PathVariable Integer id){
	        System.out.println("user getById..."+id);
	        return "{'module':' user getById'}";
    	}

属性:
value(默认):请求访问路径

你可能感兴趣的:(java,restful)