JAVA代码规范指南.docVIP

模块命名规范 类文件命名规范 一个模块下会包含几个目录，action、service、domian，比如用户模块user下包含此三个目录，我们只包含以下几类代码： Action：响应页面请求的Action类，继承DefaultAction类。我们有两类Action，一类是支撑页面展现类的，以文件目录名命名，首字母大写，另外一类是支撑动作请求的，命名以Action结尾，放在某个action的目录下。 Service：服务类，被Action或者其他Service调用。命名以Service结尾，放在某个service目录下。 Domain：实体对象，命名以Domain结尾，继承PersistentObject，放在某个domian的目录下。 *_exp.xml的ibatis配置文件，命名以Domain名为前缀，比如S_userDomain_exp.xml，放在domain相同目录下。 ESB Service：ESB的服务类，继承DefaultService,命名以Service结尾。 小部分VO：以VO结尾，放在vo目录下，必须经过申请才能加vo，一般情况下，用Domain做为VO。 助手类，以Helper结尾，放在util目录下，需要经过申请，不允许随便建公共类，尤其是仅供个人使用的公共类。 属性函数命名规范 属性命名：命名以英文命名，常见命名包括id(主键，外键关联以_id结尾，比如dept_id,def_id)，name(名称，不同的名称命名可以以name结尾，比如dept_name,offer_name)，code(编码，不同的编码可以以code结尾，比如offer_code)， description(描述信息),sts(软删除，Y表示有效，N表示软删除),status(状态字段)，如果是日期，列表，MAP等类型，应当体现类型，比如create_date,userList,userMap。 函数命名：函数命名应当体现功能、参数、返回类型(可选)，比如queryUserInfoByName，queryUserListByArea，典型的功能前缀包括insert、update、delete、querry、do… 所有属性均为private，包含getset函数。属性与函数首字母小写。 Action中的属性应该大部分为对象，尽量不出现原始属性（int,Long,String等类型），比如分页类的属性，应当使用一个Page类。 页面文件命名规范 路径名、文件名都小写 一个模块的文件放在统一目录中，目录名与后台代码的模块目录名相同，比如user 典型文件命名input.html、edit.html、list.html、index.html，一般情况下文件名应该为单个名词，如果不是，则应该考虑是否应该增加文件目录，比如userindex.html，应该考虑增加一个user目录，下面放index.html。 数据库表结构命名规范 以统一的前缀开始，前缀名为模块名，比如wt_pay,wt_data,wt_gift 后缀典型命名_type，_def，_instance，_user，_dept，_prod 定义表与实例表对应，分别以def,instance结尾，比如wt_gift_def,wt_gift_instance。 表字段命名规范 我们只使用三种类型,number、varchar2、date(datetime)，特殊情况下允许使用clob类型，但是必须单独建表。 典型字段命名，id(主键，外键关联以_id结尾，比如dept_id,def_id)，name(名称，不同的名称命名可以以name结尾，比如dept_name,offer_name)，code(编码，不同的编码可以以code结尾，比如offer_code)， description(描述信息),sts(软删除，Y表示有效，N表示软删除),status(状态字段)，如果是日期，应当体现类型，比如create_date,modify_date。 一个标准的表应该包含以下字段，id(主键,number(12))，create_date(创建日期,date，取sysdate),modify_date(修改日期,date，取sysdate),client_ip(客户端ip,varchar2(64)),server_ip(服务器端ip,varchar2(64))，sts(软删除,varchar2(1)),status(可选，状态) SEO?规范 页面title、keywords、description等meta属性用变量，我们的地址系统里面会定义这些变量。 图片的alt属性需要定义，写图片相关信息 状态值规范 尽量不使用session、cookie来做状态，其他可选方式包括 页面传值、页面