存储过程及参数命名规范

存储过程及参数命名规范
一、存储过程命名规范
1．操作方式add(添加) mod(修改) del(删除) sel(查询) drag(托拽) copy(拷贝) lock(锁) chk(检查) cho(选择) rp(报表) ini(初始化) get(得到function专用)
2．结果类型Tree(树) Tab(表)
3．修饰语A(Tab专用修饰符all)
4．顺序bf(之前)
5．过程标识P (对外过程) F(方法) E(内部过程)
公有过程命名规则
公式：过程名＝标识＋对象条件＋操作及修饰
过程标识_对象名(By条件)(结果类型)_主操作方式(修饰语) (顺序)(次操作方式) ()是可选对象
例：
树查询p_xxxxTree_Sel
树节点查表p_xxxxTab_Sel
主特征表查询P_xxxxByChr_Sel
明细特征表查询P_xxxxByDtlChr_Sel
查询所有p_xxxxx_SelA
独立选择框树P_xxxxTree_Cho
独立选择框树查表P_xxxxTab_Cho
独立选择框待选项查询p_xxxxByChr_Cho
独立选择框已选择项查询P_xxxxSeled_Cho
业务绑定选择框树P_xxxxforxxxTree_Cho
业务绑定选择框树查表P_xxxxforxxxTab_Cho
业务绑定选择框普通查询p_xxxxforxxxByChr_Cho
业务绑定已选择项查询P_xxxxforxxxSeled_Cho
除主页面查询外的其他条件查询P_xxxxByxxxx_Sel
新增P_xxxx_Add
修改P_xxxx_Mod
删除P_xxxx_Del
删除前检查P_xxxx_ChkBfDel
初始化P_xxxx_IniBfxxx
新增,修改,删除任选合一P_xxxx_Save
方法命名规则
F_getxxx //函数使用GET
内部过程命名规则
E_xxxxByxxx_Mod//内部方法
E _xxxx_ChkDel
E _xxxx_ChkMod
E _xxxxByxx_Mod
二、变量命名规范
1.摘要表引用变量命名尽量定义在pkg_bom_define中防止重复定义
Dt_xxxxx 如：dt_cnctype_jp
2.自定义常量命名尽量定义在pkg_bom_define中防止重复定义
Const_xxxx 如:const_Leaf
3.自定义变量尽量定义在包头防止各过程重复定义
Var_xxxx 如:var_curpage 字符型变量
Flt_xxxx 如:flt_monery浮点型变量
Num_xxxx 如:num_pagecount数字型变量
三、RECORD命名规范
Record命名：
1．普通对象：Xxxx_Rec 例：Type Role_Rec is Record
2．树对象：XxxxTree_Rec 例： Type RoleTree_Rec is Record
四、游标定义规范
1．对外返回游标普通游标c_xxx 树游标c_xxxTree
例：type c_role is ref cursor return role_Rec; --返回角色信息游标
2．内部使用动态游标cur_xxx
例：for cur_num in c_num1(i_role_class) loop
五、类型自定义对象及table对象命名规范
1．自定义对象命名对象名＝模形名称_OBJ 例：CALENDAR_OBJ
2. 自定义TABLE命名
名称＝模形名称_ OBJ_ARRAY 例：CALENDAR_OBJ_ARRAY
六、入参自定义类型名称规范
自定义table类型入参数命名入参集对象命名＝i_模型名称_array例：i_hour_array
procedure Ssp_BfHourdelete_check(i_hour_array in HOUR_OBJ_ARRAY, --工时对象
o_Return_Code Out Varchar2, --返回代码
o_Error_Message Out Varchar2, --错误信息
o_Sqlerrm Out Varchar2 --错误sql信息
)is
七、JAVA方法命名规范
在dao接口中命名规范如下：
原则：1、过程中P开头的需要定义方法，其他则不需要
2、方法命名公式：方法名＝操作及修饰＋对象条件
参考：过程公式：过程名＝标识＋对象条件＋操作及修饰
例：过程名：P_xxxx_ChkBfDel JA V A方法名：chkBfDelxxx
过程名：P_xxxxTree_Sel JA V A方法名：queryXxxxTree
过程名：P_xxxx_Mod JA V A方法名：modXxxx
过程名：P_xxx_SelA JA V A方法名：queryAllXxx
注意事项：1、如果过程结尾是Sel 或SelA JA V A方法为query 或queryAll
2、如果过程结尾是Cho JA V A方法为queryXxxxCho
其他则严格按原来的过程命名规则定义JA V A方法名称。

八、工作量评估
按上面要求进行修改，则要修改现有的520个过程以及所有的JA V A的service,dao以及control层。

九、建议过程修改方法
过程名修改将导致JA V A开始人员无法对应Procedure名与JA V A方法名的对应关系。

建议建立对应关系文件。

表格式如下：。