开发规范

常用的增删改查

service和class层都有以下通用方法可以使用

增
UserClass::add($data)
UserClass::batchAdd($data)

删
UserClass::deleteById($id)
UserClass::deleteByCondition($condition)

改
UserClass::updateById($id,$data)
UserClass::updateByIds($ids,$data)
UserClass::updateByCondition($condition,$data)

查
UserClass::getById($id,true)
UserClass::getByCondition($condition,true);
UserClass::getAllByCondition($condition,$order,$field,$indexBy)
UserClass::getByIds($ids,$order,$indexBy)
UserClass::getCount($condition)

UserClass::getList()
UserClass::getLimitList()
UserClass::getAllList()

condition支持查询条件包括

$condition= [
    'name'=>'john'
    'id>'=>3
    'id<'=>10
    'id'=>['in',[10,11,12]]
    'age'=>['between',[20,30]]
    'name'=>['like','Jack']
];

service和class里的新方法命名规范建议

获取详情：getInfo getUserInfo getMerchantInfo

获取列表：getList getUserList getMerchantlist

文件命名规范

数据库表和文件都使用驼峰式的

助手和工具类文件以until为结尾。通用的util，数组类arrayUtil，字符处理类stringUtil等

调试方法

Yii自带debug，它对每一次的请求，参数，插入数据库都有记录，很好进行跟踪。在域名尾巴增加个debug即可使用，如：http://api.shop.hzghd.com/debug

分层设计

Controller调用service层，service调用class层 Controller可以直接调用class层，service可以调用service,class可以调用class class不可以调用service 所有操作都要经过class层每个字段配置文件都存在class层

controller service class 命名一般要以表名为依据

注释规范

开发功能，修改BUG，在别人代码上增加代码，都需要写明事项、修改人和时间，如：查询方法的优化 ssh 2019.9.21

统一输入输出格式

正确与错误输出：
//错误状态输出
util::fail('请填写名称');
//只输出成功状态
util::complete();
//输出成功状态并带数据
util::success(['userId'=>1],'操作成功');

分页：
page 第几页
pageSize 每页显示数
count 总数

数据库

建表常用几个字段：
inTurn 排序
addTime int 添加时间
updateTime int 修改时间


表名介绍

协作规范

文件的头部要填写自己的名称和时候；
如果修改别人的文件也要标注：修改内容、修改人和时间

开发规范.md 2.5 KB Permalink History Raw