概述
-
《Java 开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，他旨在提升开发效率和代码质量
-
《Java 开发手册》是一本极具价值的 Java 开发规范指南，对于提升开发者的综合素质和代码质量具有重要意义
-
学习《Java 开发手册》是一个提升 Java 编程技能、了解行业最佳实践和规范的好方法
编程规约 - 命名风格 P17
1、基本介绍
- 接口和实现类的命名有两套规则
-
【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。
- 正例：CacheServiceImpl 实现 CacheService 接口。
-
【推荐】如果是形容能力的接口名称，取对应的形容词为接口名（通常是 –able 的形容词）。
- 正例：AbstractTranslator 实现 Translatable 接口。
2、学习补充
（1）Service 类命名规则
- Service 接口
public interface CacheService {void put(String key, Object value);Object get(String key);void delete(String key);
}
- Service 实现类
public class CacheServiceImpl implements CacheService {@Overridepublic void put(String key, Object value) {// 实现缓存存储逻辑}@Overridepublic Object get(String key) {// 实现缓存获取逻辑return null;}@Overridepublic void delete(String key) {// 实现缓存删除逻辑}
}
（2）DAO 类命名规则
public interface UserDAO {User getUserById(Long id);void saveUser(User user);
}
public class UserDAOImpl implements UserDAO {@Overridepublic User getUserById(Long id) {// 实现数据库查询逻辑return null;}@Overridepublic void saveUser(User user) {// 实现数据库保存逻辑}
}
（3）形容能力的接口命名规则
- Searchable 接口，任何实现了它的类都必须提供 search 方法的具体实现，这表明该类具备根据查询字符串搜索内容的能力
public interface Searchable {List<String> search(String query);
}
- Searchable 实现类
public class BookRepository implements Searchable {private List<String> books;public BookRepository() {books = new ArrayList<>();books.add("三国演义");books.add("水浒传");books.add("西游记");books.add("红楼梦");}@Overridepublic List<String> search(String query) {List<String> results = new ArrayList<>();for (String book : books) {if (book.toLowerCase().contains(query.toLowerCase())) {results.add(book);}}return results;}
}
（4）Java 中常见的形容能力的接口
-
Serializable：表示一个对象可以被序列化
- 应用场景：在需要将对象的状态保存到磁盘或通过网络传输对象时，可以使用实现了 Serializable 接口的对象
-
Comparable：表示一个对象可以与其他对象进行比较。
- 应用场景：在实现排序算法或需要将对象放入有序集合时（例如，TreeSet、TreeMap），可以使用实现了 Comparable 接口的对象
-
Cloneable：表示一个对象可以被克隆
- 应用场景：在需要创建对象的深拷贝时，可以使用实现了 Cloneable 接口的对象，并通过调用 clone 方法来创建副本
-
Iterable：表示一个对象可以支持迭代操作
- 应用场景：在实现自定义集合类时，可以让该类实现 Iterable 接口，以便能够使用增强的 for 循环来遍历集合中的元素
-
Callable：表示一个任务可以异步执行，并且可以返回结果或抛出异常
- 应用场景：在并发编程时，可以使用实现了 Callable 接口的任务，并通过 ExecutorService 来异步执行这些任务
-
Runnable：表示一个任务可以被线程执行
- 应用场景：在实现多线程程序时，可以让一个类实现 Runnable 接口，并将其实例作为线程的目标对象来运行
编程规约 - 命名风格 P18
1、基本介绍
-
【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开
-
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有
-
正例：枚举名字为 ProcessStatusEnum，成员名称为 SUCCESS、
UNKNOWN_REASON
2、学习补充
-
枚举类名应该以 Enum 作为后缀，有助于代码的清晰表达
-
枚举成员（即枚举常量）的名称应该全部大写，并使用下划线来分隔，这是 Java 中表示常量的常见约定
public enum WeekdayEnum {MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY
}
public enum SeasonEnum {SPRING,SUMMER,AUTUMN,WINTER
}