接口设计-增删改查

关于增删改查的 接口设计,比较简单,有一些固定的做法可以使用。

查询列表

  • 查询列表的接口,带上分页的入参: pageNo,pageSize,非必选,并设置默认值。

  • 入参为 dto,根据 dto 从数据库查出实体对象 entity 后,转换为展示层 vo。

  • entity 对象转换为 vo,可以用 BeanUtils.copyProperties。

  • 必选参数,设置校验规则。

  • 查询列表,一般会根据更新时间(updateTime)降序。

  • 如果查询的某个参数如果是多选的,可以用逗号隔开。

  • 如果查询的某个参数要求模糊查询,可以用 like 查询数据库。

  • 排序的参数尽量不要超过两个,太多的排序会影响性能。

  • 如果对性能有要求,可以加缓存。

查看详情

  • 入参可以传 id, 根据id查询详情。

  • 如果对性能有要求,可以加缓存。

新增/修改

  • 新增和修改可以用同一个接口,根据 id 判断是新增还是修改,如果id 为空,说明是新增。
  • 如果查询列表/查看详情时用了缓存,新增/修改需要在修改了数据库后删除缓存,保持数据库和缓存的一致性。
  • 新增/修改,可以修改一下 updateTime,方便定位问题。
  • 新增/修改后,可以返回更新结果,判断是否更新成功。

导入导出

详情见: https://blog.csdn.net/sinat_32502451/article/details/133026409

如何写一个接口:

详情见:https://blog.csdn.net/sinat_32502451/article/details/133715927

相关推荐
man20171 分钟前
基于Springboot+Mysql的闲一品(含LW+PPT+源码+系统演示视频+安装说明)
java·spring boot·后端·mysql
AnalogElectronic2 分钟前
k8s deployment配置文件资源属性配置策略
java·容器·kubernetes
JCBP_7 分钟前
I/O进程5
服务器·c语言·后端·算法
1024小神11 分钟前
修改idea/android studio等编辑器快捷注释从当前行开头的反人类行为
java·编辑器·intellij-idea
写bug写bug16 分钟前
在Spring Boot中优雅的计算方法执行时间
java·spring boot·spring
写bug写bug32 分钟前
掌握 Spring 中的 WebClient
java·后端·spring
麓殇⊙38 分钟前
spring--整合Mybatis详解
java·spring·mybatis
长安明月42 分钟前
Java 实现 List<String> 与 String 互转
java·list
慕容静漪44 分钟前
本地部署Code Llama大模型结合Text generation Web UI远程运行LLM
开发语言·后端·golang