在成为大神之前，请先苛刻的要求自己

2019年4月23日 159次阅读 来源: 慕凌峰

一、前言

俗话说，细节决定成败，每个成功的人，除了天赋，其实更重要的，是毅力，是对自己近乎苛刻的要求，而这种要求，能够让你更加快速的前行，避免前行道路上的很多弯路。

  • 作为一个技术开发人员，规范化的要求自己，显得更加的重要与迫切：

    • 软件开发是一门工程学科

    由于软件行业的特殊性，即它的工程性，对于规范的要求，就更高一层了，只有完整性、细节性等各方面的严格把控，才能让这个工程更加稳定，bug率更少。（你要没有这样要求过自己，在一天、一周、甚至一个月内，零bug，有这样的魄力吗？）

    • 技术创新、更新、淘汰速度急快

    估计每一个软件开发者都很清楚，在信息化技术飞速发展的当代，一门技术的更新、发展、以及淘汰整个周期是很短很短的，而一门又一门新的技术问世的速度，确实及其的惊人，此时，对于每一个软件开发者来说，都是一种极大的挑战，而这种挑战，只会愈演愈烈，所以，如何快速的掌握一门新的技术，是一个软件开发者必备的能力，而好的习惯，即规范，则是处处相同的，只要沿着这条规范化的路前行，会在学习应用中少走好多弯路，更加快捷的前行。

二、代码开发规范

1、命名开发规范

  • 包名命名规范：

包，在java开发中是不可避免的，而好的包命名，会使得程序层次结构明确，让程序的可读性更好，团队协作也变得更加简单，而且，会使得项目的体系结构非常的明了易懂，让开发中可能因为交流以及理解偏差而导致的代码冗余性高、重用性差等问题得到很好的解决。除此只为，会让项目的整体架构层次清晰易懂。

命名方式推荐： 业务领域名.子系统名.层名（最好都采用标准的英文命名，切记中文拼音以及二义性词语命名）

  • SV、DAO、ACTION的类名命名规范

    ** 命名规范推荐：**以英文单词取名，首字母必须大写，多个英文单词以大写字母间隔，避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP。类名中不允许’_’、 ‘-‘等符号。

    • 1) SV接口和实现类命名规范

    接口类：xxxSV.java；
    实现类：xxxSVImpl.java

    • 2) DAO接口和实现类命名规范

    接口类：xxxDAO.java；
    实现类：xxxDAOImpl.java

    • 3) ACTION接口和实现类命名规范

    类名：xxxACTION.java

  • 参数的命名规范

    • 1） 基本类型的变量

基本类型有int、long、boolean、double、short、float在定义变量时，需要体现出基本对象是什么类型。

单个对象在定义的变量后加上基本类型首字母大写 : int abcI = 0 ; long abcL = 0L ;
数组对象在定义的变量后加上基本类型的首字母大写和大写的“S” ： int[] abcIS = {0,1} ; Long[] abcLS ={0L ,1L} ;

* **2）  单个变量命名规范**

> 直接将收字母小写，其他不变  

参数名称需要体现出属性代表的意义  ：“prodInstIdList”,此参数是个List，存放的是产品实例ID

StringBuffer prodInstIdStringBuffer = new StringBuffer();
String prodInstIdString = "";
List prodInstIdList = new ArrayList();
Set prodInstIdSet = new HashSet();
Map prodInstIdMap = new HashMap();

  • 3） 数组命名规范

    若定义类前有“I”，需要去除“I”后首字母小写；如果没有“I”，直接首字母小写。结尾统一使用小写“s”结尾。

    GbatchQurryParameterInfoBean[] gbatchQurryParameterInfoBeans = null;
    IgbatchQurryParameterInfoValue[] gbatchQurryParameterInfoValues = null;

  • 4） 类引用对象名称命名规范

    在方法中，如果使用到其他服务的方法，需要通过ServiceFactory.getService方法获取相应的对象。对象命名格式采用统一标准，接口类名去除“I”后首字母小写，具体如下：

    IOrderQuerySV orderQuerySV = (IOrderQuerySV)ServiceFactory.getService(IOrderQuerySV.class);

  • 5） 方法名称命名规范

    方法命名时，需要表明此方法的处理的功能，并且首字母小写。例如：dealXml，可以从方法名称看出是处理XML报文的方法。
    表的操作方法需要体现出操作类型

    I、 单个和批量保存方法
    例如：saveBean/saveBeans
    II、 查询方法
    例如：queryBeansByMap 不要用getBeansByMap
    III、 更新方法
    例如：updateBean
    IV、 删除方法
    例如：deleteBean

2、格式规范

  • TAB空格的数量。编辑器上的TAB空格数量统一取值为4；

  • 换行， 每行120字符；

  • if语句的嵌套层数3层以内。If和else if、else 配合使用时，如果超过三个，改成switch…case…实现；

  • 匿名内部类20行以内，太长的匿名内部类影响代码可读性，建议重构为命名的（普通）内部类；

  • 文件长度2000行以内；

  • 方法长度150行以内；

  • 逻辑上相关序代码与其前后之程序代码间应以空白行加以分隔；在注释段与程序段、以及不同程序段插入空行。提高可读性；

  • 方法（构造器）参数在5个以内 ，太多的方法（构造器）参数影响代码可读性。考虑用值对象代替这些参数或重新设计；

  • 布尔表达式中的布尔运算符(&&,||)的个数每行不超过3个，超过3个，可以“&&，||”打头换行；

  • if和for、while等关键字的排版规范：

    关键字后需要以空格隔开，if、for、while后面包含的内容需要用“{}”包括

  • 代码禁止使用“Ctrl+Shift+F”进行(如果自定义了长度之后，按照个人习惯，可以很好的使用);

3、调用规范

《在成为大神之前，请先苛刻的要求自己》 一般调用层次图

4、异常抛出规范

  • 在SV层方法中原则上不允许捕获异常，先抛出Exception，再抛出RemoteException异常（如果涉及RemoteException异常）。

  • 在DAO层方法中原则上不允许捕获异常，只需要抛出Exception异常。

  • 在WEB层不允许抛出异常，必须捕获，包含在JSP、ACTION等中。

  • 当捕获异常之后，严谨再次抛出异常，因为这样会隐藏真正异常的位置，导致查找问题难度增加。

5、日志打印规范

常用的文本日志，采用的Log文本日志类，在调用方式上采用统一的格式规范，下面将给出如何定义对象，如果打印日志

  • 定义类属性对象，并且是静态最终不可修改对象；
private static final Log log = LogFactory.getLog(FixNetSmsSVImpl.class);
  • 调用时，需要注意需要判断是否是此级别的日志，如果不是，不要进入打印方法，提高调用效率。
if (log.isErrorEnabled()) {
log.error("根据策划实例ID：" + offerInstId + " 、用户编号：" + memInsUserValue.getUserId() + " 产品实例数据有误！");
}

6、sql变量绑定

  • 代码开发时对于可使用绑定变量的SQL必须使用绑定变量，对于特殊SQL，如使用IN(1,2,3)方式的，采用判断IN的数量，对于小于5个值的，也全部使用绑定变量，以减少数据库硬解析（硬解析容易产生大量的HARD PARSE，并造成library cache pin等待，对数据库性能造成影响），从而提高处理性能。

  • 对于SQL中的使用到的表字段，如字段在ivalue类中定义，必须使用ivalue类中的定义，避免直接使用字段名的情况，以在表结构变更时能够快速的定位到影响到的代码，增强程序的可维护性。

备注：SQL使用IN时，IN的参数如果非表关联查询时，参数最大值是1000，超过1000会出现错误。

7、对象判断

  • 数据对象是否为空判断方法
String[] bbb = null;
if ( null == bbb || bbb.length < 1 )
  • 单个对象判断是否为空方法
if ( null == aaa || "".equals(aaa) )
  • 对象比较

基本类型使用“==”，其他的类对象比较使用equals

    原文作者：慕凌峰
    原文地址: https://www.jianshu.com/p/1e32c890d439
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞