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

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

 
阅读更多

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 暂无.

 

分享到:
评论

相关推荐

    Ofbiz开发规范.docx

    综上所述,《Ofbiz开发规范》是指导开发人员编写高质量、高可读性Ofbiz应用的指南,它强调了代码风格的统一、代码结构的清晰以及注释的充分,旨在促进团队间的有效沟通和项目的长期可持续发展。

    ofbiz源代码,库

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

    ofbiz安装与配置

    本文详细介绍了 Ofbiz 的安装与配置过程,包括环境搭建、Eclipse 参数及插件设置、Ofbiz 项目结构、使用 Eclipse 打开 Ofbiz 的 Ant 命令、Ofbiz 数据库(MySQL)安装及配置等内容。希望本文能够帮助初学者快速上手 ...

    Apache.OFBiz.Development

    4. OFBiz工作环境设置:需要配置OFBiz的工作环境,并设置在Eclipse这样的集成开发环境(IDE)中的项目。 5. 使用Derby数据库:Derby是一个小型的开源数据库,是OFBiz的默认数据库。涉及如何安装、备份和恢复数据...

    原创 Ofbiz 入门教程

    Ofbiz(Open for Business)是一款开源的企业级商务应用系统,它利用了一系列优秀的开源项目如Tomcat、Ant、BeanShell、Jboss等,构建出了一个强大的系统平台。Ofbiz的核心优势在于其已经预先实现了许多企业级应用中...

    ofbiz学习笔记(自学整理)

    建议首先阅读这些文档,以便对Ofbiz有一个全面的认识。在阅读过程中,注意记录关键点,尤其是涉及到的命令行操作、XML配置和代码示例。 在学习Ofbiz的过程中,你可能会遇到的问题可能包括:理解和配置Ofbiz的复杂...

    OFBiz API中文版.chw

    OFBiz API中文版.chw

    ofbiz git 服务搭建

    本教程将详细介绍如何在本地环境中搭建OFBiz项目,并使用Git进行版本控制。 首先,确保你拥有以下基础环境: 1. JDK 1.7:Java开发环境,OFBiz需要1.7版本或以上。 2. Eclipse 4.0:一个流行的Java集成开发环境...

    Ofbiz 数据库全模型

    Ofbiz,全称为The Open For Business Project,是一个开源的企业应用框架,主要由Apache软件基金会维护。这个项目旨在提供一套全面的、可扩展的企业级应用程序解决方案,涵盖了电子商务、供应链管理、客户关系管理等...

    关于OFBIZ的资料

    5. **文档资料**:除了代码和演示数据,压缩包可能还包含OfBiz的官方文档,包括用户手册、开发者指南和技术参考,这些都是学习OfBiz的重要资源。 6. **源码分析**:对于开发人员而言,理解OfBiz的源码结构和设计...

    ofbiz api开发文档

    学习OFBiz API并不仅仅局限于阅读文档,参与OFBiz社区的讨论,参考开源项目,甚至贡献代码都是提高技能的有效途径。此外,不断跟踪OFBiz的版本更新,了解新特性也是保持技术领先的关键。 总结,OFBiz API开发文档...

    ofbiz10.04表结构

    标题中的"ofbiz10.04表结构"指的是OFBiz 10.04版本的数据模型设计,这是企业级开源应用框架OFBiz的一个...通过研究这些材料,开发者可以更好地了解OFBiz如何存储和处理业务数据,从而提高其在实际项目中的应用能力。

    gentlexue#POC-3#Apache OfBiz 服务器端模板注入(SSTI)1

    Apache OfBiz 服务器端模板注入(SSTI)Apache OfBiz 17.12.01容易受到服务器端模板注入(SSTI)的影响,从而导致远程代码执行

    OFBiz教程_-_初学者的开发指南

    ### OFBiz教程——初学...- **开发规范**:在开始编写代码之前,请务必阅读OFBiz的[Contributors Best Practices](http://docs.ofbiz.org/display/OFBADMIN/OFBiz+Contributors+Best+Practices)、[Coding Conventions]...

    ofbiz 英文pdf

    - **使用SVN获取OFBiz**:提供具体步骤来获取OFBiz项目代码。 - **OFBiz工作区简介**:介绍OFBiz项目的结构及基本文件组织方式。 - **安装Java开发工具包(JDK)**: - **下载JDK 5.0**:提供官方下载链接。 - ...

    OFBIZ快速入门OFBIZ快速入门

    将OFBiz源代码下载到本地,例如`C:\Java\ofbiz-release4.0`。 **三、运行OFBiz** 在命令行中,导航到OFBiz的根目录(如`C:\Java\ofbiz-release4.0`),执行`ant run-install`命令进行编译和安装。这可能需要一段...

    Apache OFBiz Development The Beginner's Tutorial

    - **社区驱动的开源项目**:Apache OFBiz 是一个完全免费且由社区维护的开源项目。 - **功能强大**:作为最佳电子商务与企业资源规划(ERP)软件之一,它提供了全面的功能集合,适合各种规模的企业使用。 #### 第一...

    ofbiz综合使用手册

    ofbiz遵循了Model-View-Controller(MVC)设计模式,这种模式对于大型商业逻辑项目的开发尤其有益,因为它能够有效地分离用户界面、后台操作和业务逻辑,降低代码耦合度,提高系统的可维护性和可扩展性。 **1. MVC...

Global site tag (gtag.js) - Google Analytics