Java自定义注解编写

该文章将编写一个自定义注解,检测前端传入的json格式字符串是否包含某些字段

基本语法:

  • 元注解
    1. @Target:限定注解应用范围,value可以为数组
      TYPEFIELDMETHODPARAMETERCONSTRUCTORLOCAL_VARIABLEANNOTATION_TYPEPACKAGE
    2. @Retention:修饰注解的生命力(SOURCECLASSRUNTIME)
    3. @Documented:注解随着被定义的java文件生成到JavaDoc文档当中。
    4. @Inherited:类继承关系中,子类会继承父类使用的注解中被@Inherited修饰的注解。只在@Target被定义为TYPE时起作用
  • 使用@interface修饰类
  • 注解类型元素
    1. 注解类型元素必须为public,不写默认为public
    2. 类型只能是基本数据类型、String、Class、枚举、注解或者以上类型的数组
    3. 只有一个value元素时,使用注解时可以省略value=, 即@JsonParamsError(value = "hahah") === @JsonParamsError("hahah")
      没有元素时,使用注解时可以省略(), 即@JsonParamsErro() === @JsonParamsErro
      数组类型元素只需要填一个值时可以省略{}, 即@JsonParamsError(arr = {"hahah"}) === @JsonParamsError(arr = "hahah")
    4. default代表默认值,如果没有指定默认值,那么使用的时候必须显示指定
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonParamsError{
    String desc() default "";
    String[] params();
}

通过aop实现注解功能:

  • 声明切入点
  • 将Signature强转为MethodSignature获取Method,通过Method获取对应注解
  • 获取方法的参数,执行相应逻辑
  • 执行方法
@Slf4j
@Component
@Aspect
public class JsonParamsAspect {

    //定义注解的切入点
    @Pointcut("@annotation(com.example.commondframe.annotation.JsonParamsError)")
    public void caughtJsonParseError(){}

    //使用环绕通知的方式
    // ProceedingJoinPoint 是使用Around特有的,该类比JoinPoint多了方法的执行
    @Around(value = "caughtJsonParseError()")
    public Object jsonParseErrorAround(ProceedingJoinPoint joinPoint) throws Throwable {
        Signature signature = joinPoint.getSignature();     //获取方法签名
        MethodSignature methodSignature = (MethodSignature) signature;  
        Method method = methodSignature.getMethod();
        JsonParamsError jsonParamsError = method.getAnnotation(JsonParamsError.class);  //获取方法修饰的JsonParamsError注解
        String desc = jsonParamsError.desc();       //获取JsonParamsError注解的desc属性
        String[] params = jsonParamsError.params(); //获取JsonParamsError注解的params属性
        Object o = joinPoint.getArgs()[0];          //获取方法的第一个参数
        JSONObject data = null;
        if( o instanceof JSONObject ){              //如果是JSONObject实例, 强转为JSONObject
            data = (JSONObject) o;
        }else if( o instanceof String ){            //如果是String类型,转换为JSONObject
            data = JSON.parseObject((String)o);
        }else{                                      //否则为错误类型
            log.error("{}, 方法{}, 错误参数类型", desc, method.getName());
            return Error.error("参数有误!");
        }
        for(String param : params){                 //遍历传入的params属性,判断是否都在JSONObject中存在
            if( !data.containsKey(param) ){
                log.error("{}, 方法{}, 参数{}不存在", desc, method.getName(), param);
                return Error.error("参数有误!");
            }
        }
        return joinPoint.proceed();                 //执行方法
    }

}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容