Java开发手册笔记
2017-06-08 21:04
162 查看
1.方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式
正例:localValue / getHttpMessage() / inputUserId
疑惑: 什么是lowerCamelCase风格,什么是驼峰形式
2.接口类中的方法和属性不要加修饰符号(public也不要加),并加上有效的Javadoc注释
正例: void f();
疑惑:加与不加的区别在于哪,Javadoc注释规范是什么。
解惑“:
Javadoc注释
标记 用于 作用
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
3.对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方法产生影响。接口过多时必须加@Deprecated注解。
疑惑:什么是方法签名,什么是@Deprecated注解。
4.DO / DTO / VO 等POJO类时,不要设定任何属性默认值。
疑惑 : DO / DTO / VO 分别是什么。
5. java 类成员与方法访问控制从严
如果不允许外部直接通过new来创建对象,那么构造方法必须是private .
工具类不允许有public或default构造方法
(1) 类非static成员变量并且与子类共享,必须是protected
(2) 类非static成员变量并且仅在本类使用,必须是private
(3) 类static成员变量如果仅在本类使用,必须是private
(4)若是static成员变量,必须考虑是否为final
(3)类成员方法只供类内部调用,必须是private
(3)类成员方法只对继承类公开,那么限制为protected
说明:任何类、方法、参数、变量,严格控制访问范围,过宽泛的访问范围,不利于模块解耦,思考:如果是一个private的方法,想删除就删除,可是一个public的Service方法,或者一个public的成员变量,删除一下,不得手心冒点汗吗?变量就像自己的小孩,尽量在自己的视野内,变量作用域太大,如果无限制的到处跑,那么你会担心的。
正例:localValue / getHttpMessage() / inputUserId
疑惑: 什么是lowerCamelCase风格,什么是驼峰形式
2.接口类中的方法和属性不要加修饰符号(public也不要加),并加上有效的Javadoc注释
正例: void f();
疑惑:加与不加的区别在于哪,Javadoc注释规范是什么。
解惑“:
Javadoc注释
标记 用于 作用
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
3.对外暴露的接口签名,原则上不允许修改方法签名,避免对接口调用方法产生影响。接口过多时必须加@Deprecated注解。
疑惑:什么是方法签名,什么是@Deprecated注解。
4.DO / DTO / VO 等POJO类时,不要设定任何属性默认值。
疑惑 : DO / DTO / VO 分别是什么。
5. java 类成员与方法访问控制从严
工具类不允许有public或default构造方法
(1) 类非static成员变量并且与子类共享,必须是protected
(2) 类非static成员变量并且仅在本类使用,必须是private
(3) 类static成员变量如果仅在本类使用,必须是private
(4)若是static成员变量,必须考虑是否为final
(3)类成员方法只供类内部调用,必须是private
(3)类成员方法只对继承类公开,那么限制为protected
说明:任何类、方法、参数、变量,严格控制访问范围,过宽泛的访问范围,不利于模块解耦,思考:如果是一个private的方法,想删除就删除,可是一个public的Service方法,或者一个public的成员变量,删除一下,不得手心冒点汗吗?变量就像自己的小孩,尽量在自己的视野内,变量作用域太大,如果无限制的到处跑,那么你会担心的。
相关文章推荐
- JUC学习笔记--从阿里Java开发手册学习线程池的正确创建方法
- 阿里巴巴Java开发手册要点笔记 (一)
- Java开发手册整理笔记
- 阿里巴巴 Java 开发手册(笔记)
- 阿里巴巴Java开发手册与自己开发对照笔记
- 阿里巴巴Java开发手册学习笔记-编程规约
- 阿里巴巴 Java 开发手册 笔记及重点
- java swing开发学习笔记(1)
- Java开发学习笔记之一:JavaEE分层及客户层技术
- Java开发学习笔记之三:HTTP客户请求数据格式
- 开发笔记:创建Java线程的两种方法
- Java开发学习笔记之十:servlet事件
- Java开发学习笔记之十一:开始JSP之旅
- Java软件开发学习笔记(三)
- 很不错的JAVA学习笔记-Java基础-Java-编程开发
- Java Web应用快速开发平台OpenJWeb(v1.6)增删改查页面生成器操作手册
- 深入体验Java Web开发内幕-核心基础(看张孝祥的书的笔记一)
- Java开发学习笔记之二:一个简单的Servlet
- Java开发学习笔记之十二:JSP语法
- Java开发学习笔记之五:Servlet编程API