欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

OFBiz前后端分离项目代码规范建议2018版 博客分类: ofbiz观点  

程序员文章站 2024-03-19 20:53:16
...

OFBiz前后端分离项目代码规范建议__build20180511

 

本规范建议分ABCD四档 ABC中每档不超过6条记录,D档中记录数不限

A 为坚决避免,出现该错误的话,不能容忍.

B 为推荐规范,尽量照其靠拢.

C 为过时的AB中的内容,或级别更低的推荐规范.

D 为ABC中过时的东西,类似windows回收站的角色,仅为初入Java职途的人士提供建议.

 

A.1 在java代码中,书写业务的时候,不能出现java迭代器中包含重复执行操作数据库的语句.每个java方法不要超过50行.

A.2 在java代码中,不能出现如下代码

      try{

           ........业务逻辑

      }catch (Exception e) {}

A.3 在java代码中,最后输出到页面的list必须调用performFind或以及基于performFind改进的service方法.

      避免自己书写分页方法.

A.4 页面中中如有公共用法,应采用封装为控件的方式.不得粘贴复制修改函数名

A.5 根据OFBiz约定成俗的一些用法, 推荐

  显示用途的请求首字母大写

 

path: '/SecurityGroup',

redirect: '/FindEcSecurityGroup',

path: '/FindEcSecurityGroup',

path: '/NewSecurityGroup',

path: '/EditSecurityGroup',

 

 

  操作数据库用途的请求首字母小写

  listEcSecurityGroup:setAdminApi('listEcSecurityGroup'),//列出安全组

    getEcSecurityGroup:setAdminApi('getEcSecurityGroup'),//安全组详情

    createEcSecurityGroup:setAdminApi('createEcSecurityGroup'),//新建安全组

    updateEcSecurityGroup:setAdminApi('updateEcSecurityGroup'),//修改安全组

 

    removeEcSecurityGroup:setAdminApi('removeEcSecurityGroup'),//删除安全组

 

显示界面的如 FindProduct 查询产品 ListProduct 列表产品 EditProduct编辑产品 NewProduct新建产品

操作数据库的如 createProduct 创建产品 updateProduct修改产品 removeProduc删除产品

 

A.6 request名称尽量和他默认跳转的名称相同

      跳转名称尽量和他默认跳转的后台服务接口名称相同类似

      请求名称尽量和他默认包含的主的页面名称相同

 

 

 

B.1 推荐在java代码中,

      try{

           ........业务逻辑

      }catch (Exception e) {

          Debug.log(e.getMessage(), module);

          其他代码

      }

B.2 推荐在写表单页面时尽可能采用封装组件的写法,避免写html.

B.3 系统中凡是处理状态的代码,尽可能采用ECA代替,这样我们应对客户流程变更时,会显得得心应手些.

B.4 尽量采用前后端分离团队模式开发

B.5 mock数据尽量考虑完善

B.6 单元测试尽量完备

 

C.1 写页面时,尽可能提炼系统级别的模板组件

C.2 代码注释尽量少写,常规注释不必写,但是命名一定要规范,尽量达到望文既意。

 

D 暂无.