插件使用指南.doc

1 “代理组件生成工具”使用指南 2 目录 “代理组件生成工具代理组件生成工具”使用指南使用指南.1 1.安装.3 2.使用.3 2.1.设置 NCHOME.3 2.2.新建 Module Project.4 2.3.转换工程 Module Project.4 2.4.使用工具生成代码.5 2.5.注意事项.6 3 1.安装 本生成工具是一个 Eclipse 插件，因此它的安装和普通的 Eclipse 插件安装完全相同。 把 plugins 目录下的所有插件包拷贝到 Eclipse 安装目录下的 plugins 目录下，如果升级插件， 请把原插件删除再拷贝新插件，同时删除 Eclipse 安装目录下 configuration 目录中的内容， 保留 config.ini。 本工具需要安装两套插件，一套是 MDE 基础插件（插件包名：nc.uap.mde_1.0.0） ； 另一套是 MDE 多页面编辑器插件（插件包名： nc.uap.mde.core_1.0.0，nc.uap.mde.editor_1.0.0，nc.uap.mde.framework_1.0.0） ，其中代理组 件生成工具即是该编辑器插件的一部分。 安装完后，打开一个工作空间。打开：窗口 打开透视图 其他，显示如下视图： 可以看到有两个透视图:MDE Development，MDE 编辑器透视图。 如果能看到这两个透视图就说明你的插件安装成功了。 2.使用 2.1.设置 NCHOME 及 design 数据源 首先设置 NCHome： 打开：窗口 首选项，在左边的列表中选择 java MDE Development，在右边的界 面上设置 NC Home 路径(注意该路径必须为已存在路径)。 4 NCHome 文件下的目录结构还要遵循一定规则，即 NCHome 下一层目录是 modules 文 件夹，modules 文件下面是所有的模块文件夹，每个模块文件夹的命名以其内的 module.xml 的模块名来命名。模块文件夹下就是 META-INF 文件夹，META-INF 下包括了 本模块所有的配置文件（module.xml, *.module） ，其目录结构如下图，其中. ./NC_UAP_Modules 就是 NCHOME 的路径。 5 2.2.新建 Module Project 1.选择 MDE Developent 2.建立项目名称、模块名称、模块配置文件 6 3.新建的工程目录下有如下目录：src/public(模块的公共代码，整个系统公共的代码), src/private（接口的实现代码，模块的私有代码）,src/gen（系统生成的代码）, src/test（模块的测试代码） ，src/client（客户端代码）META-INF 7 4.如果 NC_HOME 下的类发生变化，请更新类路径 8 2.3.转换工程 Module Project 1.选择具体工程，进行转换(convert to Module Project) 2.设置模块名 9 打开 MDE Development 透视图，在该透视图下新建一个 Module Project，注意在建 Module Project 的时候会让你填写 Module Name（模块名） ，这时每个部门就可以定义按照设计的 规范（总体组的规划）定义自己的模块名，在配置文件下有 module.xml，该文件中定义自 己模块的名称， ，组件的配置文件不要在此写，他是一个总控文件， 如果其它工程的开发所在的模块都是该模块，那么他建立的配置文件应当是 xx.module。一 个 Module 工程建好后，工程下会有一个 META-INF 目录，该目录下会有在 Module.xml 命名的文件，同时还会有一个 NC_HOME 目录，一个新的模块名建好后，会在 NC_HOME 下生成相应的目录结构，之后所有以本模块名建的子工程的*.module 文件和主工程的 module.xml 文件都会拷贝一份到 NC_HOME 下的该模块名目录中去 。META-INF 目录下 的文件是工程(或叫项目)”私有”的,即你只关心 META-INF 目录下的文件;而 NC-HOME 目录 下的文件是随代码配套的配置文件，该目录并不是存在于工程目录下，它实际上是根据设 置的 NCHOME 路径连接到了文件系统的 NCHOME 目录的一个快捷方式。一个原则就是：一个原则就是： 只能修改工程下的只能修改工程下的 META-INF 目录下的文件，而不要去修改目录下的文件，而不要去修改 NCHOME 下的文件。下的文件。 配置文件是和代码同步，否则程序运行错误 2.4.使用工具生成代码 下面开始介绍如何通过本工具生成公共代理代码，本工具是从属于编辑器的，因此要使用 本工具就必须要先打开编辑器，打开编辑器的方式很简单。如下图所示： 10 双击工程下的 META-INF 下的*.module 或 module.xml 就可以打开 MDE 组件编辑器。如果 打开方式默认为其他编辑器，则可以在右键菜单中“打开方式”中选择 MDE 组件编辑器。 本编辑器一共有 3 页，公共代理生成工具就是“代理组件生成页面” ，下面介绍整个页面内 容。 代理公共组件名代理公共组件名:就是代理对外提供的名称,注意要以 nc.itf.包名开头. 组件代码生成路径组件代码生成路径:就是代理生成类的存放路径。本路径是 /src/gen。 事务事务:CMT, BMT, NONE 三种选择.默认 CMT 远程远程:默认选中 支持别名支持别名: 默认选中 单例单例: 默认选中 左边的待选列表是当前打开文件里的所有私有组件，即：之间的组件。 右边的选择列表是用户所要发布成公共代理组件的私有组件。 当界面都设置好后，点击“生成”按钮就可以生成代理 XML 文件和代理组件的代码。 如果生成成功，则会看到本工程内有三个地方发生变化。 1工程下的 META-INF 下多了一个文件，该文件的文件名是打开文件的文件名拼上” _proxy”。这个文件中记录了用户所选择的私有组件信息。 2NC_HOME/modules/META-INF/下也生成了这个文件的备份。 3在工程下 src/gen 下生成了两个 java 包，一个是 nc.itf，另一个是 nc,impl。这 两个 java 包就是最终要的公共代理组件的代码。 下图是生成成功后的效果： 11 2.5.注意事项 这里有几点要强调： 1.只能使用工程下的 META-INF 下的文件(一般都是*.module 文件)来生成代理组件， NC_HOME/modules/META-INF 下的文件不能用来生成代理组件。 2.打开的文件是一个 XML 文件，XML 文件中包含了多个组件，每个组件都有一个实现 类，即：。代理组件的生成要依靠所选私有组件的实现类及其该实现 类的接口和所依赖的其他类。因此要保证所选私有组件的实现类都要在本工作空间内 可见，并且它们的接口和依赖关系的类都要存在（即：这些实现类没有编译错误。 ） 。 3.每个 MDE 工程都有一个模块名（注：可以多个工程同模块名，因为一个模块对应多 个工程） 。每个工程下 META-INF 下的文件在 NC_HOME/modules/META- INF/下有一个备份。每当在工程下 META-INF 下生成一个文件都会自动在 NC_HOME/modules/META-INF/下生成一个同名文件，同样如果删除一个文 件，NC_HOME/modules/META-INF/下也会自动删除同名文件。 4.保证与当前工程同模块名的 NCHOME 下的/META-INF 下的所有文件所依赖的类和接 口都要在本工作空间内可见。 5.如果在生成过程中弹出标有”class not find”字样的提示框，请检查 NCHOME 下本模块 名下的文件所关联的类是否都在本工作空间内可见，并且要检查工程之间需要的引用 是否存在。 其中