REST 风格与在Springboot里使用

最新推荐文章于 2024-09-09 07:30:00 发布
最新推荐文章于 2024-09-09 07:30:00 发布
阅读量885 收藏 5
点赞数 22
文章标签： spring boot 后端 java restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_63843408/article/details/141141789
版权

1：什么是REST风格

  • REST（Representational State Transfer）即表述性转移 ，RESTful（REST风格） 架构是一种软件设计风格，提供了一组设计原则和约束条件，是目前非常流行的一种软件架构风格。 Spring MVC 也提供对这种风格的支持。

  • REST 风格：用 URL 表示资源，用 HTTP 方法 （GET-查、POST-增、PUT-改、DELETE-删） 表示对资源的操作。 URL 中最明显的就是参数不再使用“?”传递 。

  • REST 风格优缺点：

    • 优点：URL 可读性更好，项目架构清晰 ，资源安全性更高。

    • 缺点： 由于中文乱码的问题，URL 参数传递中文时可读性就比较差。

    • # 传统 URL 请求
/esho/UserController?m=addUser&name=admin&pwd=123
/eshop/UserController/addUser.do?name=admin&pwd=123
/eshop/UserController/addUser?name=admin&pwd=123

# REST 风格请求
/eshop/user/1   		GET
/eshop/user/admin/123   POST
/eshop/user/admin/123  	PUT
/eshop/user/1   		DELETE

2：怎么使用REST风格

配置PUT和DELETE

由于 HTTP 不支持 PUT 和 DELETE 请求，所以需要将 POST 请求转化为 PUT 请求和 DELETE 请求，在 web.xml 中配置 SpringMVC 过滤器 HiddenHttpMethodFilter。

<!-- HiddenHttpMethodFilter 过滤器可以将 POST 请求转化为 PUT 请求和 DELETE 请求 -->
<filter>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>hiddenHttpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

REST 风格请求

<input type="button" value="增" id="add"/>
<input type="button" value="删" id="del"/>
<input type="button" value="改" id="update"/>
<input type="button" value="查" id="select"/>

<script type="text/javascript" src="../js/jquery-1.8.0.js"></script>
<script>
    //增
    $("#add").click(function(){
        $.post("/eshop/user",{name:"libai",age:"20"},function(ret){
            alert(ret);
        });
    });

    //删
    $("#del").click(function(){
        /* 
        	需增加一个 _method:"DELETE" 键值对。如果是form表单，可添加一个 hidden input。
        	SpringMVC 会解析为由服务器中 RequestMethod.DELETE 标注的方法处理。
        */
        $.post("/eshop/user/1",{_method:"DELETE"},function(ret){
            alert(ret);
        });
    });

    //改
    $("#update").click(function(){
         /* 
        	需增加一个 _method:"PUT" 键值对。如果是form表单，可添加一个 hidden input。
        	SpringMVC 会解析为由服务器中 RequestMethod.PUT 标注的方法处理。
        */
        $.post("/eshop/user",{_method:"PUT",name:"libai",age:"20"},function(ret){
            alert(ret);
        });
    });

    //查
    $("#select").click(function(){
        $.get("/eshop/user/libai/20",function(ret){
            alert(ret);
        });
    });
</script>

REST 风格请求处理

@RestController
public class RestfulController {
	/** 增 */
    @PostMapping("/user")
	//@RequestMapping(value = "/user",method = RequestMethod.POST)
	public String add(String name,Integer age){
		return "add:"+name+age;
	}

	/** 删 */
    @DeleteMapping("/user/{id}")
	//@RequestMapping(value = "/user/{id}",method = RequestMethod.DELETE)
	public String del(@PathVariable String id){
		return "del:"+id;
	}

	/** 改 */
    @PutMapping("/user")
	//@RequestMapping(value = "/user",method = RequestMethod.PUT)
	public String update(String name,Integer age){
		return "update:"+name+age;
	}

	/** 查 */
    @GetMapping("/user/{name}/{age}")
	//@RequestMapping(value = "/user/{name}/{age}",method = RequestMethod.GET)
	public String select(@PathVariable String name,@PathVariable Integer age){
		return "select:"+name+age;
	}
}

3：怎么在Springboot里使用REST风格

配置过滤器，启用过滤器

在application.properties里面改为true即可（因为内置了过滤器）

# RESTful
spring.mvc.hiddenmethod.filter.enabled=true

内容补充与代码展示

url表示资源，http请求方式表示操作，GET查 POST增 PUT改 DELETE删
GET 请求
用途: 用于从服务器检索资源。GET 请求通常用于查询数据。
POST 请求
用途: 用于向服务器提交数据以创建新的资源。POST 请求通常用于新增数据。

如果用的是ajax技术的话，那就是会在接收是用上注解@ResponseBody

Rest风格可以做到

注解合一：@RestController=@Controller+@ResponseBody


/**
 * RESTful: url 表示资源，http请求方式表示操作（GET-查、POST-增、PUT-改、DELETE-删）
 */

@Log4j
@RestController
public class UserController{
    @Autowired
    private UserService userService;

   
    @GetMapping("/user")
    public User doLogin( User user){
        return userService.select(user);
    }

    @PostMapping("/user")
    public boolean doAdd(User user){
        return userService.add(user);
    }
  
    @GetMapping("/user/list")
    public PageInfo<User> doList(User user, PageQueryBean page) {
        // 分页设置
        PageHelper.startPage(page.getPageNum(),page.getPageSize());
        // 查询
        ArrayList<User> list = userService.list(user);

        return new PageInfo<User>(list);
    }

    @DeleteMapping("/user/{id}")
    public boolean deleteById(@PathVariable("id") String id){
        return userService.deleteById(id);
    }

    @PutMapping("/user")
    public boolean update(User user) {
        return userService.update(user);
    }

    @GetMapping("/user/{username}")
    public boolean selectYhm(@PathVariable("username") String yhm){
        return userService.selectYhm(yhm);
    }
}

methods:{
		// 重置
		doReset(){
			this.user = {
				yhm:'',
				yhsf:'',
				zcsj:'',
				sjh:'',
				sex:'',
				email:''
			};
		},
		doPageReset(){
			this.page = {
				pageNum: 1,
				pageSize: 5,
				pages:0,
				total:0
			}
		},
		doPageList(pageNum){
			if(pageNum == 0){
				pageNum = 1;
			}
			if(pageNum > this.page.pages){
				pageNum = this.page.pages;
			}
			this.page.pageNum = pageNum;

			this.doList();
		},
		doFormList(){
			this.doPageReset();
			this.doList();
		},
		// 查询
		doList(){
			axios({
				url:'/book/user/list',
				method:'GET',
				params: Object.assign({},this.user, this.page)
			}).then(response => {
				console.log(response.data)

				this.users = response.data.list;
				// 分页信息
				this.page.pages = response.data.pages;
				this.page.total = response.data.total;
			});
		},
		// 删除
		doDelete(user){
			axios({
				url:"/book/user/"+user.yhbh,
				method:'DELETE',
			}).then(response => {
				if(response.data === true){
					this.doList();	// 删除成功，查询刷新表格数据
				}
			});
		},
		// 显示 更新弹窗
		showUpdateWindow(user){
			$("#updateWindow").show("slow");
			this.updateUser = Object.assign({},user);
		},
		// 关闭 更新弹窗
		closeUpdateWindow(){
			$("#updateWindow").hide("slow");
		},
		// 保存更新
		doAdd(){
			axios({
				url:"/book/user",
				method:'PUT',
				params:this.updateUser
			}).then(response => {
				if(response.data === true){
					this.doList();	// 更新成功，查询刷新表格数据
				}
				this.closeUpdateWindow();	// 关闭弹窗
			});
		}
	},
	mounted(){
		// 页面初始化查询
		this.doList();
	}

这两段代码分别是后端controller层和前端的方法，


总结

RESTful 风格（Representational State Transfer）是一种设计网络应用程序的架构风格，旨在利用 HTTP 协议的现有标准，以简洁的方式创建可扩展的 Web 服务。RESTful 风格使 API 的设计更具一致性和可维护性。

RESTful 风格的核心原则

  1. 无状态性（Stateless）:

    • 每个请求从客户端到服务器必须包含所有必要的信息，以便服务器理解和处理请求。服务器不应在请求之间存储任何状态信息。

  2. 统一接口（Uniform Interface）:

    • 通过使用一致的接口（通常是 HTTP 方法和 URL 结构），简化和分离系统的架构。

  3. 资源的表现（Resource Representation）:

    • 在 REST 中，资源是 API 的核心。每个资源都可以通过 URI（统一资源标识符）进行标识，客户端通过不同的表现形式（如 JSON 或 XML）与资源进行交互。

  4. 客户端-服务器结构（Client-Server Architecture）:

    • 客户端和服务器的职责分离，客户端负责用户界面和用户体验，服务器负责数据存储和业务逻辑。这样可以提高系统的可伸缩性。

  5. 层次化系统（Layered System）:

    • 系统可以由多个层次构成，每层只与相邻层进行交互。这有助于实现负载均衡、缓存和安全性等功能。

  6. 可缓存性（Cacheability）:

    • 资源应具有明确的缓存指示，允许客户端缓存响应以提高性能和减少服务器负担。

RESTful API 的基本构造

  1. 资源标识符（URI）:

    • 资源通过唯一的 URI 进行标识。例如：
      • 获取用户列表：GET /users
      • 获取特定用户：GET /users/{id}
      • 创建新用户：POST /users
      • 更新特定用户：PUT /users/{id}
      • 删除特定用户：DELETE /users/{id}

  2. HTTP 方法:

    • GET: 检索资源。
    • POST: 创建资源。
    • PUT: 更新资源。
    • DELETE: 删除资源。

  3. 状态码:

    • 200 OK: 请求成功。
    • 201 Created: 资源创建成功。
    • 204 No Content: 删除操作成功。
    • 400 Bad Request: 请求无效。
    • 404 Not Found: 资源未找到。
    • 500 Internal Server Error: 服务器内部错误。
安安啦
关注
Springboot基础篇-REST风格
weixin_52972575的博客
07-17 685
rest风格
Springboot mvc开发之Rest风格及RESTful简化开发案例
热门推荐
温柔半两，从容一生
05-19 11万+
这个内容对以后开发中很重要吧这个知识点有点欠缺我们这边是一个知识加油站是隶属于springboot mvc的一个小的细节互联网上。
springboot与ssm项目构建(rest风格)
06-12
非常详细的springboot与ssm项目构建，使用的环境是jdk1.8，maven3.3.9，下载解压直接import进eclipse直接使用！
REST风格
chenpeng19910926的专栏
04-19 465
RESTful的原则： URL表示资源HTTP方法表示操作GET只是用来请求操作，GET操作永远都不应该修改服务器的状态。但是这个也要具体情况进行分析，例如一个页面中的计数器，每次访问的时候确实引起了服务器数据的改变，但是在商业上来说，这并不是一个很重要的改变，所以仍然可以接收使用GET的方式来修改数据。服务应该是无状态的 在有状态的会话中，服务器可以记录之前的信息。而RESTful风格中
REST风格（SPRINGBOOT框架）
最新发布
ZangLing的博客
09-09 2084
一、核心概念 二、主要特点 三、优点 四、缺点 五、应用实例
Springboot REST风格
matafeiyanll的博客
05-11 344
REST简介 REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格 当我们想表示一个网络资源的时候，可以使用两种方式: 传统风格资源描述形式 http://localhost/user/getById?id=1 查询id为1的用户信息 http://localhost/user/saveUser 保存用户信息 REST风格描述形式 http://localhost/user/1 http://localhost/user
spring-boot-master_rest_world_springboot_java_springboot_
10-02
在描述中提到的 "spring boot hello world rest"，表明这是一个入门级别的教程，将展示如何使用 Spring Boot 创建一个简单的 RESTful API 来实现 "Hello, World!" 功能。REST（Representational State Transfer）是...
rest-api-springboot
02-22
标题 "rest-api-springboot" 暗示我们讨论的主题是使用Spring Boot构建RESTful API。Spring Boot是Java生态系统中的一个流行框架，它简化了创建独立的、生产级别的基于Spring的应用程序。REST（Representational ...
Springboot的rest风格
优快云新星计划JAVA赛道TOP5、优快云内容合伙人、JAVA领域优质创作者、资深JAVA开发深耕JAVA领域。
05-29 955
rest风格严格意义上说不是一种标准，而是一种风格，在如今互联网界，这个风格被广泛用于微服务系统之间的交互。 REST简单介绍 REST（Representional State Transfer）直译为表现层状态转换。针对REST和RESTful的介绍，觉得这篇博客写的不错，可以参看一下REST，RESTful介绍. 其实总结起来也就几句话，rest设计规范为通过url表示接口名，HTTP...
spring boot的Rest风格
qq_42338293的博客
04-05 226
@RequestMapping(value = "/hello",method = RequestMethod.GET) rest风格支持（使用http请求资源动词来表示对资源的操作） 以前/getUser 获取用户 /deleteUser 删除用户 /editUser修改用户 /saveUser 保存拥护 rest风格/user GET-获取用户 DELETE-尚出用户 PUT-修改用户 POST-保存用户 ...
springboot的REST风格
m0_51459514的博客
04-06 243
按照REST风格访问资源时使用行为动作区分对资源进行何种操作 http://localhost/users 查询全部用户信息 GET(查询) http://localhost/users/1 查询指定用户信息 GET(查询) http://localhost/users 添加用户信...
Rest 风格
qq_35573689的博客
05-22 180
从入行开始面试基本上会问rest是怎么理解的。现在面试别人，也有人会说就是使用put、get、post、delete等方式进行请求。我觉得这种字面上的理解不能说是不对的，但是没有抓到点上。rest应该是一种对资源的操作方式，rest风格是重资源轻操作。举例来说我要查询一个id是1的学生信息： 有部分访问url是这样的： http://localhost:8000/getStu?stuid=1 rest的访问应该是这种： http://localhost:8000/stu/1 ...
Rest风格
chenkaibsw的专栏
10-18 113
Rest用来规定URL定制。 旧的URL方式写法，对图书操作: 查找: getBook?id=10 更新: updateBook?id=10 删除: deleteBook?id=10 添加: addBook?id=10 Rest风格的URL方式写法: 查找: book/10 GET方式 更新: book/10 PUT方式 删除: book/10 Delete方式 添加: book POST方式 ...
JavaEE(SSM框架，黑马程序员) P51~P79
Scxioi0的博客
03-09 1378
一、SpringMVC的数据响应 (1) 页面跳转 1、直接返回字符串 2、通过ModelAndVIew对象返回 ①、形式一 ②、形式二 ③、形式三 ④、形式四 (2) 回写数据 1、直接返回字符串 ①、形式一 ②、形式二 ③、使用JSON的转换工具将对象转换成JSON格式字符串在返回 导入坐标 2、返回JSON对象类型 ①、形式一 ②、返回集合类型 ③、上面配置比较麻烦的话，可以加载驱动使用更方便，代码如下： 3.1、注释 3.2、加载mvc注解驱动 3.3、运
rest风格
u012572955的专栏
06-13 821
作者：suhua su 链接：http://www.zhihu.com/question/28557115/answer/47846156 来源：知乎 著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。 1、REST 是面向资源的，这个概念非常重要，而资源是通过 URI 进行暴露。 URI 的设计只要负责把资源通过合理方式暴露出来就可以了。对资源的操作与它无关，
CAS REST认证源码集锦：SpringBoot与MyBatis整合
- 在本项目中，CAS REST认证指的是使用RESTful架构风格构建的CAS认证接口。这允许其他应用程序通过REST API与CAS服务器交互，以实现用户认证与单点登录功能。 **2. Maven源码** - 这表明提供的文件包含了基于Maven...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值