java之springboot的自定义注解的使用

java编写自定义注解还是不难的,一般多用于鉴权之类的。

1.首先新建一个Annotation如图所示,我用的开发工具是idea。


2.建好之后需要在类上面加上

@Target

@Retention

@Documented

三个注解。

其中

@Target :注解作用的目标

我们看一下Target中的源码


我们点开ElementType,如图。表示目标可以是这些,大家见名知意。

ElementType.TYPE:接口、类、枚举、注解

ElementType.FIELD:字段、枚举的常量

ElementType.METHOD:方法

ElementType.PARAMETER:方法参数

ElementType.CONSTRUCTOR:构造函数

ElementType.LOCAL_VARIABLE:局部变量

ElementType.ANNOTATION_TYPE:注解

ElementType.PACKAGE:


我们点开@Retention


我们继续点开RetentionPolicy,图片是部分


RetentionPolicy.SOURCE:注解仅存在于源码中,在class字节码文件中不包含

RetentionPolicy.CLASS:默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得

RetentionPolicy.RUNTIME:注解会在class字节码文件中存在,在运行时可以通过反射获取到

 @Document:说明该注解将被包含在javadoc中。

解释完之后上干货,操作一下子。我这里写的是登录权限验证token,即验证接口是否需要登录:

我们先创建一个Annotation的java文件

然后加上@Target @Retention @Document这三个注解

括号里面的你们可以自行选择。

注解有了,我们需要写怎么实现使用这个注解后去验证。

在这里我们讲一下这个接口:HandlerInterceptor

这个接口定义了三个方法,分别是:

1. default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

throws Exception {

return true;

}

2. default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,

      @Nullable ModelAndView modelAndView)throws Exception {

}

3. default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,

      @Nullable Exception ex)throws Exception {

}

preHandle:在业务处理器处理请求之前被调用。预处理,可以进行编码、安全控制、权限校验等处理;

postHandle:在业务处理器处理请求执行完成后,生成视图之前执行。后处理(调用了Service并返回ModelAndView,但未进行页面渲染),有机会修改ModelAndView (这个博主就基本不怎么用了);

afterCompletion:在DispatcherServlet完全处理完请求后被调用,可用于清理资源等。返回处理(已经渲染了页面);

我们新建一个UserInterceptor类去实现这个HandlerInterceptor接口,因为是要鉴定接口中的方法是否需要登录权限,所以我们需要重写preHandle方法:


然后我们需要在preHandle方法里去写我们实现登录权限验证token判断用户是否登录:

还记得Retention里面的RUNTIME吗,这次要用到了,我们需要用到反射。

我们在preHandle方法里先写一个if判断


解释一下isAssignableFrom()方法和instanceof的区别:

isAssignableFrom()方法是从类继承的角度去判断,instanceof关键字是从实例继承的角度去判断。

isAssignableFrom()方法是判断是否为某个类的父类,instanceof关键字是判断是否某个类的子类。

HandlerMethod类详解:我们看一下源码(图中为部分源码)

HandleMethod是SpringMVC中处理请求的方法。

然后我们在preHandle方法中通过获得请求头的方法获得用户token:

String token = request.getHeader("token");

if (Strings.isNullOrEmpty(token)) {

token = request.getParameter("token");

}

获得请求方法类和所属类:

HandlerMethod handlerMethod = (HandlerMethod) handler;

Method method = handlerMethod.getMethod();

Class clazz = method.getDeclaringClass();

// 需要登录

if (clazz.isAnnotationPresent(LoginRequired.class)

|| method.isAnnotationPresent(LoginRequired.class)) {

// 没有传Token

    if (Strings.isNullOrEmpty(token)) {

        throw new RuntimeException("请求异常");

    }

isAnnotationPresent()方法详解:

例:F.isAnnotationPresent(G.class);

G类型的注解是否在F类上

最后查询此token是否存在。

如果存在的话,我们可以把信息传给我们

一个自定义注解验证接口是否需要登录就完成啦。

注意:UserInterceptor类上需要加上@Component注解,因为需要被扫描到。

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

推荐阅读更多精彩内容