Laravel 项目开发规范

前言

Laravel 做为我们目前最主要的技术,我们都应该将其掌握。为了提高开发的效率,我们约定一套开发规范,在之后的项目开发中,我们都将遵循这套规范开发。

开发规范

为了更好的将 Laravel 的优势发挥出来,我们将在以下的规范中充分利用 Laravel 的特性。

数据先行

迁移文件是 Laravel 的一大亮点,迁移文件使得数据的维护更加有效率。在项目开发之前,数据库的设计至关重要。所以项目进行的第一步就是设计数据库。在这个阶段,必须有如下的产出:

  • 数据库迁移文件
  • Model 层关联关系
  • Repository 基础增删改查代码

基础接口

Repository 代码完成的基础之上,可以把基于 Resource 的基础接口完成,包括数据的验证,异常处理,数据格式化。其中各个模块的实现应该分离。接口的风格遵循 restful。在这个阶段应该有如下的产出:

  • routes.phpResource 接口定义
  • Controller 中 增删改查代码实现
  • 实现 XXRequest 完成数据验证
  • 实现 Transformer 完成数据格式化

第三方服务

在项目的开发中往往会使用第三方的服务来完成一些功能,比如邮件、短信、存储等。这方面可以与上述的阶段同时进行。这阶段应该有如下的产出:

  • 封装好的各个功能的接口。

扩展接口

在上述的三个阶段完成之后,整个项目的基础工作已经完成。那么在这阶段就需要设计出具体的业务逻辑接口。而接下来的工作只需要集中于逻辑代码的实现。这阶段应该有如下的产出:

  • 初版的业务逻辑接口
  • 系统后端的第一个版本

备注

以上是开发第一版系统应该遵循的开发规范。

疏影横斜水清浅,暗香浮动月黄昏