Spring自定义注解的实现与使用方式
作者:亿先生@
一、什么是注解?
注解就是一种标志,单独使用注解,就相当于在类、方法、参数和包上加上一个装饰,什么功能也没有,仅仅是一个标志,然后这个标志可以加上一些自己定义的参数。
就像下面这样,创建一个@interface的注解,然后就可以使用这个注解了,加在我们需要装饰的方法上,但是什么功能也没有。
public @interface AuthorityVerify { String value() default ""; }
二、聊聊 JAVA 自带的注解
1、定义
聊到Java注解,就不得不说@interface这个东西,它跟类(Class)、枚举(enum)、接口(interface)等一样,用于设置类型,比如下方的代码,就是一个注解类:
/** * 自定义权限校验接口 * * @author 亿先生 * @date 2024年1月23日18:57:15 */ @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface AuthorityVerify { String value() default ""; }
备注:
- 修饰符
- 访问修饰符必须为public,不写默认为pubic;
- 关键字
- 关键字为@interface;
- 注解名称
- 注解名称为自定义注解的名称,例如上面的XinLinLog 就是注解名称
- 注解类型元素
- 注解类型元素是注解中内容,根据需要标志参数,例如上面的注解的value;
2、元注解
说到注解就不得不说元注解,元注解就是作用在注解身上的,用来描述该注解的使用范围,接下来我们就来说说@Target、@Retention、@Document ed、@Inherited 这四大元注解的作用。
@Target
用于描述注解的使用范围,该注解可以使用在什么地方
Target类型 | 描述 |
---|---|
ElementType.TYPE | 应用于类、接口(包括注解类型)、枚举 |
ElementType.FIELD | 应用于属性(包括枚举中的常量) |
ElementType.METHOD | 应用于方法 |
ElementType.PARAMETER | 应用于方法的形参 |
ElementType.CONSTRUCTOR | 应用于构造函数 |
ElementType.LOCAL_VARIABLE | 应用于局部变量 |
ElementType.ANNOTATION_TYPE | 应用于注解类型 |
ElementType.PACKAGE | 应用于包 |
备注: 例如@Target(ElementType.METHOD),标志的注解使用在方法上,但是我们在这个注解标志在类上,就会报错
@Retention
表明该注解的生命周期
生命周期类型 | 描述 |
---|---|
RetentionPolicy.SOURCE | 编译时被丢弃,不包含在类文件中 |
RetentionPolicy.CLASS | JVM加载时被丢弃,包含在类文件中,默认值 |
RetentionPolicy.RUNTIME | 由JVM 加载,包含在类文件中,在运行时可以被获取到 |
@Documented
表明该注解标记的元素可以被Javadoc 或类似的工具文档化
@Inherited
是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。
如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
3、注解能用于哪些场景?
一般我们可以通过注解来实现一些重复的逻辑,就像封装了的一个方法,可以用在一些权限校验、字段校验、字段属性注入、保存日志、缓存
三、结合Spring AOP切面实现功能
上面总结的注解的定义,但是创建这样一个注解,仅仅是一个标志,装饰类、方法、属性的,并没有功能,要想实现功能,需要我们通过拦截器、AOP切面这些地方获取注解标志,然后实现我们的功能。
1、AOP是什么?
全称Aspect Oriented Programming,翻译过来就是大名鼎鼎的 “面向切面编程”,它是对面向对象的一种补充和完善。
场景:
数据源切换、事务管理、权限控制、日志打印等。
特点:
- ①侵入性小,几乎可以不改动原来逻辑的情况下把新的逻辑加入业务。
- ②实现方便,使用几个注解就可以实现,使系统更容易扩展。
- ③更好的复用代码,比如事务日志打印,简单逻辑适合所有情况。
2、注解的含义
注解 | 描述 |
---|---|
@Aspect | 切面。表示一个横切进业务的一个对象。它里面包含切入点(Pointcut)和Advice(通知)。 |
@Pointcut | 切入点。表示需要切入的位置,比如某些类或者某些方法,也就是先定一个范围。 |
@Before | Advice(通知)的一种,切入点的方法体执行之前执行。 |
@Around | Advice(通知)的一种,环绕切入点执行也就是把切入点包裹起来执行。 |
@After | Advice(通知)的一种,在切入点正常运行结束后执行。 |
@AfterReturning | Advice(通知)的一种,在切入点正常运行结束后执行,异常则不执行 |
@AfterThrowing | Advice(通知)的一种,在切入点运行异常时执行。 |
- 正常的执行顺序是:@Around ->@Before->主方法体->@Around中pjp.proceed()->@After->@AfterReturning
- 异常执行顺序为(Around中pjp.proceed()之前):@Around -> @After -> @AfterThrowing
- 异常执行顺序为(Around中pjp.proceed()之后):@Around ->@Before->主方法体->@Around中pjp.proceed()->@After->@AfterThrowing
扩展:Pointcut切入点的语法
/** * 1、使用within表达式匹配 * 下面示例表示匹配com.leo.controller包下所有的类的方法 */ @Pointcut("within(com.leo.controller..*)") public void pointcutWithin(){ } /** * 2、this匹配目标指定的方法,此处就是HelloController的方法 */ @Pointcut("this(com.leo.controller.HelloController)") public void pointcutThis(){ } /** * 3、target匹配实现UserInfoService接口的目标对象 */ @Pointcut("target(com.leo.service.UserInfoService)") public void pointcutTarge(){ } /** * 4、bean匹配所有以Service结尾的bean里面的方法, * 注意:使用自动注入的时候默认实现类首字母小写为bean的id */ @Pointcut("bean(*ServiceImpl)") public void pointcutBean(){ } /** * 5、args匹配第一个入参是String类型的方法 */ @Pointcut("args(String, ..)") public void pointcutArgs(){ } /** * 6、@annotation匹配是@Controller类型的方法 */ @Pointcut("@annotation(org.springframework.stereotype.Controller)") public void pointcutAnnocation(){ } /** * 7、@within匹配@Controller注解下的方法,要求注解的@Controller级别为@Retention(RetentionPolicy.CLASS) */ @Pointcut("@within(org.springframework.stereotype.Controller)") public void pointcutWithinAnno(){ } /** * 8、@target匹配的是@Controller的类下面的方法,要求注解的@Controller级别为@Retention(RetentionPolicy.RUNTIME) */ @Pointcut("@target(org.springframework.stereotype.Controller)") public void pointcutTargetAnno(){ } /** * 9、@args匹配参数中标注为@Sevice的注解的方法 */ @Pointcut("@args(org.springframework.stereotype.Service)") public void pointcutArgsAnno(){ } /** * 10、使用excution表达式 * execution( * modifier-pattern? //用于匹配public、private等访问修饰符 * ret-type-pattern //用于匹配返回值类型,不可省略 * declaring-type-pattern? //用于匹配包类型 * name-pattern(param-pattern) //用于匹配类中的方法,不可省略 * throws-pattern? //用于匹配抛出异常的方法 * ) * * 下面的表达式解释为:匹配com.leo.controller.HelloController类中以hello开头的修饰符为public返回类型任意的方法 */ @Pointcut(value = "execution(public * com.leo.controller.HelloController.hello*(..))") public void pointCut() { }
需要注意:上面的匹配的类型中支持或(||)与(&&)非(!)运算。
3、小Demo
①引入依赖包
<!--spring切面aop依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
②创建切面实现功能(这里以权限校验为例)
Ⅰ创建咱们的一个切面类
/** * 权限校验 切面实现 * * @author: 陌溪 * @create: 2020-03-06-19:05 */ @Aspect @Component @Slf4j public class AuthorityVerifyAspect { }
@Aspect: 切面。表示一个横切进业务的一个对象。它里面包含切入点(Pointcut)和Advice(通知)。
Ⅱ在切面类中创建一个用于扫描我们上面所用到的注解
@Pointcut(value = "@annotation(authorityVerify)") public void pointcut(AuthorityVerify authorityVerify) { }
@Pointcut: 切入点。表示需要切入的位置,比如某些类或者某些方法,也就是先定一个范围。
Ⅲ在创建一个通知方法
@Around(value = "pointcut(authorityVerify)") public Object doAround(ProceedingJoinPoint joinPoint, AuthorityVerify authorityVerify) throws Throwable { ServletRequestAttributes attribute = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attribute.getRequest(); //获取请求路径 String url = request.getRequestURI(); // 解析出请求者的ID和用户名 String adminUid = request.getAttribute(SysConf.ADMIN_UID).toString(); // 管理员能够访问的路径 String visitUrlStr = redisUtil.get(RedisConf.ADMIN_VISIT_MENU + RedisConf.SEGMENTATION + adminUid); LinkedTreeMap<String, String> visitMap = new LinkedTreeMap<>(); if (StringUtils.isNotEmpty(visitUrlStr)) { // 从Redis中获取 visitMap = (LinkedTreeMap<String, String>) JsonUtils.jsonToMap(visitUrlStr, String.class); } else { // 查询数据库获取 Admin admin = adminService.getById(adminUid); String roleUid = admin.getRoleUid(); Role role = roleService.getById(roleUid); String caetgoryMenuUids = role.getCategoryMenuUids(); String[] uids = caetgoryMenuUids.replace("[", "").replace("]", "").replace("\"", "").split(","); List<String> categoryMenuUids = new ArrayList<>(Arrays.asList(uids)); // 这里只需要查询访问的按钮 QueryWrapper<CategoryMenu> queryWrapper = new QueryWrapper<>(); queryWrapper.in(SQLConf.UID, categoryMenuUids); queryWrapper.eq(SQLConf.MENU_TYPE, EMenuType.BUTTON); queryWrapper.eq(SQLConf.STATUS, EStatus.ENABLE); List<CategoryMenu> buttonList = categoryMenuService.list(queryWrapper); for (CategoryMenu item : buttonList) { if (StringUtils.isNotEmpty(item.getUrl())) { visitMap.put(item.getUrl(), item.getUrl()); } } // 将访问URL存储到Redis中 redisUtil.setEx(RedisConf.ADMIN_VISIT_MENU + SysConf.REDIS_SEGMENTATION + adminUid, JsonUtils.objectToJson(visitMap), 1, TimeUnit.HOURS); } // 判断该角色是否能够访问该接口 if (visitMap.get(url) != null) { log.info("用户拥有操作权限,访问的路径: {},拥有的权限接口:{}", url, visitMap.get(url)); //执行业务 return joinPoint.proceed(); } else { log.info("用户不具有操作权限,访问的路径: {}", url); return ResultUtil.result(ECode.NO_OPERATION_AUTHORITY, MessageConf.RESTAPI_NO_PRIVILEGE); } }
@Around: Advice(通知)的一种,环绕切入点执行也就是把切入点包裹起来执行。
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。