我们开发团队是三个php,因为大家都有各自的开发习惯,写的时候也都有各自的开发,因此在开始开发之前先制定了一定的规范,方便以后代码的维护。
下面就把这份标准分享一下,希望能给需要的小伙伴一些帮助:
1.方法命名(驼峰式)
viewXxxxx
getXxxxxx
postXxxxx
2.每个view都有一个专门的js文件专门用于处理,后期方便维护。
3.ajax使用的接口使用MyResponse简单封装(返回封装好的json类)
4.微信版、App暂用同一项目(要求数据库设计必须合理)
5.把Const用起来,常用的状态、属性等都要用常量(特别用于各种状态值)
6.Helper工具类使用
7.验证可以用laravel自带的验证类:validate
required|string
required|integer
required|in:used,unused
required|integer|min:1|max:100
required|Numeric
required|Regex:/^1[34578][0-9]{9}
/
n
u
m
e
r
i
c
∣
r
e
g
e
x
:
/
1
[
34578
]
[
0
−
9
]
9
/ numeric|regex:/^1[34578][0-9]{9}
/numeric∣regex:/1[34578][0−9]9/
8.每个条件都要加{},{}在条件同行
格式是:if(){
}
数组或其他形式太多时专门定义变量
9.接口注释标准:方便用一些工具直接生成接口文档
/*
* @api {get} /v1/common/olconfig 在线参数
* @apiName olconfig
* @apiGroup 0Start
*
* @apiDescription 在线参数
*
* @apiVersion 4.0.0
* @apiSuccessExample Success-Response:
* HTTP/1.1 200 OK
* {
* “code”: 200,
* “detail”: “success”,
* “data”: {
* }
* }
*/
10.加盐存储、rsa加密传输(用户密码加密,表单传输rsa加密等)
11.登录生成token
每次登录重新生成token
token存放到redis中
12.单个数据库的操作用model来操作,连表查询用框架自带的DB类,很难的sql就用原声的sql。
注:目前开发用的laravel5.1框架。
以上就是一些开发前指定的标准了。有的时候,标准是很有必要制定了,有利于大家的开发速度和节省维护成本,也有利于自己养成好的代码习惯。