前后端接口写法（传输数据）

前言

对于后端常用的两个注解：详细分析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 或直接作为方法参数来接收查询参数

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