接口设计-增删改查

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

查询列表

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

相关推荐
可爱の小公举7 分钟前
Java 后端程序员转 AI Agent 工程师:一条可执行学习路线
java·人工智能·学习
bestcxx11 分钟前
多个维度对 Java、Python、C#、Go 这四种主流编程语言进行比较
java·python·c#
Bechamz15 分钟前
大数据开发学习Day26
java·大数据·学习
smallyoung15 分钟前
RAG质量评估全攻略:RAGAS四维指标 + 生产级监控实战
人工智能·后端
云深处@16 分钟前
【项目一】高并发内存池
java·开发语言
yangSnowy24 分钟前
mac系统安装hyperf框架swoole扩展
后端·macos·swoole
jiangbo_dev27 分钟前
.NET 性能风暴:如何将接口耗时从 2000ms 优化到 15ms(含 PostgreSQL 实战调优)
后端
渐儿29 分钟前
Coze Studio 深度文档 06:Eino 与工作流引擎深度
后端
书源丶39 分钟前
三十九、Java 枚举——固定常量的「安全卫士」
java·开发语言
seven97_top1 小时前
Tomcat 线程池的设计与实现:StandardThreadExecutor
java·tomcat