`
jiasudu1649
  • 浏览: 712343 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

OFBiz项目中代码规范建议

阅读更多

OFBiz项目中代码规范建议_beta0.1_build20110303

 

本规范建议分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 ftl中如有公共用法,应采用marco的写法.封装为控件.不得粘贴复制修改函数名

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

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

  <request-map uri="FindProduct">
        <security https="true" auth="true"/>
        <response name="success" type="view" value="FindProduct"/>
    </request-map>

  <request-map uri="EditProduct">
        <security https="true" auth="true"/>
        <response name="success" type="view" value="EditProduct"/>
    </request-map>

 

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

  <request-map uri="createProduct">
        <security https="true" auth="true"/>

        <event type="service" invoke="createProductService"/>
        <response name="success" type="view" value="createProduct"/>
    </request-map>

  <request-map uri="updateProduct">

      <security https="true" auth="true"/>

      <event type="service" invoke="updateProductService"/>

      <response name="success" type="view" value="updateProduct"/>

  </request-map>

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

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

 

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

      view-map名称尽量和他默认跳转的screen名称相同

      screen名称尽量和他默认包含的主的form名称相同

 

 

 

B.1 推荐在java代码中,

      try{

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

      }catch (Exception e) {

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

          其他代码

      }

B.2 推荐在写表单页面时尽可能采用forms.xml的写法,避免写ftl.

B.3 ftl仅仅用来处理 1调整布局 2显示按钮及控制其状态

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

B.5 写forms.xml时,尽可能让他简洁,我们掌控不好的东西尽量写在screens.xml中

B.6 写screens.xml时,可以多个forms拼接在一起使用

 

C.1 写screens.xml时,尽可能提炼系统级别的模板装饰器

C.2 代码注释尽量少写,常规注释不必写

 

D 暂无.

分享到:
评论
2 楼 jiasudu1649 2011-11-10  
规范是官方的,但是总有人不知道。所以我特意说明一下。

最好的程序中,代码就是文档。所以代码注释尽量少写。
1 楼 ppcqx 2011-11-09  
一直觉得 request 配置里面有的首字母大写,  有的小写。看了你的规范A5以后,才发现原来是有道理的。
这些规范是官方的,还是你整理的啊。

---代码注释为什么要少写?
                                                                    西西

相关推荐

    ofbiz源代码,库

    刚一近公司就让我用ofbiz做项目,ofbiz中文版+中文文档,liferay中文版+中文文档

    原创 Ofbiz 入门教程

    Ofbiz(http://www.ofbiz.org) 是 Open Source 的商务软件系统,充分利用了各优秀的的Open Source 项目, 像 Tomcat, Ant, BeanShell, Jboss 等,构建了一个强大的系统平台,Ofbiz 已经完成了大部分商务类软件系统 都...

    Ofbiz开发规范.docx

    Ofbiz开发规范.docx

    ofbiz 数据模型 中文手册

    ofbiz 数据模型 中文手册 ofbiz 核心的数据模型 表结构和字段翻译

    OFBIZ快速入门OFBIZ快速入门

    OFBIZ快速入门OFBIZ快速入门OFBIZ快速入门OFBIZ快速入门OFBIZ快速入门OFBIZ快速入门

    Ofbiz框架中的事务解析.pdf

    Ofbiz框架中的事务解析.pdf

    ofbiz中文技术文档

    搞ofbiz或者opentaps二次开发的朋友可以看看,中文技术文档,比较详细的

    ofbiz资料大全

    里面是下载地址,如果逆向开发ofbiz,只要下载它就绝对没错了 Apache+OFBiz+开发初学者指南.rar OFBiz开发快速入门.rar OFBiz-技术文档.rar OFBiz API中文版.rar Apache OFBiz Cookbook Sep 2010.rar Opentaps ...

    ofbiz权限(全)

    ofbiz权限非常介绍,ofbiz进阶之权限介绍!

    解决ofbiz中文报表"#"导入字体

    ofbiz后台应用 - 订单 - 订单查询/订单列表 - 订单明细 - "PDF" 报表, 中文报"#" 错误。 需导入中文解决

    ofbiz学习笔记(自学整理)

    自学整理的ofbiz学习笔记,自学整理的ofbiz学习笔记,自学整理的ofbiz学习笔记,自学整理的ofbiz学习笔记,适合初学者,可以下个看看

    ofbiz 教程_配置ofbiz

    ofbiz的获取与部署,主要用到了gradle 和 eclipse,注意:cmd部署时,需要一个较好的网络环境以下载gradle

    OFBIZ 开源项目分析

    正在我兴奋着自己能够成功地进入了...公司交给我的任务是对OFBIZ的release4.0中的bug的测试。在这期间我遇到了许多大大小小的麻烦,主要是因为对OFBIZ的不熟悉造成的,幸亏同事们对我的帮助,让我克服了这一个个困难

    Apache+OFBiz+开发初学者指南

    OFBiz是一个非常著名的电子商务平台,是一个非常著名的开源项目,提供了创建基于最新J2EE/XML规范和技术标准,构建大中型企业级、跨平台、跨数据库、跨应用服务器的多层、分布式电子商务类WEB应用系统的框架。 OFBiz...

    ofbiz_服务引擎

    ofbiz_服务引擎,ofbiz中最为称道的部分

    OFBIZ集成Activiti流程

    OFBiz集成Spring和Activiti,详细设计说明书。ofbiz版本12.04

    ofbiz jar file2

    ofbiz jar file, some jars for ofbiz

    Ofbiz开发初学者指南的learning练习源码

    由于Ofbiz版本已经到13了,原来的那本开发初学者指南还是很老旧的版本,书中的源代码已经过时了,在新版下无法工作,阻碍了入门者做练习,增加了学习的难度。此资源针对最新的v13版本做了修正,因此能够在新版本下...

    ofbiz开发框架建表语句 ofbiz_sql

    ofbiz sql 表结构

    ofbiz数据结构设计

    ofbiz数据结构

Global site tag (gtag.js) - Google Analytics