controller 控制器规范

基础控制器

所有API控制器必须继承 core\base\BaseApiController

<?php
namespace app\api\controller\member;

use core\base\BaseApiController;
use think\Response;

class CashOutAccount extends BaseApiController
{
    // 控制器代码
}

类命名规范

• 直接使用业务名称，不加 Controller 后缀

• 按功能模块分组

• 区分管理端和API端

方法命名规范

• 列表查询 : lists() - 获取资源列表

• 详情查询 : info($id) - 获取单个资源详情

• 添加资源 : add() - 创建新资源

• 编辑资源 : edit($id) - 更新现有资源

• 删除资源 : del($id) - 删除资源

• 其他操作 : 使用描述性动词，如 firstInfo() , config() , apply()

参数获取规范

使用 $this->request->params() 方法统一获取参数

public function add(){
    $data = $this->request->params([
        ['account_type', ''],           // 字段名, 默认值
        ['bank_name', ''],
        ['realname', ''],
        ['account_no', ''],
        ['transfer_payment_code', '']
    ]);
    
    // 数据验证
    $this->validate($data, 'app\validate\member\CashOutAccount.addOrEdit');
    
    // 业务处理
    $id = (new MemberCashOutAccountService())->add($data);
    
    // 返回结果
    return success('ADD_SUCCESS', ['id' => $id]);
}

响应格式规范

使用统一的响应函数

// 成功响应
return success('操作成功', $data);
return success('ADD_SUCCESS', ['id' => $id]);

// 失败响应
return fail('参数错误');
return fail('操作失败', ['field' => '错误详情']);