枚举和接口的使用

た入场券 2022-05-21 09:53 191阅读 0赞

## 为什么使用枚举 ##

最近在看公司的代码，发现公司使用到了枚举，这才让我重新拾起枚举的用法。因为我们在调用接口返回数据时，同时需要错误数据的状态码和描述，这时，就需要用到了枚举，我们可以在枚举定义好返回码和描述信息，供前台用户使用。

1.  定义枚举类

package testEnum;
    
    public interface BaseEnum {
    
    	/**
         * 返回的错误代码
         *
         * @return
         */
        public String getCode();
    
        /**
         * 返回的中文描述
         *
         * @return
         */
        public String getChineseDesc();
    
        /**
         * 返回的英语描述
         *
         * @return
         */
        public String getEnglishDesc();
    }

1.  用枚举实现接口

***其实，枚举就是类，我们可以在枚举当中定义构造器、属性、方法，而SUCCESS和ERROR中的参数就对应于构造器中的参数***

package testEnum;
    
    public enum ReturnCodeEnum implements BaseEnum {
    
    	SUSSESS("000000", "success", "操作成功"),
    	ERROR("100000", "error", "操作失败");
    
    	private String code;
    	private String englishDesc;
    	private String chinseDesc;
    
    	ReturnCodeEnum(String code, String englishDesc,String chinseDesc,) {
    		this.code = code;
    		this.englishDesc = englishDesc;
    		this.chinseDesc = chinseDesc;
    	}
    
    	@Override
    	public String getCode() {
    		return this.code;
    	}
    
    	@Override
    	public String getChineseDesc() {
    		return this.chinseDesc;
    	}
    
    	@Override
    	public String getEnglishDesc() {
    		return this.EnglishDesc;
    	}
    
    	/** 
    	 * 根据参数获取返回值，将返回值以json格式的方式输出
    	 * 
    	 *这里使用到了final关键字，防止type指向新的引用对象
    	 *
    	 * @param type 用户传入的枚举的参数，比如ReturnCodeEnum.SUCCESS，ReturnCodeEnum.ERROR
    	 * 
    	 * @return
    	 */
    	public static String StringToJson(final Object type) {
    		if (null == type || type.equals(""))
    			return "{'code':'-100000','englishDesc':'type is null','chineseDesc':'类型为空'}";
    
    		for (ReturnCodeEnum returnCodeEnum : ReturnCodeEnum.values()) {
    			String name = returnCodeEnum.name();
    			if (name.equals(type.toString())) {
    				return "{'code':'" + returnCodeEnum.getCode()
    						+ "','chineseDesc':'" + returnCodeEnum.getChineseDesc()
    						+ "','englishDesc':'" + returnCodeEnum.getEnglishDesc()
    						+ "'}";
    			}
    		}
    		return "{'code':'-200000','englishDesc':'parameter is error ','chineseDesc':'参数类型错误'}";
    	}
    }

1.  测试枚举

package testEnum;
    
    public class Test {
    
    	public static void main(String[] args) {
    		System.out.println(ReturnCodeEnum.StringToJson(ReturnCodeEnum.ERROR));
    	}
    }
    
    output:
    	{'code':'100000','englishDesc':'error','chineseDesc':'操作失败'}