自定义注解优化接口参数校验

　　在实际开发时，许多业务接口的入参非常复杂，比如会有多级的 JSON 嵌套或者混杂着各种数组。

　　这种时候如果我们将接口参数的拼装逻辑杂乱的写在 Controller 层，代码的可读性会非常差，后续接手的人员需要一个参数一个参数的比对着接口文档来推演参数的拼装逻辑。

　　在这种情况下，将接口调用参数封装为数据传输对象 dto ，配合自定义注解可大大的提高程序的可读性。

　　我们自定义一个注解来标识我们 dto 中的入参:

@Retention(RetentionPolicy.RUNTIME)
@Target(value = ElementType.FIELD)
public @interface ParamAnnotation {
    //是否必须参数
    public boolean isRequired() default false;

    //参数名称
    public String name();
}

　　注解包含两个属性，参数名称和是否必须参数。

　　这样，我们的代码由：

　　变为了：

　　明显的提高了可读性，同时我们可以将相关赋值逻辑封装在 dto 的构造函数中。

　　在每次进行接口调用前，我们可以通过反射遍历检查 dto 中的必传参数是否完整：

 /**
     * @Author Nxy
     * @Date 2020/3/24 19:49
     * @Param obj：需要验证的参数对象
     * @Return
     * @Exception
     * @Description 判断参数中必填项是否都已填写
     */
    public boolean isComplete(T obj) throws IllegalAccessException, NoSuchFieldException {
        Class objClass = obj.getClass();
        Field fields[] = objClass.getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(ParamAnnotation.class)) {
                field.setAccessible(true);
                ParamAnnotation paramAnnotation = field.getAnnotation(ParamAnnotation.class);
                //如果是必填项
                if (paramAnnotation.isRequired()) {
                    Object value = field.get(obj);
                    if (null == value) {
                        Object paraName = paramAnnotation.name();
                        //缺失项回写
                        Field deletion = objClass.getDeclaredField("deletion");
                        deletion.setAccessible(true);
                        deletion.set(obj, paraName);
                        return false;
                    }
                }
            }
        }
        return true;
    }

　　这样我们的外层逻辑由几十行代码变成了：

　　由 vo 得到 dto 参数，校验参数完整性。让 controller 只去关注调用逻辑，其余零碎的转换和校验模块化。

　　虽然反射降低了运行效率，但对于对性能要求不是特别高的场景，用这些代价换取代码的可读性是值得的。

自定义注解优化接口参数校验

猜你喜欢