UAP-Studio插件开发规范1.5.docxVIP

UAP-Studio 插件开发规范V1.5UAPJAVA应用平台开发部2013-11-20适用范围：所有UAP-Studio套件(MDE、MOB、ESB、MDP、TEST、WEB)及后续新增套件一、命名规范Bundle和Fragment命名规范com.yonyou.studio.suite.module.[submodule]bundle名称全小写，与标准的eclipse bundle命名习惯统一Bundle版本：major.minor.micor.[qualifier-String]qualifier-String不允许使用“qualifier”代替类似的当前时间戳，如果需要时间戳，请手工维护。注意，eclipse创建bundle时会自动添加“qualifier”，请清理掉，版本号必须为3位，不够3位补0为什么不允许使用qualifier?bundle打包构建采用maven+tycho，编译后会发布到公司的中央仓库，qualifier会被maven识别成SNAPSHOT，属于快照，无法发布到RELEASE库中。示例：com.yonyou.studio.ria.template_6.5.3com.yonyou.studio.ria.template.ui_6.5.3.201310111036com.yonyou.studio.esb.service.spi_6.5.3.RELEASEFeature命名规范com.yonyou.studio.suite.[name].feature示例：com.yonyou.studio.ria.feature 必须以feature结尾com.yonyou.studio.ria.template.feature多语fragment命名规范hostbsn.nl_locale示例com.yonyou.studio.ria.template.nl_zhcom.yonyou.studio.ria.template.nl_zh_CNcom.yonyou.studio.ria.template.nl_encom.yonyou.studio.ria.template.nl_en_US二、第3方jar包使用规范1. 建立第3方bundle库(studio_depend)，有专人负责管理bundle新增、删除、版本更新等维护工作，确保其稳定。2. 如果studio_depend中存在，suite中bundle请与其统一版本，不满足需要请与bundle管理员联系。3. bundle中不允许包含第3方jar，必须以bundle形式引用。如果studio-depend中不存在，请联系bundle管理员。有些第3方jar只被1个bundle引用，这种情况下，应向bundle管理员提交申请，管理员制作bundle并做好备案后发送给开发人员，开发人员将bundle加入到相应的套件中。4. 原则上不允许修改第3方jar包，如要必须修改，由管理员进行分析和修改制作成bundle，并做好备案。三、Eclipse版本和公共插件管理Studio依赖的eclipse版本由产品管理部确定(目前为3.7.2)，由bundle管理员管理，所有套件必须完全支持在该版本eclipse上运行。第3方公共插件(需注意其license)定义：公共插件是能够完成某些特定功能的插件集合，如：subclipse，m2e，ADT，egit等。公共插件不会被公司产品大量引用，是对studio的功能补充。管理bundle管理员建立公共插件库，由其维护管理。产品需要向公共插件库添加或升级版本时，请向管理员申请，由管理员先择合适的版本维护到公共插件库中，并做好备案。打包构建studio打包构建阶段，从公共插件库中下载并打包到目标安装盘。四、私有jar包使用规范说明：私有jar是公司产品中的jar包或其他商业公司的jar包，该类jar不会被bundle大量引用。允许以jar形式打包到目标bundle中。1个以上bundle依赖的jar必须由bundle管理员改造成bundle进行引用(如果多个套件中的bundle会引用同一个私有jar，管理员需考虑是否纳入到studio_common中)。五、Bundle依赖引用规范导入采用Import-Package优先原则，如果无特殊情况，不要采用Require-Bundle建立依赖关系。导出禁止导出第3方jar包的package。禁止将整个bundle的package全部导出，应只导出需要共享的package，package中对外不需要可见的Class采用Include exclude进行过滤package导出时如果存在依赖，请添另uses:=进行约束六、Bundle划分规范spi - 接口和抽象层 – 建议但