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

  在实际开发时,许多业务接口的入参非常复杂,比如会有多级的 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 只去关注调用逻辑,其余零碎的转换和校验模块化。

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

posted @   牛有肉  阅读(1200)  评论(1编辑  收藏  举报
编辑推荐:
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
· 从 HTTP 原因短语缺失研究 HTTP/2 和 HTTP/3 的设计差异
· AI与.NET技术实操系列:向量存储与相似性搜索在 .NET 中的实现
· 基于Microsoft.Extensions.AI核心库实现RAG应用
阅读排行:
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 【译】Visual Studio 中新的强大生产力特性
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
点击右上角即可分享
微信分享提示