Javashop开发规范v2..doc

Javashop开发规范V2.2版本说明提交人V1.0初稿定义了包名、异常、事务、和路径的规范王峰V2.01. 重新整理了命名规范2. 增加常用命词对照表王峰V2.11. 增加数据库操作的说明2. 增加常用方法介绍王峰V2.2增加关于数据导入导出的说明王峰1 命名规范1.1 包命1. 小写字母2. 以com.enation.javashop开头3. 组件以poent开头1.2 类名一、 action以Action结尾，如：UserAction二、 业务类1.接口：以I开头，以Manager结尾，如：IUserManager2.实现类以Manager结尾，如:UserManager三、 组件类以Component结尾，如：ShopEmailComponent四、 挂件类以Widget结尾，如：MemberAddressWidget五、 插件类以Plugin结尾，如：SendRegMailPlugin1.3 变量/属性命名规则1. 全部小写2. 可用下划线连接如：username、 userid1.4 方法命名1.4.1 Action类add到添加页edit到修改页saveAdd保存添加saveEdit保存修改delete删除list列表1.4.2 业务类add添加edit修改delete删除list列表get读取详细2 数据库开发规范2.1 数据操作支持类一、 业务类数据库调用1.继承于BaseSupport2.在spring文件中声明parent为baseSupport3.通过this.baseDaoSupport操作数据库实际使用的是：com.enation.eop.sdk.database.BaseJdbcDaoSupport此种操作示例：com.enation.javashop.core.service.impl.BrandManager注意事项：见【BaseDaoSupport的意义和存在的问题】二、 直接声明baseDaoSupport操作数据库在一些挂件类中或某些特殊情况，可以直接需要直接声明baseDaoSupport此种操作示例：com.enation.javashop.core.service.impl.batchimport.GoodsSpecImporter注意事项：见【BaseDaoSupport的意义和存在的问题】2.2 BaseDaoSupport的意义存在的问题 BaseDaoSupport对JdbcDaoSupport进行包装，通过 baseDBRouter 获取表名，为什么要通过 baseDBRouter 来获取表名呢？Eop机制是支持SAAS（多租户）模式运行的，在SAAS会为每个用户提供如:es_goods_这样的表。为了保证在单机版和SAAS模式中都运行正常，BaseDaoSupport将过滤sql中的相应表名。但目前还只能支持简单的单表select、insert、update，对于多表的联合查询或更新不能支持。在这种情况下，就需要通过daoSupport（com.enation.framework.database.impl.JdbcDaoSupport）来操作，daoSupport不对sql进行任何更改，这时为了保证兼容saas模式兼容性，就要使用BaseSupport.getTableName(String tablename)方法或baseDBRouter.getTableName(String tablename);来保证表名的正确。（够混乱？真心希望出现一位大侠拯救这个状况，使basedaosupport可以处理所有情况的sql）2.3 实体Bean和数据库表对照Javahop数据库操作支持，将对象直接保存或修改，如：this.baseDaoSupport.insert(brand, brand);this.baseDaoSupport.update(brand, brand, brand_id=+ brand.getBrand_id();规则为：实体中的属性名和数据库表的字段名相同，如：对应的数据库字段：2.4 注解的使用2.4.1 NotDbField在某个实体Bean中，我们可能会有一些属性不对应数据库字段，这时我们需要在相应的Geter方法中加上NotDbField注解，以便使数据库机制知道这个字段不转为sql语句，如： private File file;NotDbFieldpublic File getFile() return file;2.4.2 PrimaryKeyField在实合格bean和数据库对照过程中，数据库机制需要识别主键，所以需要我们在主键的对应属性的Geter方法中加上PrimaryKeyFiled注解，如： private Integer brand_idPrimaryKeyFieldpublic Integer getBrand_id() return brand_id;3 数据导入3.1 导入接口DBSolutionFactory.dbImport(file:com/enation/javashop/component/coupon/add.xml,es_);3.2 数据Xml文件说明3.2.1 创建表createtablenameidint811namevarchar255003.2.2 删除表droptablename3.2.3 添加、删除列altergoodsisgroupbuyint10isgroup3.2.4 创建索引indexgoodsgoodsid 3.2.5 删除索引unindexgoodsgoodsid 3.2.6 插入数据insertes_adcolumnacid,cname,width,height,atype,disabled5,列表页上部横幅,972px,67px,0,false3.2.7 删除数据暂未支持3.2.8 更新数据暂未支持3.3 数据类型对照表xmlMysqlOracle SqlServerintintNUMBERsmallintint(1)smallint(1)NUMBER(2)intmemotextCLOBtextdatetimedatetimeTIMESTAMPdatetimelongbigintNUMBERbigintdecimaldecimalNUMBER(20,2)decimal4 数据导出String tables = new String1;tables0 = es_auth_action;DBSolutionFactory.dbExport(tables, false, )5 常用方法介绍5.1 上下文获取参见：/developer_help/index.php/常用方法5.2 地区联动下拉框1.如果是在jsp 中：2. 如果是在Freemarker的html中:以上两种方式均支持以下参数：province_id：省idcity_id:市idregion_id:区id如果指定上述参数，则默认选中6 常用字典对照表6.1 常用值名称值说明返回结果0：失败1：成功适用于：1. 客户端json返回值2. 服务器端方法返回值3. 数据库是否的标识值性别0：女1：男6.2 常用名称名称英文商品goods货品product规格spec订单order会员member积分point购物车cart结算checkout订单order品牌brand分类cat优惠劵coupon支付payment团购groupbuy虚拟virtual发票receipt属性prop参数param标签tag地区region7 异常1. 提供统一的异常处理机制2. 底层级别的类不处理异常，只管向上抛出异常，且统一抛出RuntimeExcepton8 事务处理1. 数据库统一使用Srping AOP事务2. 采用注解方