JAVA開發公約

2021-03-01 小包子聊AI

       碼出高效,碼出質量,是每個程式設計師都在孜孜不倦追求的目標,尤其現在都是在協同開發,公約的建立更是至關重要。阿里巴巴在2017年雲棲大會上曾經發布了Java開發公約。結合我之前java開發的情況,我覺得以下幾點尤其重要:

1.在開發軟體上面安裝插件,這樣哪裡開發得不規範,就可以一目了然了。

2.整個開發過程中,變量的命名都要使用英文,便於理解,嚴重全拼或者純中文的形式。

3.類名使用 UpperCamelCase 風格,方法名、變量名使用lowerCamelCase 風格。這兩個還是有明顯差別的,主要區別是首字母是否大寫。在我剛開始開發java的時候,我就光記住了駝峰的形式,完全沒有注意是否要進行首字母大小寫的區分。

4.常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。這個也是我之前沒有注意的地方。

5.抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結尾;測試類 命名以它要測試的類的名稱開始,以 Test 結尾。

6.類型與中括號緊挨相連來表示數組。正例:定義整形數組 int[] arrayDemo;

7.POJO 類中布爾類型的變量,都不要加 is 前綴,否則部分框架解析會引起序列化錯誤。反例:定義為基本數據類型 Boolean isDeleted 的屬性,它的方法也是 isDeleted(),RPC 阿里巴巴 Java 開發手冊  2/38 框架在反向解析的時候,「誤以為」對應的屬性名稱是 deleted,導致屬性獲取不到,進而拋出異常。

8.包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式,但是類名如果有複數含義,類名可以使用複數形式。正例:應用工具類包名為 com.alibaba.ai.util、類名為 MessageUtils(此規則參考 spring 的框架結構)

9.杜絕完全不規範的縮寫,避免望文不知義。

整個開發公約還是要時常拿出來讀一讀看一看。做一個遵紀守約的好程式設計師。

相關焦點

  • Java開發 - 02 - Java 簡介及環境搭建
    JavaEE  (J2EE)     (Java 2 Platform,Enterprise Edition,java 平臺企業版)JavaME (J2ME)    (Java 2 Platform Micro Edition,java 平臺微型版)。
  • 三分鐘了解《華盛頓公約》
    在司法機關辦理非法收購、運輸、出售珍貴瀕危野生動物刑事案件中,經常會碰到一個詞語,那就是《華盛頓公約》。鑑於多數人對該公約內容並不熟悉,刑動派微信公眾號特刊發本文,以饗讀者。《華盛頓公約》全稱為《瀕危野生動植物種國際貿易公約》,於1973年3月3日在美國華盛頓通過,故簡稱《華盛頓公約》。
  • 初學者必看 | Java的常用開發工具
    都說工欲善其事必先利其器,要想學好java這門語言,選擇一款好用順手的開發工具是必不可少的。另外面試java工作時開發工具的使用也是一個重要的考核點。要想全面了解java開發工具,我們首先需要先了解一下java程序的開發過程,通過這個過程我們能夠了解到java開發都需要用到那些工具。
  • Java程式設計師必備的開發工具
    java是計算機應用程式程式語言,被廣泛用於創建Web應用、伺服器處理、用戶端的API開發乃至資料庫等多個領域。
  • JAVA學好了可以做什麼?java開發的七個工作方向
    在現實生活中,大多數人選擇java開發這個行業都是看好java的發展前景,那麼java學好了之後可以做些什麼呢?有哪些工作方向?
  • 每個Java程式設計師需要了解的8個Java開發工具
    Java是計算機應用程式程式語言,被廣泛用於創建Web應用、伺服器處理、用戶端的API開發乃至資料庫等多個領域。
  • Java程序運行機制與開發環境
    java源文件首先需要通過javac編譯生成後綴名為.class的字節碼文件(與平臺無關,只面向JVM),然後使用Java虛擬機將字節碼解釋成特定平臺上的機器碼運行。  開發Java準備  下載安裝Java8的JDK,並將jdk的安裝路徑添加到環境變量中。  開發Java需要安裝JDK,JDK包含Java編譯器(javac命令工具)、Java運行時環境(JRE)、常用的Java類庫等。  JRE包含JVM,還包含類加載器、字節碼校驗器及大量的基礎類庫等環境支持。
  • 海牙選擇法院協議公約介紹
    海牙《選擇法院協議公約》由海牙國際私法會議組織進行編纂,歷經多次研討協商最終於2015年10月1日正式生效,我國也於2017年9月12日籤署該公約
  • Java開發 —— jdk安裝
    收錄於話題 #學習專區——Java開發5.修改目標文件夾,注意可以存放在剛才的文件夾中(要新建一個獨立的文件夾,否則東西太亂)。
  • 波札那:我們要退出華盛頓公約!
    近日,波札那、納米比亞、辛巴威等南部非洲國家聯名要求國際社會開放野生動物貿易,但再次因華盛頓公約(即瀕危野生動植物種國際貿易公約
  • Java遊戲開發是怎麼做的
    java的圖形界面,在啟動的時候,就開始了一個線程。這個線程負責處理:JFrame、JPanel等的繪製、事件處理。它是由作業系統調用的,在程序啟動時開啟,程序關閉時消亡。這個線程裡執行的邏輯,支撐著圖形框架的基礎邏輯,我們無法控制它。想一下,遊戲裡那些動畫效果、呼嘯而出的子彈、飄來飄去的雲朵。
  • 最受歡迎的 Java Web 開發框架盤點
    Java開發框架排名列前3名,包括以下: 1) Spring網址:http://projects.spring.io/spring-framework/ 2) JSF網址:http://www.oracle.com/technetwork/java/javaee/download-139288
  • 海牙認證是什麼,海牙公約國有哪些?
    「apostille」特指1961年《海牙關於取消外國公文認證要求的公約》籤約國之間相互承認的,特定的官方機構對公文上其主管部門所做籤字、蓋章的真實性予以確認的行為過程和結果。常用於民事/商業文書認證用於境外使用,我們所見到海牙認證文件為:公證+海牙認證書。並不是所有國家都可以辦理海牙認證,這主要局限於海牙認證公約。
  • Java開發必會的Linux命令
    來源:HollisChuang's Blog(@Hollis_Chuang)連結:http://www.hollischuang.com/archives/800作為一個Java開發人員即時平時開發過程中不使用Linux(Unix)或者mac系統,也需要熟練掌握Linux命令。因為很多伺服器上都是Linux系統。所以,要和伺服器機器交互,就要通過shell命令。本文並不會對所有命令進行詳細講解,只給出常見用法和解釋。具體用法可以使用--help查看幫助或者直接通過google搜索學習。
  • Java開發必須要知道的知識體系
    在TIOBE程式語言排行榜中,連續奪得第一寶座,而且國內各大知名網際網路公司,後端開發首選語言:非Java莫屬。今天只是梳理下Java知識體系,後續會針對各類目有更詳細的經驗分享。知識體系JDKJava8Lambda 語句方法引用日期/時間處理API等等,不一一列舉,詳細的參考這些文檔URL: http://www.oracle.com/technetwork/cn/java/javase/documentation/index.html說明: Java8增加了很多新的重要特性,
  • PHP轉JAVA開發原來這麼簡單
    來自:dothetrick(ID:javaeffictive)服務端開發中,有很多知識是相通的,例如mysql,redis,http協議等。基於這些基礎,在程式語言上的轉變並不困難。本文主要從下面幾點出發,講述如何快速從php開發轉為java開發:操作Mysql資料庫和發送http請求 - 15min使用框架構建項目先看下PHP和JAVA對應的項目工具和框架:PHPJAVA項目管理工具composermaven框架Laravel或ThinkphpSpringBoot
  • VS Code Java 開發指南!
    Code 進行開發、運行、調試和部署其應用程式。接下來,我們將詳解如何在 VS Code 中基於 Java 進行開發。如果你尚未下載 Visual Studio Code,請立即安裝。本指南的其餘部分要求你至少安裝了 Java 8,當然 Java 11 也可以。你也可以完全跳過本指南,直接去看 Visual Studio Code 的 Java 文檔。但是本文的一些乾貨可以幫助你充分利用 VS Code 進行 Java 開發。
  • Java開發的所有工具都在這裡,全是最新版
    文章概述:1、API文檔1.8(在線版和離線版)2、jdk開發工具1.8
  • 帶你了解Java遊戲開發究竟是怎麼做的?
    對於Java遊戲開發是怎麼做的?
  • Java 快速開發二維碼生成服務
    那麼 Java 如何開發二維碼功能呢?今天來簡單探討一下。歡迎加入微信圈子程式設計師交流圈 交流編程經驗,歡迎投稿。 2. 關於二維碼 作為開發者我們肯定會想到二維碼是將內容編碼成了二維碼的圖案。對於其原理我們並不需要知道,就是一個編碼和解碼的過程。