编码规范详细说明v1详解

1、4J代码规范性能级别规范对潜在的业务级异常捕获处理打印日志，参照spring源代码controller或service层需要数据校验，确保系统安全，具体在哪一层校验需确认业务处理代码只能出现于service层，确保事务安全与mvc结构清晰，如jsp, controller都不能有严禁循环中连接数据库，确保一次请求不产生过多的数据库连接使用sql直接进行统计查询等业务复杂度较低的操作，确保java代码的可读性与java内存性能业务复杂的操作会涉及到多次数据库连接，包括多表查询，更新等，这种情况尽量避免，可以将部分业务合并在一个sql中，或者使用存储过程sql语句避免直接使用“ *”，除非在外层语

2、句不允许单一的 count 语句使用 orderby , limit , count(*)查询时分组、排序、条件、结果字段影响效率时，应该跟组长或DBA讨论是否需要建立索引Java代码不允许sql参数字符拼接方式，必须使用预编译方式(除非参数绝对不发生变化)，确保数据安全与查询效率表间关联字段类型一致，确保索引不会失效mysql中没有函数索引，所以查询时尽量不要有索引列的函数，如 substr(create_date, 1,6) = substr(20110728, 1,6)实质是等于某月改写为create _date =to_char(last_day(add_months(to_date(

3、20110728,yyyymmdd),-1) + 1,yyyymmdd)and create _date 版本也就是说，如果文档标题中，即有主题与补充时，应该先写主题，再写补充。以此类推。更新包要尽量做到只更新有效的文件，别什么都往里放开发注意事项希望删除项目中的文件时，一定要在eclipse中进行，不要在外面删除，在外面删除会导致版本库同步失败不要经常去在eclipse中部署应用，正常的开发，一年都不用去部署一次，只要第一次部署后，后面跟SVN同步，然后页面不显示直接整体刷新工程，或者清除tomcat缓存。 而重新部署则会导致一些代码的丢失请务必使用Dreamweaver编辑网页文件、JS文

4、件，不要直接在 eclipse中编辑。因为在 DW中编辑，可以更有效的保证网页的设计视图不会代码 破坏！在使用 DW编辑时，可以使用 DW的同步功能，将项目指向eclipse主工程，同时同步到 tomcat中。这样修改了文件，2边都会进行修改添加、修改、注释代码注释包括复杂逻辑代码段、业务代码段、不容易理解的变量、方法、类在原有的代码基础上添加某一个方法或者某一段代码，除了要写上代码的注释外还有把添加人以及当前的日期写上；除此之外还要写上添加这 段代码或者方法的目的。在原有的代码中修改某一个方法或者某一段代码，除了要写上代码的注释外还有把修改人以及当前的修改日期写上；除此之外还要写上修改这 段

5、代码或者方法的目的。在原有的代码中发现有错误或者是与当前的代码不吻合，不要把别人的代码删除了。可以注释，注释后要写上当前日期以及注释人和注释的目 的。所有页面JS，都尽量写在页面的上部，并且要写上完整的注释Xfunction pageInit()selectInit(SEX,$param.sex);selectInit(AGE,$param.age);selectInit(LOCAL_PROVINCE,$vince);selectInit(LOCAL_CITY,$param.city);selectInit(LOCAL_COUNTRY,$param.country);document.getE

6、lementById(many).value = $param.many; 改进 建议JS放到卜面，其它人下次找 BUG寸很容易忽略此处的代码V移至head区域整洁的代码定义有意义的变量名、方法名，做到望文生义，一目了然。杜绝 int id1 = 0； public String init()之类的代码。id1和init()都不能告诉读者这 是干嘛用的命名类，方法，变量慎用简写，除非大家都公认，而且名字尽量包含业务信息而不是逻辑概念，如返回人员列表时，使用userList而不是result禁止大段的、层次过深的if-else代码。每段if语句块一屏之内必须结束。不能出现超过 3层白if判断。每

7、个方法尽量只做一件事，杜绝瑞士军刀式的方法，方法有很多功能，但是用法复杂，并且大多数人不知道怎么用。不要通过传type的方法让一个方法有两种功能。如果确实需要，则要在此方法之上重构几个方法，分别实现type参数的意义，例如:public void setQueueState(intID,int STATE) throws DataAccessException / 设置状态public void setQueueStateFail(int ID) /设置失败状态 STATE=-1public void setQueueStateSuccess(int ID)设置成功状态 STATE=1读者在实

8、际调用的时彳II不需要去理会STATE参数的含义，通过方法名即可直达此方法的含义。杜2b boolean型参数的方法，如果确实需要则必须重构，表明此 boolean 参数的含义。不要在思考此参数的含义上花费时间。没用的代码段不要注释，直接删除。我们有版本控制，不需要注释保留代码代码中不要乱换行。换行的意思是隔断不同语义的代码，合理的换行可以帮助读者理解你的代码，不合理的则会帮倒忙。例如：private void exeMultiHtmlCache(HttpSetvletRequest request, HttpServletResponse tesponse) throws DataAcces

9、sExceptionHtmlQueueBean bean = new HtmlQueueBean ();Collection queueCol 1 = tiean. getQueueList () ; /待静态化的页面信息集K静态化成功的队列工DCollection successQueueIdList. - new ArrayL 1st.();if(null=queueCol1) return ;设置队列的状态为正在进行beanisetQueueStateBusy(queueColl);执行静态化Iterator it = queueColl,iterator();while(it . hasWext() ) HtmlQueueVO VO = tHtmlQueueVO) it. next ();待静强化的页面信息V。执行静态化 返回成功的队列工int id = cacheHtml(request response,VO);记录成功的ID集合if(id0successQueueIdList.add(id):bean,delQueueByldList (successQueueldList) ;，/删除已经成功静态化的反列每一步操作之间换行，增加方法的步骤感觉写清晰、合理、不废话、不误导的注释在代码中发