如何写一个接口

发布时间 2023-03-22 21:13:20作者: 乐之者v

代码规范

下载代码规范插件,Alibaba Java Coding Guidelines 。遵循《阿里巴巴java开发手册》。

日志

  • 关键的入参,最好打印日志,否则出了问题,很难定位。

  • 异常日志,最好打印出异常的方法栈,以及对应的参数,能够还原现场,定位问题。

  • 日志的级别要明确。关键的日志用 info级别,调试的日志用 debug 级别,错误日志用 error 级别。

分层

  • 根据不同的项目,使用 Controller-Service-Dao, 或者 Controller--Service--Manager--Dao。

Manager层是通用的数据库CRUD(增删改查),而Service层则是由多种CRUD构成的业务逻辑。

对象参数

  • 入参用 DTO,出参用 VO,数据库对应的用 Entity或者DO。

  • VO对象,哪怕是没有值的属性,最好也设置一个值,否则前端获取到对象后还得判断是否存在对应的属性。

面向对象

面向对象编程和面向对象设计的五个基本原则。

  • Single Responsibility Principle(单一职责原则)

  • Open Closed Principle(开闭原则)

  • Liskov Substitution Principle(里氏替换原则)

  • Interface Segregation Principle(接口隔离原则)

  • Dependency Inversion Principle(依赖倒置原则)

详情见: https://blog.csdn.net/Taobaojishu/article/details/114313082

单元测试

  • 最好写下单元测试,尽量提高覆盖率,减少线上问题。

在做重构的时候,有单元测试可以测试,不用担心重构出错。
线上出现问题,可以通过单元测试用例,快速测试。

对接第三方系统

  • 对接第三方系统,往往会比较耗时。在初次查询第三方系统后,可以考虑能否做缓存处理、或者本地数据表存储。

接口性能优化

详情见:https://www.cnblogs.com/expiator/p/17094135.html