java代码规范(适合写程序之前先了解有助于开发协同)

2024-01-04 01:12

本文主要是介绍java代码规范(适合写程序之前先了解有助于开发协同),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

一、类定义

二、方法定义

三、接口定义

四、变量定义

1、命名规范:

2、类型规范:

3、常量规范:

五、static关键字

1、静态变量(类变量):

2、静态方法(类方法):


一、类定义

  1. 类名应该使用大写字母开头的驼峰命名法。例如,PublicClass。
  2. 类定义应该包含在一个与类名同名的文件中。例如,PublicClass类的定义应该保存在名为PublicClass.java的文件中。
  3. 类定义应该包括访问修饰符,通常是public,表示该类可以被其他类访问。如果没有指定访问修饰符,则默认为package-private(即只有在同一包中的类可以访问)。
  4. 类定义可以包含类级别的变量(称为字段)和方法。字段和方法也应该使用驼峰命名法,并且方法名应该以动词开头。
  5. 类定义可以包含构造函数,用于初始化类的实例。构造函数应该与类名同名,没有返回类型,并且可以在其中初始化类的字段。
  6. 如果类定义包含方法,则应该为每个方法提供适当的访问修饰符,例如public、private、protected或默认(package-private)。方法的访问修饰符应该根据方法的用途和访问需求进行选择。
  7. 类定义可以包含注释和文档,以便其他人可以理解代码的功能和用途。注释应该清晰明了,并且应该使用JavaDoc格式进行编写。

二、方法定义

在Java中,方法的定义也需要遵循一定的规范,这有助于提高代码的可读性和一致性。以下是一些Java方法定义的规范:

  1. 方法命名:方法名应该使用小写字母开头的驼峰命名法。动词应该用来表示方法的行为。例如,calculateSum()。
  2. 访问修饰符:每个方法都应该有明确的访问修饰符,如 public,private,protected,或者默认(没有指定)。这决定了该方法从哪里可以被访问。
  • private:当一个类的成员被声明为private时,它只能被其本身访问,而不能被外部的类访问。这是访问权限最严格的修饰符。
  • protected:当一个类的成员被声明为protected时,它可以被其本身、相同包中的其他类以及不同包中的子类访问。
  • public:当一个类的成员被声明为public时,它具有最宽松的访问权限。它可以被任何其他类访问,无论这些类是否在相同的包中或是该类的子类。

首先包层次如下所示:

private只可以在类中访问:

protected同一包中访问:

Test类和User类属于同一包下可以访问:

EasyTest类在easy包下和User类不属于同一包下所以不可以访问:

public可以被其他的类任意访问:

不同包下也可以访问:

  1. 返回类型:方法应该明确声明其返回类型。如果方法不返回任何值,那么它应该声明为 void。返回的类型应该尽可能地精确,避免使用过于宽泛的类型,如 Object。
  2. 参数:方法的参数列表应该清晰明了,每个参数的类型和名称都应该明确。参数也应该使用驼峰命名法。
  3. 异常处理:方法应该清楚地声明它可能抛出的任何异常。这有助于调用此方法的代码理解可能发生的错误并适当处理。
  4. 注释:和方法相关的重要信息应该通过注释进行说明,包括方法的目的、参数的含义和返回值。注释应该使用JavaDoc格式。
  5. 方法体:方法体内部的代码应该简洁明了,避免冗长和复杂的代码。每个方法都应该尽量只做一件事情,这样有助于代码的重用和测试。

三、接口定义

1、接口命名

  • 接口名称应具有描述性,通常以able,ible或er结尾,例如Runnable,Serializable。
  • 使用大写字母开头的驼峰命名法,例如PublicInterface。
  • 避免使用Java关键字作为接口名称。

2、接口位置

  • 接口应该放在其使用者可以访问的位置。通常,这意味着接口应该放在一个包中,该包的名称反映了其用途。

3、方法命名

  • 接口方法应该是动词或动词短语,表示一个操作,例如start(),stop()。
  • 方法也应该使用驼峰命名法,并且首字母小写,例如public void myMethod();。

4、注释

  • 对接口和其方法进行充分的注释,以便其他开发者理解它们的用途。
  • 使用JavaDoc格式进行注释,以便可以通过工具生成API文档。

5、接口与实现分离

  • 接口不应包含任何具体的实现细节。这些细节应在实现接口的类中定义。

6、避免过于庞大

  • 避免创建过于庞大的接口,接口中的方法数量应适中。过于庞大的接口会使得实现类变得复杂和难以理解。

7、常量定义

  • 如果接口需要定义常量,则这些常量应该是公共的、静态的和最终的,通常这些常量都是大写字母,用下划线分隔单词,例如:public static final String CONSTANT_NAME = "value";

8、默认方法和静态方法

  • 在合适的情况下,可以使用默认方法和静态方法。默认方法可以在不破坏已有实现的情况下向接口添加新方法,而静态方法则可以提供与接口相关的工具性函数。

接口的定义 接口类中的方法和属性不要加任何修饰符号(public 也不要加)

⭐⭐⭐在JDK8以后接口中的方法也可以实现了,就是要在方法前面加一个default关键词。

实现接口使用implements,下面的图片中的代码有这么一行

Animal myDog = new Dog();

这一行是通过new Dog对象从而向上转型实现了Animal接口因为接口是不可以直接的被new出来的。

向上转型(Upcasting)和向下转型(Downcasting)是Java中两种重要的类型转换操作

1、向上转型(Upcasting)

  • 向上转型是将子类的引用转为父类的引用。
  • 由于子类对象可以当作父类对象来使用(子类是父类的扩展),这种转换是自动的,不需要使用任何特殊的语法。
  • 向上转型是安全的,不会丢失任何数据。示例:

                class Animal { }

                class Dog extends Animal { }

                Dog dog = new Dog();

                Animal animal = dog; // 向上转型, 自动完成

2、向下转型(Downcasting)

  • 向下转型是将父类的引用转为子类的引用。
  • 由于父类引用可能指向子类对象,也可能指向真正的父类对象,所以这种转换是不安全的,需要强制转换。
  • 在转换前,通常会使用instanceof操作符来检查是否可以安全地进行向下转型。示例:

                Animal animal = new Dog(); // 向上转型

                if (animal instanceof Dog) { // 检查是否可以安全地向下转型为Dog类型

                        Dog dog = (Dog) animal; // 向下转型, 需要强制转换

                        // ...

                }

四、变量定义

1、命名规范

  • 使用有意义的变量名,变量名应清晰地表达变量的用途。
  • 采用驼峰命名法,变量名首字母小写,例如 myVariable。
  • 对于多个单词组成的变量名,使用驼峰命名法,例如 mySecondVariable。

2、类型规范

  • 使用合适的数据类型,避免不必要的数据类型转换和浪费内存。
  • 在可能的情况下,优先使用基本数据类型而不是其包装类。

3、常量规范

  • 常量通常使用 static 和 final 关键字进行定义。
  • 常量名全部大写,单词之间使用下划线分隔,例如 MY_CONSTANT。
  • 常量不应被改变,因此在定义时应初始化。

五、static关键字

1、静态变量(类变量):

  • 使用static修饰的变量称为静态变量或类变量。
  • 它属于类,而不属于类的任何一个实例。也就是说,类的所有实例共享同一个静态变量。
  • 静态变量在类加载时初始化,仅在类加载时分配内存一次。
class Counter {  static int count = 0; // 静态变量  Counter() {  count++;  System.out.println(count);  }  public static void main(String args[]) {  Counter c1 = new Counter();  Counter c2 = new Counter();  Counter c3 = new Counter();  }  
}  
// 输出  
// 1  
// 2  
// 3

2、静态方法(类方法)

  • 使用static修饰的方法称为静态方法或类方法。
  • 静态方法可以直接通过类名来调用,不需要创建类的实例。
  • 静态方法可以访问静态数据成员并且可以更改静态数据成员的值。
class Example {  static int cube(int x) {  // 静态方法  return x * x * x;  }  public static void main(String args[]) {  int result = Example.cube(5); // 通过类名直接调用静态方法  System.out.println(result);  }  
}

这篇关于java代码规范(适合写程序之前先了解有助于开发协同)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/567700

相关文章

SpringSecurity 认证、注销、权限控制功能(注销、记住密码、自定义登入页)

《SpringSecurity认证、注销、权限控制功能(注销、记住密码、自定义登入页)》SpringSecurity是一个强大的Java框架,用于保护应用程序的安全性,它提供了一套全面的安全解决方案... 目录简介认识Spring Security“认证”(Authentication)“授权” (Auth

Java实现数据库图片上传与存储功能

《Java实现数据库图片上传与存储功能》在现代的Web开发中,上传图片并将其存储在数据库中是常见的需求之一,本文将介绍如何通过Java实现图片上传,存储到数据库的完整过程,希望对大家有所帮助... 目录1. 项目结构2. 数据库表设计3. 实现图片上传功能3.1 文件上传控制器3.2 图片上传服务4. 实现

Spring、Spring Boot、Spring Cloud 的区别与联系分析

《Spring、SpringBoot、SpringCloud的区别与联系分析》Spring、SpringBoot和SpringCloud是Java开发中常用的框架,分别针对企业级应用开发、快速开... 目录1. Spring 框架2. Spring Boot3. Spring Cloud总结1. Sprin

Java实现MD5加密的四种方式

《Java实现MD5加密的四种方式》MD5是一种广泛使用的哈希算法,其输出结果是一个128位的二进制数,通常以32位十六进制数的形式表示,MD5的底层实现涉及多个复杂的步骤和算法,本文给大家介绍了Ja... 目录MD5介绍Java 中实现 MD5 加密方式方法一:使用 MessageDigest方法二:使用

Java中的runnable 和 callable 区别解析

《Java中的runnable和callable区别解析》Runnable接口用于定义不需要返回结果的任务,而Callable接口可以返回结果并抛出异常,通常与Future结合使用,Runnab... 目录1. Runnable接口1.1 Runnable的定义1.2 Runnable的特点1.3 使用Ru

Java中Runnable和Callable的区别和联系及使用场景

《Java中Runnable和Callable的区别和联系及使用场景》Java多线程有两个重要的接口,Runnable和Callable,分别提供一个run方法和call方法,二者是有较大差异的,本文... 目录一、Runnable使用场景二、Callable的使用场景三、关于Future和FutureTa

Spring 中 BeanFactoryPostProcessor 的作用和示例源码分析

《Spring中BeanFactoryPostProcessor的作用和示例源码分析》Spring的BeanFactoryPostProcessor是容器初始化的扩展接口,允许在Bean实例化前... 目录一、概览1. 核心定位2. 核心功能详解3. 关键特性二、Spring 内置的 BeanFactory

Spring组件初始化扩展点BeanPostProcessor的作用详解

《Spring组件初始化扩展点BeanPostProcessor的作用详解》本文通过实战案例和常见应用场景详细介绍了BeanPostProcessor的使用,并强调了其在Spring扩展中的重要性,感... 目录一、概述二、BeanPostProcessor的作用三、核心方法解析1、postProcessB

Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)

《Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)》:本文主要介绍Java导入、导出excel的相关资料,讲解了使用Java和ApachePOI库将数据导出为Excel文件,包括... 目录前言一、引入Apache POI依赖二、用法&步骤2.1 创建Excel的元素2.3 样式和字体2.

Java实现将Markdown转换为纯文本

《Java实现将Markdown转换为纯文本》这篇文章主要为大家详细介绍了两种在Java中实现Markdown转纯文本的主流方法,文中的示例代码讲解详细,大家可以根据需求选择适合的方案... 目录方法一:使用正则表达式(轻量级方案)方法二:使用 Flexmark-Java 库(专业方案)1. 添加依赖(Ma