Javaの名前の付け方

1. パッケージ名は一律に小文字であり、ドット区切り文字の間には自然な意味を持つ英単語が 1 つだけあります。パッケージ名は常に単数形を使用しますが、クラス名に複数の意味がある場合は、クラス名に複数形を使用できます。

良い例: アプリケーション ツールのパッケージ名は com.java.util、クラス名は StringUtils

2、クラス名とインターフェイス名は UpperCamelCase スタイルを使用し、キャメル ケースに従う必要があります。ただし、次の例外を除きます：DO/BO/DTO/VO/AO/PO/UID など。

正の例:

UserLoginCheckService/UserDO

逆の例:

UserLoginCheckService/UserDO

3. メソッド名、パラメーター名、メンバー変数、およびローカル変数はすべて lowerCamelCase スタイルを使用し、次の形式に従う必要があります。キャメルケースの形。

肯定的な例:

userServiceImpl

反例:

userServiceImpl

4. 定数名はすべて大文字で、単語はアンダースコアで区切られます。完全かつ明確なセマンティクスを表現するよう努めてください。長い名前は嫌いではありません。

正の例:

MAX_BOOK_COUNT/CACHE_EXPIRED_TIME

反例:

MAX_COUNT/EXPIRED_TIME

5. コードを一目で理解できるという目的を達成するには、カスタム プログラミング要素に名前を付けるときに、次のようにします。可能な限り完全な単語の組み合わせでその意味を表現する、つまり「名前を見て意味がわかる」。

良い例: JDK では、アトミックな更新を表すクラス名は次のとおりです: AtomicReferenceFieldUpdater

Counterexample:

String a = "李四"; // 天啦噜，鬼知道你这个a是啥意思啊

6. 配列を定義するとき、型は密接に関連しています。角括弧 。

良い例:

int[] array = new int[10];
int array[] = new int[10]; // 不建议这样写

7. 抽象クラス名は Abstract または Base で始まり、例外クラス名は Exception で終わり、テスト クラス名は対象となるクラスの名前で始まります。 test で終了します。

良い例:

AbstractService/CommonException/DemoTest

8. 誤解を避けるため、まったく標準的でない略語は避けてください。

反例: AbstractClass の "省略形" は AbsClass という名前が付けられ、条件の "省略形" は condi という名前が付けられます。このような任意の省略形は、コードの可読性を著しく低下させます。

9. モジュール、インターフェイス、クラス、メソッドがデザイン パターンを使用している場合、名前を付けるときに特定のパターンを反映する必要があります。

注: 名前に設計パターンを反映させると、読者がアーキテクチャ設計の概念をすぐに理解できるようになります。

良い例:

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

10. サービス クラスと DAO クラスの場合、SOA の概念に基づいて、公開されるサービスはインターフェイスである必要があり、内部実装クラスは次の方法でインターフェイスから区別されます。 Implの接尾辞。

良い例: CacheServiceImpl は CacheService インターフェイスを実装します

11. 機能を説明するインターフェイス名の場合は、対応する形容詞をインターフェイス名として使用します (通常は –able の形容詞)。

良い例: JDK の同等のインターフェイス

12. Long または Long に値を割り当てるときは、値の後に小文字の l ではなく大文字の L を使用します。小文字は数字と混同されやすいです。 1、誤解を招きます。

説明: Long a = 2l; これは数値 21 として記述されますか、それとも Long 型 2 として記述されますか? ?

13. 魔法の値 (つまり、事前定義されていない定数) をコード内に直接使用することはできません

正の例:

public static final ORDER_REDIS_KEY_PREFIX = "orderId_";
String orderRedisKey = ORDER_REDIS_KEY_PREFIX + orderId;

反例:

String redisKey = "orderId_" + orderId;

14. 列挙クラス名には Enum を接尾辞として付ける必要があります。列挙メンバーの名前はすべて大文字で、アンダースコアで区切る必要があります。

良い例: ProcessStatusEnum という名前のメンバー名を列挙します: SUCCESS / UNKNOWN_REASON

PHP 中国語の Web サイトには、無料の JAVA 入門チュートリアル が多数あり、誰でも学習できます。

以上がJavaの名前の付け方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。