首页 > 编程语言 >java基础学习笔记1

java基础学习笔记1

时间:2024-08-09 19:53:39浏览次数:11  
标签:正例 java 接口 反例 学习 笔记 使用 命名 public

Java编程规范

命名风格

1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

反例:_name / __name / $name / name_ / name$ / name__

2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更要避免采用。

正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。

反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3. 【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID 等。

正例:JavaServerlessPlatform / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例:javaserverlessplatform / UserDo / XMLService / TCPUDPDeal / TAPromotion

4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵 从驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字 长。 正例:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME 反例:MAX_COUNT / EXPIRED_TIME

6. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。

7. 【强制】类型与中括号紧挨相连来表示数组。 正例:定义整形数组 int[] arrayDemo; 反例:在 main 参数中,使用 String args[]来定义。

8. 【强制】POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起序列化错误。 说明:在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx 的命名方式,所以,需要在 设置从 is_xxx 到 xxx 的映射关系。

反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),RPC 框架在反向解 析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。 版本号 制定团队 更新日期 备注 1.5.0 阿里巴巴与 Java 社区开发者 2019.06.19 华山版,新增 21 条,修改描述 112 处 Java 开发手册 2/44

9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使 用单数形式,但是类名如果有复数含义,类名可以使用复数形式。 正例:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参考 spring 的框架结构)

10.【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命 名,使可读性降低。 说明:子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译,而局部变量在同一方法 内的不同代码块中同名也是合法的,但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员 变量名称相同。

反例: public class ConfusingName { public int age; // 非 setter/getter 的参数名称,不允许与本类成员变量同名 public void getData(String alibaba) { if(condition) { final int money = 531; // ... } for (int i = 0; i < 10; i++) { // 在同一方法体中,不允许与其它代码块中的 money 命名相同 final int money = 615; // ... } } } class Son extends ConfusingName { // 不允许与父类的成员变量名称相同 public int age; }

11.【强制】杜绝完全不规范的缩写,避免望文不知义。 反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重 降低了代码的可阅读性。

12.【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。

正例:在 JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater。

反例:int a 的随意命名方式。

13.【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。

正例:startTime / workQueue / nameList / TERMINATED_THREAD_COUNT 反例:startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

14.【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。 Java 开发手册 3/44

正例: public class OrderFactory; public class LoginProxy; public class ResourceObserver;

15.【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁 性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定 是与接口方法相关,并且是整个应用的基础常量。

正例:接口方法签名 void commit(); 接口基础常量 String COMPANY = "alibaba";

反例:接口方法定义 public abstract void f(); 说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默认实现。

16.接口和实现类的命名有两套规则:

1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。

正例:CacheServiceImpl 实现 CacheService 接口。

2) 【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是–able 的形容词)。 正例:AbstractTranslator 实现 Translatable 接口。

17.【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。

正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON。

18.【参考】各层命名规约:

A) Service/DAO 层方法命名规约

1) 获取单个对象的方法用 get 做前缀。

2) 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。

3) 获取统计值的方法用 count 做前缀。

4) 插入的方法用 save/insert 做前缀。

5) 删除的方法用 remove/delete 做前缀。

6) 修改的方法用 update 做前缀。

B) 领域模型命名规约

1) 数据对象:xxxDO,xxx 即为数据表名。

2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。

3) 展示对象:xxxVO,xxx 一般为网页名称。

4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO

java精度丢失问题-什么是精度丢失、原理、解决方案、注意事项

精度丢失是指在Java程序中进行浮点数计算时,由于浮点数表示的局限性,导致得到的结果不能精确地表示为十进制数字。这通常发生在使用floatdouble类型进行金融相关计算时,因为这些类型不能精确地表示所有小数。

原因:

  1. 二进制浮点数无法精确地表示某些十进制分数。

  2. 浮点数中的尾数有限,当数值超过这个限度时会进行舍入。

  3. 浮点数的运算法则导致连续操作可能引起累积误差。

解决方案:

  1. 使用BigDecimal类进行精确的小数计算。

  2. 在金融计算中使用intlong类型,其以分为单位存储金额,最后转换为标准形式输出。

  3. 避免对浮点数进行相等性比较,应该判断两个数的差是否小于一个很小的数值(如1E-6)来认为它们相等。

  4. 使用数据库的高精度数值类型如DECIMAL

注意事项:

  • 在处理财务或要求精确的计算时,应当小心处理浮点数。

  • 使用BigDecimal时,当创建其实例时应当使用字符串而不是直接使用双精度数或浮点数,以避免编译器直接计算可能导致的精度问题。

  • 对于金融软件,应使用专门设计用于处理金融运算的库或框架,如Java Money and Currency API。

Git和GitHub是两个相关但不同的概念,下面是它们的主要区别:

Git

  1. 定义:Git是一个分布式版本控制系统,用于跟踪文件的变化,尤其是源代码。它允许多个开发者在同一项目上协作。
  2. 功能
    • 提供版本控制功能,可以记录文件的历史版本。
    • 支持分支和合并,允许多条开发线并行进行。
    • 本地操作,所有版本历史保存在本地,不依赖于网络。
  3. 使用场景:适用于任何需要版本控制的项目,不限于代码管理。

GitHub

  1. 定义:GitHub是一个基于Git的在线代码托管平台,提供了Git的云端服务。
  2. 功能
    • 提供远程仓库,方便团队协作和代码共享。
    • 提供社交功能,如关注、评论、Pull Request等,促进开发者之间的互动。
    • 提供项目管理工具,如问题追踪、项目看板等。
  3. 使用场景:主要用于代码托管和团队协作,适合开源项目和个人项目的展示。

总结

  • Git是一个工具,用于版本控制;而GitHub是一个平台,用于托管和管理使用Git的项目。
  • 使用Git可以在本地进行版本控制,而使用GitHub则可以将代码上传到云端,与他人协作。

标签:正例,java,接口,反例,学习,笔记,使用,命名,public
From: https://blog.csdn.net/m0_64021225/article/details/141034430

相关文章

  • java io
    packagecom.io;importjava.io.BufferedReader;importjava.io.FileInputStream;importjava.io.IOException;importjava.io.InputStreamReader;importjava.nio.charset.StandardCharsets;publicclassBufferedReaderDemo01{publicstaticvoidmain(Str......
  • java集合
    packagecom.jihe;importjava.util.ArrayList;publicclassArrayListDemo1{publicstaticvoidmain(String[]args){//创建一个ArrayList实例ArrayList<String>fruits=newArrayList<>();//添加元素fruits.add(&quo......
  • Java毕业设计-基于ssm框架开发的车辆管理系统-毕业论文(附毕设源代码)
    文章目录前言一、毕设成果演示(源代码在文末)二、毕设摘要展示1、开发说明2、需求/流程分析3、系统功能结构三、系统实现展示1、个人中心2、员工管理3、用户管理4、基础数据管理5、车辆管理6、保养登记管理7、事故登记管理8、维修登记管理9、违章登记管理四、毕设内容和......
  • Java 入门练习:21 - 25
    JAVA21补全构造方法描述有父类Base,内部定义了x、y属性。有子类Sub,继承自父类Base。子类新增了一个z属性,并且定义了calculate方法,在此方法内计算了父类和子类中x、y、z属性三者的乘积。请补全子类构造方法的初始化逻辑,使得该计算逻辑能够正确执行。输入描述......
  • Java 入门练习:26 - 30
    JAVA26实现接口描述已知接口Comparator,内部定义了max函数,用于返回两个整数中的最大值。请定义该接口的实现类,使得main方法中的比较逻辑可以正确执行,要求实现类的名称为ComparatorImpl。输入描述两个整数输出描述两个整数中的最大值示例1输入:13输出:3解......
  • Java 入门练习:16 - 20
    JAVA16数组遍历描述将用户输入的六个数字填入数组并找出数组中最大值和最小值输入描述随机输入的6个整数输出描述输出数组中的最大值,最小值(最大值最小值之间用空格隔开。若有多个最大值或最小值,输出一次即可,如样例2所示)示例1输入:135246输出:61示例2......
  • Java中数组算法的学习
    数组的算法目录数组的算法概述冒泡排序选择排序排序算法库StreamAPI概述简单排序:冒泡排序、选择排序、插入排序高级排序:快速排序、归并排序、希尔排序相关算法知识:划分、递归、二分查找冒泡排序原理:从第一个数据开始,与第二个数据相比较,如果第二个数据小于第一个数据,......
  • 关于Pandas学习的一些资源
    Pandas这个库,在2016年的时候就有所耳目,当时做数据处理的一些工作。但是这个库有点庞大,一时半会消化不了。后来离开原公司,就弃之若敝。直到最近又将其捡回。对于Pandas的学习,首先要把其基础打好,至于实战,往往就是对基础的掌握,存在多种不同的解决方法。下面是一些学习的资源......
  • Java基础——注解1——注解的定义与使用
    ......
  • java6
    我学习了常见API知识java.lang.Math提供数学常量和方法,如基本的数学运算(加、减、乘、除)、三角函数、对数、幂运算等。常用方法:Math.abs(x):返回x的绝对值。Math.max(a,b):返回a和b中的较大值。Math.min(a,b):返回a和b中的较小值。Math.sqrt(x):返回x的平方根。Math.pow(a,b......