Axios与Java Spring交互：RESTful API设计与实现全解析

一、Axios、Spring框架

Axios 在前后端分离架构中扮演着重要角色，它是基于Promise的HTTP库，常用于浏览器和node.js环境中。Axios的重要性体现在：

异步数据交互：前端使用Axios可以方便地发起Ajax请求，与后端RESTful API进行数据交换。
跨域请求支持：Axios原生支持CORS，简化了处理跨域请求的复杂性。
请求/响应拦截器：允许开发者在请求发出前或响应到达后添加额外的处理逻辑，如统一处理错误、添加认证信息等。
用户友好：提供了简洁的API和丰富的配置选项，易于上手且功能强大。

Spring框架，尤其是Spring Boot，对于后端开发至关重要，特别是在实现前后端分离的架构时：

简化配置：Spring Boot通过约定优于配置的原则，极大减少了传统Spring应用的配置工作量。
内置RESTful支持：轻松创建RESTful风格的API，与前端交互，提供数据服务。
集成便利：提供了大量的Starter POMs，可以快速集成数据库访问、安全、消息队列等多种功能。
微服务友好：与Spring Cloud等框架配合，支持构建云原生的微服务架构，适合大规模应用开发。

二、HTTP方法其意义

理解HTTP方法的基本含义，这些方法遵循了RESTful架构的设计原则，分别对应着数据的检索（GET）、创建（POST）、更新（PUT/PATCH）和删除（DELETE）操作，是构建Web服务和API时的基础。

GET: 读取资源，参数通过URL传递，适合获取数据，是幂等的，安全但不适合敏感信息，可缓存。
POST: 提交数据，数据在正文，常用于创建新资源或处理数据，非幂等。
PUT: 更新资源，替换已有资源的全部数据，需知资源URL，数据在正文，幂等。
DELETE: 删除资源，根据URL移除指定资源，无正文，幂等。

三、Axios与Java Spring交互基础

Axios 安装

如果你是在一个基于 Node.js 的前端项目中使用 Axios，可以通过 npm 或 yarn 来安装它：

使用 npm:

npminstall axios

使用 yarn:

yarnadd axios

Axios 配置与使用

在前端项目中，你可以在需要发送 HTTP 请求的地方导入 Axios，并直接使用它来发送请求。以下是一个简单的示例：

import axios from'axios';

axios.get('http://localhost:8080/api/data').then(response=>{
    console.log(response.data);}).catch(error=>{
    console.error("Error fetching data", error);});

Spring Boot 项目快速启动

环境准备：确保你已经安装了 JDK 8 或更高版本以及 Maven 或 Gradle。
创建项目：你可以使用 Spring Initializr (https://start.spring.io/) 来快速生成一个基础的 Spring Boot 项目。选择你所需的依赖，如 Web（这会自动包含 Spring MVC 和 Tomcat 服务器）和其他可能需要的依赖。
编写 RESTful API：在生成的项目中，创建一个新的 Java 类，并使用 @RestController 注解标记该类，然后定义处理方法，如：

importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RestController;@RestControllerpublicclassDataController{@GetMapping("/api/data")publicStringgetData(){return"Hello from Spring Boot!";}}

运行项目：在项目根目录下，使用命令行工具执行 mvn spring-boot:run（如果你是用Maven管理项目）或 gradlew bootRun（如果是Gradle）。这将启动一个嵌入式的 Tomcat 服务器，并运行你的应用。
测试交互：现在你的 Spring Boot 应用已经运行，并提供了一个简单的 API。你可以使用之前配置好的 Axios 发送请求来测试这个 API。

四、接口请求与接收实战

第一种：/delete/{id} (删除单个资源)

前端传参：get、restful；后端接参：@GetMapping、@PathVariable

前端（Axios）：

axios.delete(`/delete/${id}`).then(response=>{
    console.log('Resource deleted successfully', response.data);}).catch(error=>{
    console.error('Error deleting resource', error);});

原因：使用

delete

方法直接对应于HTTP的DELETE操作，用于删除指定资源。这里利用了Restful风格中的路径参数，直接将资源ID嵌入URL中，清晰明了。

后端（Java Spring）：

@GetMapping("/delete/{id}")publicResponseEntity<String>deleteResource(@PathVariable("id")Long id){// 实现删除逻辑
    service.deleteById(id);returnResponseEntity.ok("Resource with ID "+ id +" has been deleted.");}

原因：

@GetMapping

搭配

@PathVariable

注解可以方便地从URL路径中提取参数，适合处理Restful风格的路径参数。

第二种：/delete?id=11(通过查询参数删除)

前端传参：get、params；后端接参：@GetMapping、@RequestParam

前端（Axios）：

axios.get('/delete',{ params:{ id:11}}).then(response=>{
    console.log('Resource deleted successfully', response.data);}).catch(error=>{
    console.error('Error deleting resource', error);});

原因：虽然这里是执行删除操作，但使用GET方法传递查询参数，适用于不直接修改服务器状态的查询操作。实际应用中应避免使用GET进行删除操作，因为这不符合REST原则且可能不安全。

后端（Java Spring）：

@GetMapping("/delete")publicResponseEntity<String>deleteResourceById(@RequestParam("id")Long id){// 实现删除逻辑
    service.deleteById(id);returnResponseEntity.ok("Resource with ID "+ id +" has been deleted.");}

原因：

@RequestParam

用于从请求的查询字符串中获取参数值，适合处理非路径参数的请求。

第三种：{id:1} (POST请求，传递JSON对象)

前端传参：post、data；后端接参：@PostMapping、@RequestBody

前端（Axios）：

axios.post('/update',{ id:1}).then(response=>{
    console.log('Resource updated successfully', response.data);}).catch(error=>{
    console.error('Error updating resource', error);});

原因：使用POST请求通常表示创建或更新资源，这里携带JSON对象作为请求体，符合RESTful设计中对资源操作的规范。

后端（Java Spring）：

@PostMapping("/update")publicResponseEntity<String>updateResource(@RequestBodyResourceUpdateRequest request){Long id = request.getId();// 实现更新逻辑
    service.updateResource(id);returnResponseEntity.ok("Resource with ID "+ id +" has been updated.");}

原因：

@PostMapping

配合

@RequestBody

可以接收请求体中的JSON数据并自动转换为Java对象，非常适合处理包含复杂数据结构的请求。

第四种：/update (PUT请求，更新资源)

前端传参：put、data；后端接参：@PutMapping、@RequestBody
前端（Axios）：

axios.put('/update',{ id:1, newName:'New Name'}).then(response=>{
    console.log('Resource updated successfully', response.data);}).catch(error=>{
    console.error('Error updating resource', error);});

原因：PUT请求常用于完全替换一个资源，这里携带资源的全部或部分属性作为请求体，符合HTTP协议中对PUT方法的语义。

后端（Java Spring）：

@PutMapping("/update")publicResponseEntity<String>updateResourceCompletely(@RequestBodyResourceUpdateRequest request){Long id = request.getId();String newName = request.getNewName();// 实现更新逻辑
    service.updateResourceCompletely(id, newName);returnResponseEntity.ok("Resource with ID "+ id +" has been completely updated.");}

原因：同样使用

@RequestBody

来接收请求体内容，并通过

@PutMapping

指定这是一个更新（替换）资源的操作，适用于需要替换整个资源实体的场景。

第五种：/create(POST请求，创建新资源)

前端传参：post、data（用于创建资源）；后端接参：@PostMapping、@RequestBody

前端（Axios）：

axios.post('/create',{ name:'New Resource'}).then(response=>{
    console.log('Resource created successfully', response.data);}).catch(error=>{
    console.error('Error creating resource', error);});

原因：POST请求是创建新资源的标准HTTP方法，通过请求体发送新资源的数据，遵循RESTful设计原则。

后端（Java Spring）：

@PostMapping("/create")publicResponseEntity<ResourceCreatedResponse>createNewResource(@RequestBodyNewResourceRequest request){String resourceName = request.getName();ResourceCreatedResponse response = service.createNewResource(resourceName);returnResponseEntity.status(HttpStatus.CREATED).body(response);}

原因：

@PostMapping

表明这是一个创建资源的操作，而

@RequestBody

用于解析请求体中的JSON数据到Java对象，

HttpStatus.CREATED

则表示响应状态码为201，符合HTTP标准中创建成功应返回的状态。

第六种：/search?keyword=example (GET请求，搜索资源)

前端传参：get、params；后端接参：@GetMapping、@RequestParam

前端（Axios）：

axios.get('/search',{ params:{ keyword:'example'}}).then(response=>{
    console.log('Search results:', response.data);}).catch(error=>{
    console.error('Error searching resources', error);});

原因：GET请求用于检索信息，这里通过查询参数传递搜索关键词，符合RESTful设计中对资源查询的处理方式。

后端（Java Spring）：

@GetMapping("/search")publicResponseEntity<List<Resource>>searchResources(@RequestParam("keyword")String keyword){List<Resource> results = service.searchByKeyword(keyword);returnResponseEntity.ok(results);}

原因：

@RequestParam

用于捕获URL中的查询参数，便于处理搜索或过滤请求，返回资源列表作为搜索结果。

第七种：/batchDelete (DELETE请求，批量删除)

前端传参：delete、data（例如：[{id: 1}, {id: 2}]）；后端接参：@DeleteMapping、@RequestBody

前端（Axios）：

axios.delete('/batchDelete',{ data:[{ id:1},{ id:2}]}).then(response=>{
    console.log('Resources deleted in batch successfully', response.data);}).catch(error=>{
    console.error('Error deleting resources in batch', error);});

注意：Axios的

delete

方法默认不支持发送请求体，若要发送请求体，需使用

axios({ method: 'delete', url: '/...', data: yourData })

的形式。

后端（Java Spring）：

@DeleteMapping("/batchDelete")publicResponseEntity<String>batchDeleteResources(@RequestBodyList<Long> ids){
    service.batchDelete(ids);returnResponseEntity.ok("Resources with IDs "+ ids +" have been deleted.");}

原因：

@DeleteMapping

用于定义处理批量删除的端点，

@RequestBody

接收一个资源ID列表，适合处理需要同时删除多个资源的场景。

每种方式中，前端使用axios时，请求方法（如get, post, put, delete等）与HTTP动词相匹配，以符合RESTful原则。后端Java代码中，使用Spring框架的注解来定义请求的处理方法及参数的接收方式，确保数据能够正确地在前后端之间传递。

五、区别与选择

GET请求：- 前端：通常用于请求资源或搜索，可通过查询参数传递信息。- 后端注解： - @GetMapping：处理GET请求，可以与路径变量(@PathVariable)或查询参数(@RequestParam)一起使用。- @PathVariable：用于从URL路径中提取参数。- @RequestParam：用于获取URL中的查询参数。
POST请求：- 前端：用于创建新资源或提交数据更改。- 后端注解： - @PostMapping：处理POST请求，多用于接收表单数据或JSON对象。- @RequestBody：从请求体中接收数据并映射到Java对象。
PUT请求：- 前端：更新现有资源的全部信息。- 后端注解： - @PutMapping：处理PUT请求，适用于资源的完整替换。- @RequestBody：从请求体中接收用于更新资源的全部数据。
DELETE请求：- 前端：删除指定资源。- 后端注解： - @DeleteMapping：处理DELETE请求。- @PathVariable：如果通过路径删除，用于获取路径中的参数。- @RequestBody：虽然较少见，但在批量删除等场景中可能需要从请求体中接收数据。

六、最佳实践与注意事项

安全性考虑:

避免使用GET进行修改操作: GET请求不应用于改变服务器状态的操作，因为它们可能会被浏览器预加载、被缓存或留在浏览历史中，增加无意中重复执行的风险。应使用POST、PUT或DELETE等方法进行数据修改或删除操作。
加密敏感数据: 对于敏感数据的传输，无论使用哪种HTTP方法，都应采用HTTPS协议，以保证数据在传输过程中的安全，防止窃听和篡改。
验证与授权: 实现合适的认证机制（如OAuth、JWT）和授权策略，确保只有合法用户能访问和修改数据。

性能优化建议:

使用异步处理: 前端使用Ajax（如Axios）进行异步请求，可以避免页面刷新，提升用户体验。后端可以利用异步编程模型（如Java的CompletableFuture）处理耗时操作，避免阻塞主线程。
合理设置缓存策略: - 对于静态资源和频繁请求但不经常变更的数据，使用HTTP缓存策略，如设置ETag、Last-Modified头或Cache-Control指令，减少服务器负载和网络延迟。- 利用浏览器缓存（GET请求），并通过适当的缓存过期策略保持数据新鲜度。
分页与懒加载: 对大量数据进行分页展示，仅在需要时加载更多内容（懒加载），减少初次加载时间，提升响应速度。
压缩响应: 启用GZIP压缩减少网络传输的数据量，尤其对于文本数据（如HTML、CSS、JavaScript和JSON）效果显著。
数据库优化: 索引优化、查询优化、合理使用缓存（如Redis）来减轻数据库压力，提高数据读写速度。

标签： 1024程序员节

本文转载自: https://blog.csdn.net/qq_46207024/article/details/143206943
版权归原作者 Yeats_Liao 所有，如有侵权，请联系我们删除。

Axios与Java Spring交互：RESTful API设计与实现全解析

一、Axios、Spring框架

二、HTTP方法其意义

三、Axios与Java Spring交互基础

四、接口请求与接收实战

第一种：/delete/{id} (删除单个资源)

第二种：/delete?id=11(通过查询参数删除)

第三种：{id:1} (POST请求，传递JSON对象)

第四种：/update (PUT请求，更新资源)

第五种：/create(POST请求，创建新资源)

第六种：/search?keyword=example (GET请求，搜索资源)

第七种：/batchDelete (DELETE请求，批量删除)

五、区别与选择

六、最佳实践与注意事项

发表评论

“Axios与Java Spring交互：RESTful API设计与实现全解析”的评论:

关于作者

overfit同步小助手

相关阅读

文章导航