组件开发规范.docVIP

组件开发规范 1组件定义 2组件目录结构图 目录结构说明： .mip：运行mip init命令生成此目录； bin：存放CLASSES文件； db：存放数据库脚本； lib：存放组件需要的JAR包； META-INF/services：存放相关配置文件，比如spring、config、hbm及web.xml等； src：存放源代码； test：存放测试代码及配置文件； testGenerator：测试代码生成工具； testRunner：测试报告生成工具； web：存放jsp页面等。 备注：.mip、bin、testGenerator和testRunner不需要提交CVS，其他目录需要提交CVS。 3Spring Bean Id命名规范 组件名.类名(首字母小写)，比如：任务队列管理组件(contlisp.queue)中队列控制器类(TaskQueueController)对应的Bean命名为 contlisp.queue. taskQueueController 4Properties文件配置项命名规范 为了避免配置项命名冲突，统一风格，现命名规范： 组件名.配置项=value 比如：原task.delay.minutes=5 现contlisp.dta.statemgt.task.delay.minutes=5 5输出日志规范 统一使用common.log组件对log4j的封装(mon.log.Logger)； private static Logger logger = Logger.getInstance(Hello.class.getName()) 日志级别 INFO：便于测试和运维跟踪查看的信息，比如对文件的读写，业务逻辑的关键点等 DEBUG：便于研发跟踪调试的关键点 ERROR：异常出错 日志信息准确清晰易懂，能对以后的运维跟踪提供帮助，比如输出关键信息各种参数等。 6Spring文件装配原则 保持每个Spring文件功能独立性，文件分离，降低耦合度，便于单元测试； 避免Spring Bean的嵌套，增加文件可读性。 7组件开发流程 参考MIP新手上路之mip-shell安装准备开发环境； 从CVS上checkout组件； 进入组件目录，运行mip init命令，会生成.mip目录； 配置classpath路径； 代码开发； 参考MIP规范之基本模块装配配置文件； 修改testGenerator/build.xml，指定被测试类或被测试类所在包名 比如clazz name=com.onewaveinc.test.HelloBean.class/，运行build.xml，生成测试框架代码。 备注：以上为开发基本流程，具体请参考MIP新手上路及MIP规范。