采用枚举的方式遍历登陆类型

忘是亡心i 2022-04-01 07:09 168阅读 0赞

### 文章目录 ###

*  编写目的
 *  源码
 *   *  依赖
     *  项目源码
 *  单元测试用例：
 *   *  测试结果

# 编写目的 #

在我们的项目登陆模块中，往往在执行登陆代码后，其会返回一个状态码，而根据返回的状态码的不同，我们return对应的结果到前台界面。

因为状态码可能有多种情况，因而在返回的方法中我们不停的用`if...else if...`根据每个`if`条件的不同，返回不同的结果。这样虽然可以满足业务上的需求，但是代码不简洁，不便于开发人员后期对代码的维护。因而我觉得有必要写一个工具类，通过该类，直接在执行登陆代码后，根据其返回的状态码，直接返回对应的结果。

在这里，我使用了遍历枚举的方法来返回所需的结果，而谈到枚举，这就需要我们了解枚举有哪些特性。在这里，我将枚举的特性罗列如下：

Enum看起来很象是特殊的class，其地位与class、interface等同。 它也可以有自己的变量，可以定义自己的方法，可以实现一个或者多个接口。 当我们在声明一个enum类型时，我们应该注意到enum类型有如下的一些特征。

> 1、它不能有public的构造函数，这样做可以保证客户代码没有办法新建一个enum的实例。  
> 2、所有枚举值都是public , static , final的。注意这一点只是针对于枚举值，我们可以和在普通类里面定义 变量一样定义其它任何类型的非枚举变量，这些变量可以用任何你想用的修饰符。  
> 3、Enum默认实现了java.lang.Comparable接口。  
> 4、Enum覆载了了toString方法，因此我们如果调用Color.Blue.toString()默认返回字符串”Blue”.  
> 5、Enum提供了一个valueOf方法，这个方法和toString方法是相对应的。调用valueOf(“Blue”)将返回Color.Blue.因此我们在自己重写toString方法的时候就要注意到这一点，一把来说应该相对应地重写valueOf方法。  
> 6、Enum还提供了values方法，这个方法使你能够方便的遍历所有的枚举值。  
> 7、Enum还有一个oridinal的方法，这个方法返回枚举值在枚举类种的顺序，这个顺序根据枚举值声明的顺序而定，这里Color.Red.ordinal()返回0

# 源码 #

## 依赖 ##

<dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.3.2</version>
        <scope>test</scope>
    </dependency>
    
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.4</version>
        <scope>provided</scope>
    </dependency>
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.10.0</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.10.0</version>
    </dependency>

## 项目源码 ##

CommonType源码：

package com.lyc.common;
    
    import lombok.AllArgsConstructor;
    import lombok.Getter;
    
    public class CommonType { 
    
        /** * 登陆状态 */
        @Getter
        @AllArgsConstructor
        public enum LoginStatus{ 
    
            LOGIN_SUCCESS("登陆成功！",0),
    
            USERNAME_NOT_NULL("用户名不能为空！",1),
            USERNAME_ERROR("用户名错误！",2),
    
            PASSWORD_NOT_NULL("密码不能为空！",3),
            PASSWORD_ERROR("密码错误！",4),
    
            AUTH_CODE_NOT_NULL("验证码不能为空！",5),
            AUTH_CODE_ERROR("验证码错误！",6),
    
            USER_IS_NULL("账号不存在！",7),
            ROLES_IS_NULL("角色不存在！",8),
            PERMISSION_IS_NULL("权限点不存在！",9);
    
            private String msg;
            private int code;
    
        }
    }

JsonData源码：

package com.lyc.common;
    
    import lombok.*;
    
    import java.util.HashMap;
    import java.util.Map;
    
    @Getter
    @Setter
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public class JsonData { 
    
        //登录成功
        private static int HTTP_STATUS_SUCCESS = 0;
        //登录失败
        private static int HTTP_STATUS_FAIL = 1001;
    
        //返回状态信息
        private int code;
        //返回携带的信息内容
        private String msg = "";
        //返回信息的总条数
        private int count;
        //返回对象
        private Object data;
    
        //常用的构造方法
        //只传入一个结果的时候，我们没有message
        public JsonData(int code){ 
            this.code = code;
        }
    
        public JsonData(String msg,int code) { 
            this.msg = msg;
            this.code = code;
        }
    
        public static JsonData newJsonData(String msg, int code){ 
            return new JsonData(msg,code);
        }
    
        /** * 构造函数，传入返回的信息数量以及信息内容 * @param count * @param data */
        public JsonData(int count, Object data){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_SUCCESS);
            jsonData.count = count;
            jsonData.data = data;
        }
    
        public static JsonData success(int count, Object data, String msg){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_SUCCESS);
            jsonData.data = data;
            jsonData.msg = msg;
            jsonData.count = count;
            return jsonData;
        }
    
        public static JsonData success(Object data, String msg){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_SUCCESS);
            jsonData.data = data;
            jsonData.msg = msg;
            return jsonData;
        }
    
        public static JsonData success(Object data){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_SUCCESS);
            jsonData.data = data;
            return jsonData;
        }
    
        public static JsonData success(){ 
            return new JsonData(HTTP_STATUS_SUCCESS);
        }
    
        /** * 返回成功信息 * @param msg * @return */
        public static JsonData success(String msg){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_SUCCESS);
            jsonData.msg = msg;
            return jsonData;
        }
    
        /** * 返回失败信息 * @param msg * @return */
        public static JsonData fail(String msg){ 
            JsonData jsonData = new JsonData(HTTP_STATUS_FAIL);
            jsonData.msg = msg;
            return jsonData;
        }
    
        public Map<String,Object> toMap(){ 
            HashMap<String,Object> result = new HashMap<String, Object>();
            result.put("code",code);
            result.put("msg",msg);
            result.put("data",data);
            return result;
        }
    
    }

TraverseForJsonDataUtil源码：

package com.lyc.utils;
    
    import com.lyc.common.CommonType;
    import com.lyc.common.JsonData;
    import lombok.NoArgsConstructor;
    import lombok.extern.slf4j.Slf4j;
    
    /** * TraverseForJsonDataUtil工具类，主要是用于遍历枚举，然后以JsonData类型返回给前台 */
    @Slf4j
    @NoArgsConstructor
    public class TraverseForJsonDataUtil { 
    
        /** * 返回一个TraverseUtil实例 * @return */
        public static TraverseForJsonDataUtil newTraverseForResultDataUtil(){ 
            return new TraverseForJsonDataUtil();
        }
    
        /** * 循环遍历登陆类型，返回类型匹配的结果 * @param code * @return */
        public JsonData loginSatusTraverse(int code){ 
            for(CommonType.LoginStatus loginStatus : CommonType.LoginStatus.values()){ 
                if(code == loginStatus.getCode()){ 
                    log.info("返回的结果——提示信息：{},code值：{}",loginStatus.getMsg(),loginStatus.getCode());
                    //将当前匹配的ResultData结果值返回
                    return new JsonData(loginStatus.getMsg(),loginStatus.getCode());
                }
            }
            //如果没有匹配项，则直接返回null
            return null;
        }
    
    }

# 单元测试用例： #

TraverseForJsonDataUtilTest源码：

package com.lyc.utils;
    
    import com.lyc.common.JsonData;
    import lombok.extern.slf4j.Slf4j;
    import org.junit.jupiter.api.BeforeAll;
    import org.junit.jupiter.api.Test;
    
    @Slf4j
    public class TraverseForJsonDataUtilTest { 
    
       private static int code;
    
       /** * 初始化状态值 */
       @BeforeAll
       public static void init(){ 
           code = 7;
           log.info("返回的状态code值：{}",code);
       }
    
       /** * TraverseForJsonDataUtil测试用例 */
       @Test
       public void testTraverseForJsonDataUtil(){ 
           JsonData jsonData = TraverseForJsonDataUtil.newTraverseForResultDataUtil().loginSatusTraverse(code);
           if(null != jsonData){ 
               log.info("返回的结果——提示信息：{},code值：{}",jsonData.getMsg(),jsonData.getCode());
           }
       }
    
    }

## 测试结果 ##

[15:25:55.377] INFO  com.lyc.utils.TraverseForJsonDataUtilTest 19 init - 返回的状态code值：7
    [15:25:55.389] INFO  com.lyc.utils.TraverseForJsonDataUtil 31 loginSatusTraverse - 返回的结果——提示信息：账号不存在！,code值：7
    [15:25:55.390] INFO  com.lyc.utils.TraverseForJsonDataUtilTest 29 testTraverseForJsonDataUtil - 返回的结果——提示信息：账号不存在！,code值：7