编码规范详细说明_v1范例.doc

4J 代码规范 性能级别规范 对潜在的业务级异常捕获处理打印日志，参照spring源代码? controller或service层需要数据校验，确保系统安全，具体在哪一层校验需确认? 业务处理代码只能出现于service层，确保事务安全与mvc结构清晰，如jsp，controller都不能有? 严禁循环中连接数据库，确保一次请求不产生过多的数据库连接? 使用sql直接进行统计查询等业务复杂度较低的操作，确保java代码的可读性与java内存性能? 业务复杂的操作会涉及到多次数据库连接，包括多表查询，更新等，这种情况尽量避免，可以将部分业务合并在一个sql中，或者使用存储过程? sql语句避免直接使用“*”，除非在外层语句? 不允许单一的count语句使用orderby，limit，count(*) 查询时分组、排序、条件、结果字段影响效率时，应该跟组长或DBA讨论是否需要建立索引 Java代码不允许sql参数字符拼接方式，必须使用预编译方式（除非参数绝对不发生变化），确保数据安全与查询效率 表间关联字段类型一致，确保索引不会失效 mysql中没有函数索引，所以查询时尽量不要有索引列的函数，如substr(create_date, 1, 6) = substr 1, 6) 实质是等于月 _date =to_char(last_day(add_months(to_dateyyyymmdd),-1)) + 1,yyyymmdd) and?create _date?=?该月最后一天 编写sql时避免大表的全表扫描，尽量走索引，正确使用left join,right join,join对数据和效率影响 代码基本规范 数据库所有字段都为大写，单词之间用_分隔 在所有JSP、JAVA代码中，如果是一个数据库字段对应的变量，则名称和数据库字段名称相同 在JAVA、JSP中，除了与数据库字段对应的变量以外的所有变量，都以小写字母开头驼峰式命名，变量中各单词之间不要空格，不要有其它字母，例如 helloWorld 是正确的 HelloWorld 、hello_world 这些都是错误的。 代码提交到SVN时，在提交界面中，请写清修改的原因、事项 在处理日期型的数据字段时，注意不要随意书写，要兼容ORACLE的写法 在使用GROUP BY语句的时候，要注册兼容ORACLE的写法 凡是牵扯到数据持久化的代码都要封装到dao层，切不可以在bean或者其他的层中写操作数据库的代码。 代码书写原则 JSP页面中，尽可能不写或者少写JAVA代码 所有JS代码，都写在JSP页面的上方 所有JSP代码、JS代码，都要写上完善的注释，因为这部分代码，会被经常改动。 文件命名规范 在日常与客户交流或者写文档时，请不要随意的写一个文档名称，随意的文档名称，会导致文档的无序、混乱，不易管理与查找。同时，在发与客户文档时，一个好的文档名称，也有助于客户理解与奠定好的客户印象。 文档、文件夹，命名的大体格式为： 日期_客户(可选)_主题_补充(可选)_版本(可选) 注意：各主题之间用下划线隔开 日期：两位年 两位月 两位日。 例如：101128 客户：主题：能够说清文档的主题、内容。 例如：解决不显示按钮的BUG。 首页设计。 测试报告 补充：对特殊事宜的补充说明。 例如：更新了首页。 增加了栏目页面。 。 1024分辨率。 WEBSPHERE。 ORACLE。 版本：定义系列事件的版本，如2.1，大变化个位加一，小变化小数加一。 文档名称中的各数据，他们的优先级为： 日期 客户 主题 补充 版本 也就是说，如果文档标题中，即有主题与补充时，应该先写主题，再写补充。 以此类推。 更新包要尽量做到只更新有效的文件，别什么都往里放 开发注意事项 希望删除项目中的文件时，一定要在eclipse中进行，不要在外面删除，在外面删除会导致版本库同步失败 不要经常去在eclipse中部署应用，正常的开发，一年都不用去部署一次，只要第一次部署后，后面跟SVN同步，然后页面不显示直接整体刷新工程，或者清除tomcat缓存。 而重新部署则会导致一些代码的丢失 请务必使用Dreamweaver编辑网页文件、JS文件，不要直接在eclipse中编辑。因为在DW中编辑，可以更有效的保证网页的设计视图不会代码破坏！在使用DW编辑时，可以使用DW的同步功能，将项目指向eclipse主工程，同时同步到tomcat中。这样修改了文件，2边都会进行修改 添加、修改、注释代码 注释包括复杂逻辑代码段、业务代码段、不容易理解的变量、方法、类 在原有的代码基础上添加某一个