阿里代码规范

命名风格

代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束.
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：DO / BO / DTO / VO / AO
方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
中括号是数组类型的一部分，数组定义如下：String[] args;
包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
杜绝完全不规范的缩写，避免望文不知义。
如果使用到了设计模式，建议在类名中体现出具体模式。
接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
接口和实现类的命名有两套规则：
- 对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部

的实现类用 Impl 的后缀与接口区别。

- 如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。

枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

常量定义

不允许任何魔法值（即未经定义的常量）直接出现在代码中。
long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字1 混淆，造成误解。
不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts 下；系统配置相关的常量放在类：ConfigConsts 下。
常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

1）跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2）应用内共享常量：放置在一方库的 modules 中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位程序员在两个类中分别定义了表示

“是”的变量：

类 A 中：public static final String YES = "yes"; 

类 B 中：public static final String YES = "y"; 
A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

3）子工程内部共享常量：即在当前子工程的 constant 目录下。

4）包内共享常量：即在当前包下单独的 constant 目录下。

5）类内共享常量：直接在类内部 private static final 定义。阿里巴巴 Java 开发手册

如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面

代码格式

大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：

1）左大括号前不换行。

2）左大括号后换行。

3）右大括号前换行。

4）右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
if/for/while/switch/do 等保留字与括号之间都必须加空格。
任何二目、三目运算符的左右两边都需要加一个空格。

说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

缩进采用 4 个空格，禁止使用 tab 字符。

说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2）运算符与下文一起换行。

3）方法调用的点符号与下文一起换行。

4）在多个参数超长，在逗号后换行。

5）在括号前不要换行，见反例。
方法参数在定义和传入时，多个参数逗号后边必须加空格。
IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 windows 格式。

集合处理

关于 hashCode 和 equals 的处理，遵循如下规则：

1）只要重写 equals，就必须重写 hashCode。

2）因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。

3）如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals。

说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。

ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException
在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生 ConcurrentModificationException 异常。
使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。
使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
泛型通配符来接收返回的数据，此写法的泛型集合不能使用 add 方法，而不能使用 get 方法，做为接口调用赋值时易出错。
不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。
在 JDK7 版本及以上，Comparator 要满足如下三个条件，不然 Arrays.sort，Collections.sort 会报 IllegalArgumentException 异常。

注释规约

类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用//xxx 方式。

说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

所有的类都必须添加创建者和创建日期。
方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
所有的枚举类型字段必须要有注释，说明每个数据项的用途。

数学之美第九章

看完这章之后，对图论有了更好的理解，了解了它在实际应用方面的一些功能。回顾了上学期的图论部分知识。

图论在爬虫的应用上其到了重要作用。广度优先遍历和深度优先遍历对网页的搜索起到了巨大的作用。在这过程中，队列对网页的加载也使其有序。同时对网页的去重分析，也有重要的作用。散列表大大加快了遍历的速度。其难点在于对散列表的维护。在这方面采用下载服务器的分工以及对URL判断的批处理

posted on 2021-09-13 22:42 夜深楼鼓阅读(43) 评论(0) 收藏举报

刷新页面返回顶部

算法第一次作业