对Restful的理解

什么是Restful?

Restful是Roy Thomas Fielding这位大神在他的博士论文文中提出来。由于其超前的思想,在当时并未引起过多的注意。

直到近几年来,大概08年以后开始慢慢流行起来。

restful是一种设计思想。是Representational State Transfer的英文缩写:表现层状态转换或者表述型状态转换。这里省略了主语,是资源的表现型状态转换。

资源在网络中的体现就是URI。我们平时网上冲浪其实就是获取各种URI资源。获取的方式最简单的就是在浏览器地址栏输入URL。例如要访问百度资源:htttp://www.baidu.com

没有出现rest风格的时候,我们在编写javaweb程序时,例如要操作数据库里用户信息,我们的URL可以能会设计成:

http://127.0.0.1/user/query/1 GET  根据用户id查询用户数据

http://127.0.0.1/user/save POST 新增用户

http://127.0.0.1/user/update POST 修改用户信息

http://127.0.0.1/user/delete GET/POST 删除用户信息

而有了Restful风格后则设计为:

http://127.0.0.1/user/1 GET  根据用户id查询用户数据

http://127.0.0.1/user  POST 新增用户

http://127.0.0.1/user  PUT 修改用户信息

http://127.0.0.1/user  DELETE 删除用户信息

可以发现URI都是一样的,改变的只是客户端的请求方式而已,这就是restful风格的服务端无状态性(个人肤浅理解,更深入理解还需多实践才能懂得)。

Restful风格接口实现

@RestController
@RequestMapping("new/user")
public class UserController {
	
	@Autowired
	private UserService userService;
	
	/**
	 * 查询
	 * @param id
	 * @return
	 */
	@RequestMapping(value="{id}",method=RequestMethod.GET)
	public ResponseEntity<User> queryUserById(@PathVariable Long id){
		try {
			User user=this.userService.queryById(id);
			if (user == null) {
				return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
			}
			return ResponseEntity.status(HttpStatus.OK).body(user);
		} catch (Exception e) {
			e.printStackTrace();
		}
		return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
	}
	
	/**
	 * 新增
	 * @param user
	 * @return
	 */
	@RequestMapping(method=RequestMethod.POST)
	public ResponseEntity<Void> insertUser(User user){
		try {
			Boolean bool=userService.save(user)==1;
			if (bool) {
				return ResponseEntity.status(HttpStatus.CREATED).build();//HttpStatus.CREATED:201,build();没有返回值用build.
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();//HttpStatus.INTERNAL_SERVER_ERROR:500
	}
	
	/**
	 * restful风格修改资源接口
	 * @param user 
	 * @return void
	 */
	@RequestMapping(method=RequestMethod.PUT)
	public ResponseEntity<Void> updateUser(User user){
		try {
			Boolean bool=userService.update(user)==1;
			if (bool) {
				return ResponseEntity.status(HttpStatus.NO_CONTENT).build();//HttpStatus.NO_CONTENT:204,build();没有返回值用build.
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
	}
	
	/**
	 * 删除
	 * @param id
	 * @return
	 */
	@RequestMapping(method=RequestMethod.DELETE)
	public ResponseEntity<Void> deleteUser(long id){
		try {
			Boolean bool=userService.deleteById(id)==1;
			if (bool) {
				return ResponseEntity.status(HttpStatus.NO_CONTENT).build();
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
		return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build();
	}
	
	
	
	

}

HTTP响应状态码

响应结果示例

SpringMVC框架很强大,原生态的支持了restful风格

例如:@RequestMapping

           @ResponseBody

           @PathVariable

### 三级标题:RESTful 的基本概念 RESTful 是一种基于 HTTP 协议的 API 设计风格,它通过 URL、HTTP 动词和状态码等约定来实现客户端与服务器端的通信。其核心思想是将资源作为系统的核心抽象,每一个 URI 代表一种资源,客户端和服务器之间传递这种资源的某种表现层,而客户端通过 GET、POST、PUT、DELETE 等 HTTP 动词对服务器端资源进行操作,从而实现“表现层状态转化”[^4]。 在 RESTful 架构中,GET 用于获取资源,POST 用于创建资源(也可用于更新),PUT 用于更新资源,DELETE 用于删除资源,这与数据库的增删改查操作相对应[^4]。 ### 三级标题:RESTful 在 Web 开发中的应用 在实际开发中,RESTful API 广泛应用于构建现代 Web 服务。例如,在 Go 中使用 net/http 包可以非常简单地创建一个符合 REST 原则的 API 服务,开发者可以通过定义不同的路由和处理函数来响应不同 HTTP 方法的请求[^2]。 在 Rust 的 Actix Web 框架中,也提供了一套完整的工具来帮助开发者按照 REST 原则构建 API。通过定义资源端点、绑定 HTTP 方法和处理逻辑,可以快速搭建出结构清晰、易于维护的 Web 服务。例如,以下是一个简单的 RESTful 路由示例: ```rust use actix_web::{web, App, HttpServer, Responder}; async fn get_courses() -> impl Responder { "Returning list of courses" } async fn create_course() -> impl Responder { "Creating a new course" } #[actix_web::main] async fn main() -> std::io::Result<()> { HttpServer::new(|| { App::new() .route("/courses", web::get().to(get_courses)) .route("/courses", web::post().to(create_course)) }) .bind("127.0.0.1:8080")? .run() .await } ``` 该代码定义了两个端点 `/courses`,分别对应 GET 和 POST 请求,用于检索课程列表和发布新课程[^1]。 ### 三级标题:RESTful 的优势与最佳实践 采用 RESTful 风格设计 API 可以带来良好的可扩展性、一致性和可测试性。由于其基于标准的 HTTP 协议,因此无需额外的协议转换机制,简化了开发流程并提高了系统的互操作性[^4]。 在设计 RESTful Web Service 时,建议遵循如下原则: - 使用名词复数形式表示资源集合,如 `/users`; - 使用统一的状态码返回操作结果,如 200 表示成功、201 表示资源已创建、404 表示资源不存在; - 尽量避免在 URL 中使用动词,而是通过 HTTP 方法表达操作意图; - 支持 HATEOAS(超媒体即状态引擎),使客户端能够通过 API 自行导航。 这些实践有助于构建出更规范、易用和可维护的 API 接口[^3]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值