接口设计-增删改查

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

查询列表

  • 查询列表的接口,带上分页的入参: 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

相关推荐
小蝙蝠侠1 分钟前
async-profiler 火焰图宽度是否可信?哪些情况下会误导?(深度解析)
java·性能优化
Lear2 分钟前
【JavaSE】IO集合全面梳理与核心操作详解
后端
鱼弦4 分钟前
redis 什么情况会自动删除key
后端
ShaneD7718 分钟前
BaseContext:如何在Service层“隔空取物”获取当前登录用户ID?
后端
IT_Octopus11 分钟前
java多线程环境下 安全地初始化缓存(避免缓存击穿),同时兼顾性能 的双重检查锁方案
java·spring·缓存
ShaneD77117 分钟前
解决idea错误提示:无法解析'表名'
后端
Li_76953219 分钟前
Spring Cloud —— SkyWalking(四)
java·spring cloud·skywalking
while(1){yan}21 分钟前
多线程CAS八股文
java·开发语言·面试
zfj32122 分钟前
Docker和容器OCI规范的关系
java·docker·eureka
李拾叁的摸鱼日常27 分钟前
从 Java 8 升级视角看Java 17 新特性详解
java·后端