UAP-Studio插件开发规范15-精品文档资料.docx

《UAP-Studio插件开发规范15-精品文档资料.docx》由会员分享，可在线阅读，更多相关《UAP-Studio插件开发规范15-精品文档资料.docx（5页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、UAP-Studio 插件开发规范V1.5UAPJAVA应用平台开发部2013-11-20适用范围：所有UAP-Studio套件(MDE、MOB、ESB、MDP、TEST、WEB)及后续新增套件一、命名规范 Bundle和Fragment命名规范com.yonyou.studio.submodulebundle名称全小写，与标准的eclipse bundle命名习惯统一Bundle版本：.qualifier-Stringqualifier-String不允许使用“qualifier”代替类似“20130812”的当前时间戳，如果需要时间戳，请手工维护。注意，eclipse创建bundle时会自

2、动添加“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.RELEASE Feature命名规范com.yonyou

3、.studio.name.feature示例：com.yonyou.studio.ria.feature 必须以feature结尾com.yonyou.studio.ria.template.feature 多语fragment命名规范.nl_示例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方bundl

4、e库(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包，如要必须修改，由管

5、理员进行分析和修改制作成bundle，并做好备案。三、Eclipse版本和公共插件管理1. Studio依赖的eclipse版本由产品管理部确定(目前为3.7.2)，由bundle管理员管理，所有套件必须完全支持在该版本eclipse上运行。2. 第3方公共插件(需注意其license)a. 定义：公共插件是能够完成某些特定功能的插件集合，如：subclipse，m2e，ADT，egit等。公共插件不会被公司产品大量引用，是对studio的功能补充。b. 管理 bundle管理员建立公共插件库，由其维护管理。 产品需要向公共插件库添加或升级版本时，请向管理员申请，由管理员先择合适的版本维护到公

6、共插件库中，并做好备案。c. 打包构建studio打包构建阶段，从公共插件库中下载并打包到目标安装盘。四、私有jar包使用规范说明：私有jar是公司产品中的jar包或其他商业公司的jar包，该类jar不会被bundle大量引用。1. 允许以jar形式打包到目标bundle中。2. 1个以上bundle依赖的jar必须由bundle管理员改造成bundle进行引用(如果多个套件中的bundle会引用同一个私有jar，管理员需考虑是否纳入到studio_common中)。五、Bundle依赖引用规范1. 导入采用Import-Package优先原则，如果无特殊情况，不要采用Require-Bund

7、le建立依赖关系。2. 导出禁止导出第3方jar包的package。禁止将整个bundle的package全部导出，应只导出需要共享的package，package中对外不需要可见的Class采用Include exclude进行过滤package导出时如果存在依赖，请添另uses:=进行约束六、Bundle划分规范 spi - 接口和抽象层 建议但不强制 impl - 实现层 建议 ui - 如果存在ui，应划分成独立bundle model - 业务模型 解析器 - 如：元数据解析器，模型解析器。 帮助系统示例：com.yonyou.studio.ria.template.spicom.y

8、onyou.studio.ria.template.modelcom.yonyou.studio.ria.template.ui.editorcom.yonyou.studio.ria.template.readercom.yonyou.studio.ria.template.help七、Project(工程源代码)组织规范bundle放到plugins目录feature放到features目录示例studio_riadevtool/pluginscom.yonyou.studio.ria.template.uicom.yonyou.studio.ria.template.editorstud

9、io_riadevtool/featurescom.yonyou.studio.ria.feature八、OSGi Service使用规范共享的service必须以OSGi Service或ds形式提供给其他Bundle(blueprint需要额外框架，暂不支持)采用ServiceTracker跟踪和获取Service，不要在bundle start过程中直接getService无特殊情况，禁止以具体类名注册OSGi Service，应采用Interface或Abstract Class类名注册。九、bundle国际化规范1. bundle中只允许包含不带locale后缀的资源文件，且文件内容

10、必须为英文。如：messages.properties。2. 外部化的字符串必须以占位符形式提供完整有意义的语句。如：id + id + not found.，应改成：String.format(id %s not found., id)或MessageFormat.format(id 0 not found., id)3. 外部化的字符串key建议改成有意义的单词，全小写，以“.”分割，最好不要使用工具自动生成的0,1形式。如：editor.title=Template Editor4. 特定语言的多语文件应根据“多语fragment命名规范”为bundle创建对应的语言包并将多语文件(me

11、ssages.properties)放到对应的语言包中。备注：“多语fragment”由构建系统自动生成，不用手工建立。5. 语言包只包含多语资源及MANIFEST.MF等翻译相关资源，不允许放与多语无关的任何资源。6. 对于源代多语文件必须遵守以下任意一条规则a) 文件名是messages.properties且必须放在源码目录。b) bundle/nls/*/*.properties并且添加到源码目录。bundle MANFEST.MF、plugin.xml建议使用以下规则OSGI-INF/l10n/bundle.properties7. 国际化包括界面显示内容(按钮、菜单，Label及其

12、他界面控件，控制台输出)等，要求功能设计时考虑好相应结构，有效值应与显示文本无关，用户输入的内容及根据数据库或其他数据源动态生成的界面不要求完全实现国际化。举例：a) 可枚举ComboBox，每项应设计为value=text形式，value为实际有效值，text应根据语言环境显示相应的文本。该规则同样适用于其他控件(tree、table等)。b) 不可枚举ComboBox，每项内容来源于数据库或其他数据源，该类情况如果其提供翻译接口，应使用其接口进行翻译实现国际化，如果没有提供接口则显示其原文。该规则同样适用于其他控件(tree、table等)。十、警告、错误和日志studio所有套件应使用统

13、一的提示方式，建议如下： 编辑器：所有警告、错误应在问题视图(problems)显示，在保存或构建时进行检查。 编辑器保存提示：不允许显示“保成成功”类似提示信息，没报错就代表成功。 其他提示：如果某一类提示经常出现，应提供“不再显示xxx提示信息”复选功框。 发布进度：发布进度应该显示进度，如果成功发成，对话框正常关闭，否则显示错误提示对话框。 日志：禁止使用System.out、System.err输出日志内容，禁止调用e.printStackTrace()，所有出错信息都采用eclipse的log机制进行记录，不允许使用其他日志框架(log4j、slf4j等)。十一、UAP Home当U

14、AP Home发布新版时，Studio处理流程如下： Studio测试部向各个Studio套件负责人发送UAP Home更新通知。 Studio套件负责人进行风险和工作量评估由开发人员做出相应修改，经过基本验证后提交。 Studio测试部从构建系统获取安装盘进行验证。十二、其他Bundle、Fragment、Feature项目文件夹名必须与Bundle Symbolic Name保持完全一致每个Bundle源代码包含README，内容为Bundle的功能描述、环境说明及其他备注信息，该文件打包时不被包含，主要用于方便开发人员了解模块功能、关系、约束。术语bsn：Bundle Symbolic Namehostbsn: Host Bundle Symbolic Name