小議Java的源文件的聲明規(guī)則以及編程風(fēng)格
Java源文件的聲明規(guī)則
當(dāng)在一個(gè)源文件中定義多個(gè)類,并且還有import語(yǔ)句和package語(yǔ)句時(shí),要特別注意這些規(guī)則:
一個(gè)源文件中只能有一個(gè)public類。
一個(gè)源文件可以有多個(gè)非public類。
源文件的名稱應(yīng)該和public類的類名保持一致。例如:源文件中public類的類名是Employee,那么源文件應(yīng)該命名為Employee.java。
如果一個(gè)類定義在某個(gè)包中,那么package語(yǔ)句應(yīng)該在源文件的首行。
如果源文件包含import語(yǔ)句,那么應(yīng)該放在package語(yǔ)句和類定義之間。如果沒(méi)有package語(yǔ)句,那么import語(yǔ)句應(yīng)該在源文件中最前面。
import語(yǔ)句和package語(yǔ)句對(duì)源文件中定義的所有類都有效。在同一源文件中,不能給不同的類不同的包聲明。
類有若干種訪問(wèn)級(jí)別,并且類也分不同的類型:抽象類和final類等。這些將在后續(xù)章節(jié)介紹。
除了上面提到的幾種類型,Java還有一些特殊的類,如內(nèi)部類、匿名類。
一個(gè)簡(jiǎn)單的例子
在該例子中,我們創(chuàng)建兩個(gè)類 Employee 和 EmployeeTest,分別放在包 p1 和 p2 中。
Employee類有四個(gè)成員變量,分別是 name、age、designation和salary。該類顯式聲明了一個(gè)構(gòu)造方法,該方法只有一個(gè)參數(shù)。
在Eclipse中,創(chuàng)建一個(gè)包,命名為 p1,在該包中創(chuàng)建一個(gè)類,命名為 Employee,將下面的代碼復(fù)制到源文件中:
package p1;
public class Employee{
String name;
int age;
String designation;
double salary;
// Employee 類的構(gòu)造方法
public Employee(String name){
this.name = name;
}
// 設(shè)置age的值
public void empAge(int empAge){
age = empAge;
}
// 設(shè)置designation的值
public void empDesignation(String empDesig){
designation = empDesig;
}
// 設(shè)置salary的值
public void empSalary(double empSalary){
salary = empSalary;
}
// 輸出信息
public void printEmployee(){
System.out.println("Name:"+ name );
System.out.println("Age:" + age );
System.out.println("Designation:" + designation );
System.out.println("Salary:" + salary);
}
}
程序都是從main方法開始執(zhí)行。為了能運(yùn)行這個(gè)程序,必須包含main方法并且創(chuàng)建一個(gè)對(duì)象。
下面給出EmployeeTest類,該類創(chuàng)建兩個(gè)Employee對(duì)象,并調(diào)用方法設(shè)置變量的值。
在Eclipse中再創(chuàng)建一個(gè)包,命名為 p2,在該包中創(chuàng)建一個(gè)類,命名為 EmployeeTest,將下面的代碼復(fù)制到源文件中:
package p2;
import p1.*;
public class EmployeeTest{
public static void main(String args[]){
// 創(chuàng)建兩個(gè)對(duì)象
Employee empOne = new Employee("James Smith");
Employee empTwo = new Employee("Mary Anne");
// 調(diào)用這兩個(gè)對(duì)象的成員方法
empOne.empAge(26);
empOne.empDesignation("Senior Software Engineer");
empOne.empSalary(1000);
empOne.printEmployee();
empTwo.empAge(21);
empTwo.empDesignation("Software Engineer");
empTwo.empSalary(500);
empTwo.printEmployee();
}
}
編譯并運(yùn)行 EmployeeTest 類,可以看到如下的輸出結(jié)果:
Name:James Smith Age:26 Designation:Senior Software Engineer Salary:1000.0 Name:Mary Anne Age:21 Designation:Software Engineer Salary:500.0
強(qiáng)調(diào)一下編程風(fēng)格
代碼風(fēng)格雖然不影響程序的運(yùn)行,但對(duì)程序的可讀性卻非常重要。自己編寫的程序要讓別人看懂,首先在排版方面要非常注意。
其實(shí)每個(gè)人的編程風(fēng)格、每個(gè)軟件開發(fā)公司的編程風(fēng)格都不一樣。一個(gè)人編寫的程序代碼,就應(yīng)該能讓別人看懂,甚至是過(guò)了很長(zhǎng)時(shí)間,自己也要看的懂,否則這個(gè)程序就成了一個(gè)死程序。
編程風(fēng)格是指編程時(shí)的格式,讓程序看上去就很有層次感。下面通過(guò)一些例子,說(shuō)明編程風(fēng)格的重要性:
public class math{
public static void main(String[] args){
int x=12;
double y=12.3d;
void print(){
char a='a';
System.out.println(a);
}
System.out.println(x+y);
}
}
上面程序段的整個(gè)排版看起來(lái)是否很舒服,并且層次感很強(qiáng)?是否一眼看上去就知道整個(gè)程序架構(gòu)?這里的關(guān)鍵在于縮進(jìn),縮進(jìn)也可以稱為跳格。
上面的代碼采用的縮進(jìn):"public class math" 是頂格的,接著 mian() 方法縮進(jìn) 4 個(gè)空格,在 mian() 方法里面的代碼一律縮進(jìn) 8 個(gè)空格,而 print() 方法的主體代碼又多縮進(jìn) 4 個(gè)空格。這樣整個(gè)程序的所屬關(guān)系就很明顯了。mian() 方法屬于 math 類,其余的都屬于main() 方法,而在 print() 方法內(nèi)的代碼段又屬于此方法。規(guī)律就是空格多的代碼從屬于空格少的代碼。
我推薦大家使用 tab 鍵縮進(jìn),大部分編輯器(如Eclipse)都支持自定義 tab 鍵的空格數(shù),一般為 4 個(gè)空格。
除了縮進(jìn),空行也是必要的,先看下列程序代碼:
public class math{
public static void main(String[] args){
int x=12;
int y=23;
void print(){
// .................
}
void view(){
// ....................
}
}
}
上面的程序段,在 print() 方法與 view() 方法之間有空行,用來(lái)區(qū)分不同的模塊。print() 方法與 view() 方法所完成的功能不一樣,所以使用空行將它們分開,這樣更增加了程序的可讀性。
另外,需要注意的是方法或?qū)傩缘拿?。這些名字應(yīng)該有含義,最好有規(guī)律,不要只使用"a"、"b"這種通用變量,適當(dāng)可以根據(jù)變量或函數(shù)的功能為其命名。上面的"print",其他程序員一看就知道這個(gè)方法,是有關(guān)打印或輸出的函數(shù)。再如:變量名"name",一看就知道是有關(guān)名字的變量。所以,一定要命名的有意義,否則程序的可讀性不強(qiáng)。
還有一點(diǎn)是有關(guān)注釋的。在每個(gè)方法的方法名旁邊,應(yīng)該添加一些注釋,同時(shí)在一段程序完成之后,也要對(duì)程序的功能及如何操作,做個(gè)簡(jiǎn)單的描述。
只要做到以上幾點(diǎn),這個(gè)程序他人來(lái)讀就很容易。即使自己在很長(zhǎng)時(shí)間后,再來(lái)讀程序也會(huì)一目了然。
相關(guān)文章
SpringBoot整合SpringSession實(shí)現(xiàn)分布式登錄詳情
這篇文章主要介紹了SpringBoot整合SpringSession實(shí)現(xiàn)分布式登錄詳情,文章圍繞主題展開詳細(xì)的內(nèi)容介紹,具有一定的參考價(jià)值,需要的朋友可以參考一下2022-08-08
Spring Data JPA中 in 條件參數(shù)的傳遞方式
這篇文章主要介紹了Spring Data JPA中 in 條件參數(shù)的傳遞方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
關(guān)于Spring?Cloud的熔斷器監(jiān)控問(wèn)題
Turbine是一個(gè)聚合Hystrix監(jiān)控?cái)?shù)據(jù)的工具,它可將所有相關(guān)/hystrix.stream端點(diǎn)的數(shù)據(jù)聚合到一個(gè)組合的/turbine.stream中,從而讓集群的監(jiān)控更加方便,接下來(lái)通過(guò)本文給大家介紹Spring?Cloud的熔斷器監(jiān)控,感興趣的朋友一起看看吧2022-01-01
Java中的CAS無(wú)鎖機(jī)制實(shí)現(xiàn)原理詳解
這篇文章主要介紹了Java中的CAS無(wú)鎖機(jī)制實(shí)現(xiàn)原理詳解,無(wú)鎖機(jī)制,是樂(lè)觀鎖的一種實(shí)現(xiàn),并發(fā)情況下保證對(duì)共享變量值更改的原子性,CAS是Java中Unsafe類里面的方法,底層通過(guò)調(diào)用C語(yǔ)言接口,再通過(guò)cup硬件指令保證原子性,需要的朋友可以參考下2024-01-01
解決使用ProcessBuilder踩到的坑及注意事項(xiàng)
這篇文章主要介紹了解決使用ProcessBuilder踩到的坑,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
SpringBoot實(shí)現(xiàn)登錄校驗(yàn)(JWT令牌)
JWT全稱為JSON Web Token,是一種用于身份驗(yàn)證的開放標(biāo)準(zhǔn),本文主要介紹了SpringBoot實(shí)現(xiàn)登錄校驗(yàn)(JWT令牌),具有一定的參考價(jià)值,感興趣的可以了解一下2023-12-12
Spring?Security如何實(shí)現(xiàn)升級(jí)密碼加密方式詳解
這篇文章主要為大家介紹了Spring?Security實(shí)現(xiàn)升級(jí)密碼加密方式詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-01-01
Java利用EasyExcel實(shí)現(xiàn)導(dǎo)出導(dǎo)入功能的示例代碼
EasyExcel是一個(gè)基于Java的、快速、簡(jiǎn)潔、解決大文件內(nèi)存溢出的Excel處理工具。本文廢話不多說(shuō),直接上手試試,用代碼試試EasyExcel是否真的那么好用2022-11-11

