java系列之-枚举类的基本使用

枚举（enum）类型是Java 5新增的特性，它是一种新的类型，允许用常量来表示特定的数据片断，而且全部都以类型安全的形式来表示。

1.常量的使用 

     在JDK1.5之前，我们定义常量都是：public static fianl....。现在好了，有了枚举，可以把相关的常量分组到一个枚举类型里，而且枚举提供了比常量更多的方法。

package com;
 
public enum Color 
{
     
   RED, GREEN, BLANK, YELLOW 
 
}

　　使用

package com;
 
public class B {
 
    public static void main(String[] args) {
 
 
        System.out.println( isRed( Color.BLANK ) ) ;  //结果： false
        System.out.println( isRed( Color.RED ) ) ;    //结果： true
 
    }
 
 
    static boolean isRed( Color color ){
        if ( Color.RED.equals( color )) {
            return true ;
        }
        return false ;
    }
 
}

 

package com;
 
public class B
 {
 
    public static void main(String[] args)
    {
 
        showColor( Color.RED );
 
    }
 
    static void showColor(Color color)
    {
        switch (color) 
        {
            case BLANK:
                System.out.println( color );
                break;
            case RED :
                System.out.println( color );
                break;
            default:
                System.out.println( color );
                break;
        }
         
    }
}

 

2.自定义函数

package com;
 
public enum Color 
{
     
    RED("红色", 1),
    GREEN("绿色", 2), 
    BLANK("白色", 3), 
    YELLO("黄色", 4);
     
     
    private String name ;
    private int index ;
     
    private Color( String name , int index )
    {
        this.name = name ;
        this.index = index ;
    }
     
    public String getName() 
    {
        return name;
    }
    public void setName(String name) 
    {
        this.name = name;
    }
    public int getIndex() 
    {
        return index;
    }
    public void setIndex(int index) 
    {
        this.index = index;
    }
     
 
}

 

　　使用

package com;
 
public class B 
{
 
    public static void main(String[] args)
    {
 
        //输出某一枚举的值
        System.out.println( Color.RED.getName());
        System.out.println( Color.RED.getIndex());
 
        //遍历所有的枚举
        for( Color color : Color.values())
        {
            System.out.println( color + "  name: " + color.getName() + "  index: " + color.getIndex() );
        }
    }
 
}

　　运行结果

红色
1
RED name: 红色 index: 1
GREEN name: 绿色 index: 2
BLANK name: 白色 index: 3
YELLO name: 黄色 index: 4

总结：

1、枚举的本质是类，在没有枚举之前，仍然可以按照java最基本的编程手段来解决需要用到枚举的地方。枚举屏蔽了枚举值的类型信息，不像在用public static final定义变量必须指定类型。枚举是用来构建常量数据结构的模板，这个模板可扩展。枚举的使用增强了程序的健壮性，比如在引用一个不存在的枚举值的时候，编译器会报错。枚举的更多用法还需要在开发中去研究创造，Java5、Java6增加了不少新的特性，技术在升级，对程序员来说就要学习，如果你热爱java的话。否则别人用到新特性的代码你看不懂，那才叫郁闷。

2、枚举在Java家族中只占了很小的一块比重，所以我在项目中用枚举的地方不是很多，毕竟，一个项目是很多人开发维护的，用一个陌生的东西，会给其他的同事造成阅读困难。所以常量大都是用public static final 来定义的。

3.根据枚举值获取枚举类。

3.1 字段方法定义

package com.wc.enums.inter;

/**
 * 此处对应枚举的字段,如状态枚举StatusEnum定义了code,name,desc
 * 那么这里定义这个三个字段的get方法,可以获取到所有的字段
 */
public interface CommonEnum
{
    int getCode();

    String getName();

    String getDesc();
}

3.2 枚举类定义

package com.wc.enums;

import com.wc.enums.inter.CommonEnum;

public enum StatusEnum implements CommonEnum
{
    WAITTING(0, "WAITTING", "等待"),
    STARTED(1, "STARTED", "开始"),
    END(2, "END", "结束");

    private int code;
    private String name;
    private String desc;

    StatusEnum(int code, String name, String desc)
    {
        this.code = code;
        this.name = name;
        this.desc = desc;
    }

    @Override
    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    @Override
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

}

3.3 工具类定义

package com.wc.enums;

import com.wc.enums.inter.CommonEnum;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class EnumUtil
{
    /**
     * 返回指定编码的'枚举'
     *
     * @param clazz
     * @param code
     * @return StatusEnum
     * @throws
     */
    public static <T extends CommonEnum> T getEnumByCode(Class<T> clazz, int code) {
        for(T _enum : clazz.getEnumConstants()) {
            if (code == _enum.getCode()) {
                return _enum;
            }
        }
        return null;
    }

    /**
     * 返回指定名称的'枚举'
     *
     * @param clazz
     * @param name
     * @return StatusEnum
     * @throws
     */
    public static <T extends CommonEnum> T getEnumByName(Class<T> clazz, String name) {
        for(T _enum : clazz.getEnumConstants()) {
            if (_enum.getName().equals(name)) {
                return _enum;
            }
        }
        return null;
    }

    /**
     * 返回指定描述的'枚举'
     *
     * @param clazz
     * @param desc
     * @return StatusEnum
     * @throws
     */
    public static <T extends CommonEnum> T getEnumByDesc(Class<T> clazz, String desc)
    {
        for(T _enum : clazz.getEnumConstants()) {
            if (_enum.getDesc().equals(desc)) {
                return _enum;
            }
        }
        return null;
    }

    public static void main(String[] args)
    {
        StatusEnum statusEnum = EnumUtil.getEnumByCode(StatusEnum.class, 1);
        log.info("EnumUtil|main|根据CODE获取枚举值|请求出参：= {}, {}, {}", statusEnum.getCode(), statusEnum.getName(), statusEnum.getDesc());
        statusEnum = EnumUtil.getEnumByName(StatusEnum.class, "END");
        log.info("EnumUtil|main|根据NAME获取枚举值|请求出参：= {}, {}, {}", statusEnum.getCode(), statusEnum.getName(), statusEnum.getDesc());
        statusEnum = EnumUtil.getEnumByDesc(StatusEnum.class, "等待");
        log.info("EnumUtil|main|根据DESC获取枚举值|请求出参：= {}, {}, {}", statusEnum.getCode(), statusEnum.getName(), statusEnum.getDesc());
    }
}

3.4 运行结果

15:07:53.887 [main] INFO com.wc.enums.EnumUtil - EnumUtil|main|根据CODE获取枚举值|请求出参：= 1, STARTED, 开始
15:07:53.896 [main] INFO com.wc.enums.EnumUtil - EnumUtil|main|根据NAME获取枚举值|请求出参：= 2, END, 结束
15:07:53.896 [main] INFO com.wc.enums.EnumUtil - EnumUtil|main|根据DESC获取枚举值|请求出参：= 0, WAITTING, 等待

3.5 我使用的业务场景

• 根据别人的返回信息，获取匹配的所有信息。
• 全局异常定义，抛出，统一异常返回，不用费力构造实体，只需要抛出对应code即可。