前后端接口写法(传输数据)

2024-04-08 09:28
文章标签 接口 写法 传输数据

本文主要是介绍前后端接口写法(传输数据),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

  • 前言
  • 1. 零散数据
  • 2. 函数体
  • 3. 总结

前言

对于后端常用的两个注解:详细分析Java中的@RequestParam和@RequestBody

以下文章主要用于笔记总结,后续可翻看

1. 零散数据

前端数据

export const doWeekPlan = (ids,selectedPeriod) => {return request({url: '/api/blade-equipment/inforunningdata/doWeekPlan',method: 'post',params: {ids,selectedPeriod}})
}

此时需要带上@RequestParam ,也可以不要@RequestParam

@PostMapping("/doWeekPlan")
@ApiOperationSupport(order = 10)
@ApiOperation(value = "周计划" , notes = "传入infoRunningDataVO")
public R doWeekPlan(@RequestParam Long ids,@RequestParam String selectedPeriod){Result result = null;try {result = infoRunningDataService.doWeekPlan(ids,selectedPeriod);return R.status(result.getIsTrue());}catch (Exception e){return R.fail(e.getMessage());}
}

带不带@RequestParam 的差异之处在于:

使用了 @RequestParam 注解,需明确指定每个参数的名称,并且参数是作为请求的一部分发送的,特别是Get请求

没有使用 @RequestParam 注解,而是直接将参数作为方法的参数传递。这种写法通常适用于 POST 请求,其中参数是通过请求体发送的。Spring 框架默认会将请求体中的数据与方法参数进行绑定

如果数据是通过请求体发送的,并且想要保持代码更加简洁,可以选择不使用 @RequestParam 注解。但如果明确指定参数名称或者处理 GET 请求,那么第一种写法会更加合适

2. 函数体

以下为get请求:

export const getList = (current, size, params,tenantId) => {return request({url: '/api/blade-equipment/inforunningdata/list',method: 'get',params: {...params,current,size,tenantId}})
}

后端数据

@GetMapping("/list")
@ApiOperationSupport(order = 2)
@ApiOperation(value = "分页", notes = "传入infoRunningData")
public R<IPage<InfoRunningDataVO>> list(InfoRunningData infoRunningData, Query query,String tenantId) {IPage<InfoRunningData> pages = infoRunningDataService.page(Condition.getPage(query),Condition.getQueryWrapper(infoRunningData).eq("tenant_id",tenantId));return R.data(InfoRunningDataWrapper.build().pageVO(pages));
}

如果是post请求:

export const add = (row) => {return request({url: '/api/blade-equipment/weekplan/save',method: 'post',data: row})
}

后端

@PostMapping("/save")
@ApiOperationSupport(order = 4)
@ApiOperation(value = "新增", notes = "传入weekPlan")
public R save(@Valid @RequestBody WeekPlan weekPlan) {boolean save = weekPlanService.save(weekPlan);if(save == false){String errorMessage = "存在如下周计划:\n" +"机种:" + weekPlan.getParentModel() + "\n" +",时间段:" + weekPlan.getPlanTime() + "\n";throw new RuntimeException(errorMessage);}return R.status(save);
}

需要在请求体中发送一个对象时,使用 @RequestBody 注解以及 POST 请求。
需要发送一系列查询参数时,使用 GET 请求,并将参数作为查询参数发送

3. 总结

对于新增操作:(适用于需要创建新资源的场景)
前端通常使用 POST 请求,并将数据作为请求的主体发送到后端
后端使用 @RequestBody 注解来接收请求体中的数据

对于查询操作:(根据特定条件检索数据的场景)
前端通常使用 GET 请求,并将查询参数作为 URL 的一部分发送到后端
后端使用 @RequestParam 或直接作为方法参数来接收查询参数

两种写法都是有效的,但适用于不同的场景,具体选择取决于需求和偏好
在设计接口时,需要考虑到前后端数据的传输方式、请求类型以及参数的处理方式,以便实现更好的交互和数据传递

这篇关于前后端接口写法(传输数据)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/885190

相关文章

SpringBoot+Redis防止接口重复提交问题

《SpringBoot+Redis防止接口重复提交问题》:本文主要介绍SpringBoot+Redis防止接口重复提交问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录前言实现思路代码示例测试总结前言在项目的使用使用过程中,经常会出现某些操作在短时间内频繁提交。例

springboot下载接口限速功能实现

《springboot下载接口限速功能实现》通过Redis统计并发数动态调整每个用户带宽,核心逻辑为每秒读取并发送限定数据量,防止单用户占用过多资源,确保整体下载均衡且高效,本文给大家介绍spring... 目录 一、整体目标 二、涉及的主要类/方法✅ 三、核心流程图解(简化) 四、关键代码详解1️⃣ 设置

spring中的ImportSelector接口示例详解

《spring中的ImportSelector接口示例详解》Spring的ImportSelector接口用于动态选择配置类,实现条件化和模块化配置,关键方法selectImports根据注解信息返回... 目录一、核心作用二、关键方法三、扩展功能四、使用示例五、工作原理六、应用场景七、自定义实现Impor

MybatisPlus service接口功能介绍

《MybatisPlusservice接口功能介绍》:本文主要介绍MybatisPlusservice接口功能介绍,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友... 目录Service接口基本用法进阶用法总结:Lambda方法Service接口基本用法MyBATisP

mybatis的mapper对应的xml写法及配置详解

《mybatis的mapper对应的xml写法及配置详解》这篇文章给大家介绍mybatis的mapper对应的xml写法及配置详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,... 目录前置mapper 对应 XML 基础配置mapper 对应 xml 复杂配置Mapper 中的相

Java中的Closeable接口及常见问题

《Java中的Closeable接口及常见问题》Closeable是Java中的一个标记接口,用于表示可以被关闭的对象,它定义了一个标准的方法来释放对象占用的系统资源,下面给大家介绍Java中的Clo... 目录1. Closeable接口概述2. 主要用途3. 实现类4. 使用方法5. 实现自定义Clos

java对接第三方接口的三种实现方式

《java对接第三方接口的三种实现方式》:本文主要介绍java对接第三方接口的三种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录HttpURLConnection调用方法CloseableHttpClient调用RestTemplate调用总结在日常工作

Java 的 Condition 接口与等待通知机制详解

《Java的Condition接口与等待通知机制详解》在Java并发编程里,实现线程间的协作与同步是极为关键的任务,本文将深入探究Condition接口及其背后的等待通知机制,感兴趣的朋友一起看... 目录一、引言二、Condition 接口概述2.1 基本概念2.2 与 Object 类等待通知方法的区别

SpringBoot实现接口数据加解密的三种实战方案

《SpringBoot实现接口数据加解密的三种实战方案》在金融支付、用户隐私信息传输等场景中,接口数据若以明文传输,极易被中间人攻击窃取,SpringBoot提供了多种优雅的加解密实现方案,本文将从原... 目录一、为什么需要接口数据加解密?二、核心加解密算法选择1. 对称加密(AES)2. 非对称加密(R

Java对接Dify API接口的完整流程

《Java对接DifyAPI接口的完整流程》Dify是一款AI应用开发平台,提供多种自然语言处理能力,通过调用Dify开放API,开发者可以快速集成智能对话、文本生成等功能到自己的Java应用中,本... 目录Java对接Dify API接口完整指南一、Dify API简介二、准备工作三、基础对接实现1.