java 枚举类编写规范

原创

mob649e815ddfb8 2023-07-21 04:54:15 ©著作权

文章标签 枚举类 Java 示例代码 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e815ddfb8的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 枚举类编写规范

引言

枚举类是一种特殊的类，用于定义一组常量。Java 枚举类提供了一种更优雅、类型安全的方式来表示有限集合的值。本文将介绍 Java 枚举类的编写规范，并提供一些示例代码。

命名规范

枚举类名应使用单数形式，通常采用大写字母开头的驼峰命名法，例如 Color。
枚举常量名应全部大写，单词之间使用下划线分隔，例如 RED、GREEN、BLUE。

示例代码：

public enum Color {
    RED,
    GREEN,
    BLUE;
}

枚举常量

枚举常量应根据其含义进行排序，便于查找和维护。
枚举常量应提供有意义的名称和描述，以提高代码的可读性。

示例代码：

public enum DayOfWeek {
    MONDAY("星期一", "工作日"),
    TUESDAY("星期二", "工作日"),
    WEDNESDAY("星期三", "工作日"),
    THURSDAY("星期四", "工作日"),
    FRIDAY("星期五", "工作日"),
    SATURDAY("星期六", "休息日"),
    SUNDAY("星期日", "休息日");
    
    private String displayName;
    private String category;
    
    DayOfWeek(String displayName, String category) {
        this.displayName = displayName;
        this.category = category;
    }
    
    public String getDisplayName() {
        return displayName;
    }
    
    public String getCategory() {
        return category;
    }
}

枚举方法

枚举类可以定义方法，提供额外的功能。
枚举方法应使用驼峰命名法，与普通方法保持一致。

示例代码：

public enum Operation {
    PLUS {
        public int apply(int x, int y) {
            return x + y;
        }
    },
    MINUS {
        public int apply(int x, int y) {
            return x - y;
        }
    },
    MULTIPLY {
        public int apply(int x, int y) {
            return x * y;
        }
    },
    DIVIDE {
        public int apply(int x, int y) {
            return x / y;
        }
    };
    
    public abstract int apply(int x, int y);
}

使用枚举类

可以通过枚举常量名访问枚举常量。
可以使用 Enum.valueOf() 方法将字符串转换为枚举常量。

示例代码：

public class Main {
    public static void main(String[] args) {
        Color color = Color.RED;
        System.out.println(color); // 输出 RED
        
        DayOfWeek day = DayOfWeek.valueOf("MONDAY");
        System.out.println(day.getDisplayName()); // 输出 星期一
        
        Operation operation = Operation.PLUS;
        System.out.println(operation.apply(2, 3)); // 输出 5
    }
}