《Zdeveloper代码规范.docVIP

Zdeveloper2.x代码规范 1 ZDeveloper命名规范 常用JAVA包命名(以platform插件为例)。 2 公共包 plugins存放所有插件配置文件； lang存放所有插件国际化配置文件； JAVA存放所有插件java类文件； DB目录存放zdm文件。 3 一般情况java包 *.ui子包存放本插件所属UI类(*.ui省略前面的com.zving.platform,下同)； *.service子包存放本插件所属扩展服务类； *.service.impl子包存放扩展服务项实现类； *.extend子包存放本插件扩展相关的类（扩展点接口类或抽象类）； *.extend.impl子包存放本插件扩展实现类（扩展行为或其他扩展实现类）； *.bl子包存放本插件所属后台业务逻辑类。 4 特殊扩展服务用到java包 *.code子包存放本插件所属扩展代码管理扩展服务的扩展项类； *.privilege子包存放本插件扩展菜单权限服务的扩展项类； *.config子包存放本插件扩展配置项扩展服务的扩展项类； *.properties子包存放本插件扩展栏目或站点配置项相关的扩展服务的扩展项类； *.tag子包存放本插件扩展标签服务的扩项类； *.tempalte子包存放本插件扩展模板服务的扩展项类； （插件包的命名参展以上方式，项目需要可以酌情添加有一定意义的子包） 5 插件包 插件包统一以”com.zving.”+插件名称来命名(公司名称域名+插件名称)。 6 插件类 插件名称+”Plugin”，位于插件所属包根目录下。 7 插件配置文件 “com.zving.”+插件名称+”.plugin”。 8 UI类 页面名称+”UI”，类存放位置为“com.zving.”+插件名称+”.ui”子包。 9 扩展服务类 服务名称+”Service”，类存放位置为“com.zving.”+插件名称+”.service”子包。 10 扩展项类 依据扩展服务类定义子类接口规则命名,如模板服务的扩展项以Template结尾，菜单权限扩展服务器的扩展项以Priv结尾等。 11 扩展点抽象类 扩展点ID，类存放位置为”com.zving”+”插件名称”+”.extend”子包。 12 扩展行为类 扩展点ID+”Action”，类存放位置为“com.zving.”+插件名称+”.extend.impl”子包。 13 ZDM文件 *.zdm文件统一放在DB目录下，通常每个插件对应唯一的一个ZDM文件，zdm文件以插件名称命名，首字母大写。 zdm中的表命名规则： 1）首字母大写； 2）通用前缀ZC***，例如：ZCContent，其中Z表示ZVING，C指代产品类型CMS，Content表示具体的表实际描述名称。ZDUser，其中D表示Developer，指我们的基础开发平台。类似的还有ZShop中的ZSGoods等。 14 UI目录下文件命名规则 目录名称一律小写，页面文件名称首字母小写。 15 JAVA代码 Java代码应条理清晰易读，通常保持缩进规范适当空行即可，复杂的业务逻辑代码添加关键部分的注释说明。 16 总体原则 命名能有具体含义，不要是用简单字母组合、中文拼音以及不常见的单词缩写等。 17 JAVA代码命名规范(摘自网络) 定义规范的目的是为了使项目的代码样式统一，使程序有良好的可读性。 包的命名（全部小写，由域名定义）： Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性，每一名Java程序员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新的Java编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 例如：net.frontfree.javagroup 类的命名（单词首字母大写）： 根据约定，Java类名通常以大写字母开头，如果类名称由多个单词组成，则每个单词的首字母均应为大?写例如TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample，还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。 例如：Graphics 方法的命名（首字母小写，字母开头大写）： 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。 例如：drawImage 常量的命名（全部大写，常加下划线）： 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。 例如：MAX_VALUE 18 参数的命名 参数的命名规范和方法的命名规范相同，