Spring实现自定义注解

一, 背景

目前部门有一个培训,需要讲一下Spring的使用,看到有同学提出问题,想自定义实现一个打日志的注解,下面就记录一下实现过程。

环境:

Spring 6.1.5, 不使用Spring Boot.

二,实现步骤

1, 引入Spring和Spring AOP相关依赖

<dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>

2,在springmvc-servlet.xml里添加配置(这里的springmvc-servlet.xml是在web.xml中指定的servlet标签里名称决定的)。

复制代码
<aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>

3,新建一个注解

java 复制代码
import java.lang.annotation.*;


@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyLog {
}

4,新增一个切面

java 复制代码
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class MyLogAspect {
    @Pointcut("@annotation(com.xxx.xxx.config.MyLog)")
    public void dsPointCut() {
    }

    @Before("dsPointCut()")
    public void doBefore() throws Throwable {
        System.out.println("我从before到注解的切点了");

    }

    @After("dsPointCut()")
    public void doAfter() {
        System.out.println("我从after退出了");
    }

    @Around("dsPointCut()")
    public Object doAround(ProceedingJoinPoint point) throws Throwable {
        System.out.println("我从around到注解的切点了");
        Object result = point.proceed();
        System.out.println("我从around退出了");
        return result;
    }
}

这里需要注意一点: point.proceed();表示程序继续运行, 然后拿到Object result, 一定要返回,不然被切面命中的方法会没有返回值, 也就是around这个处理要有返回值(因为它这个方法是自己定义,可以设置成void)。

5, 使用注解

java 复制代码
import com.xxx.xxx.config.MyLog;
import com.xxx.xxx.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping(value="/user")
public class UserController {
    @Autowired
    private UserService userService;

    @RequestMapping(value="/list", method= RequestMethod.GET)
    @MyLog
    public String getUser(@RequestParam(value="name")  String name) {
        System.out.println(userService.getName());

        List<String> nameList = userService.getUserNames();
        nameList.stream().forEach(a -> System.out.println(a));
        return "hahaha";
    }


}

6, 运行项目,调用接口,可以看到打印出想要的日志

三,总结

具体原理网络上一大堆,但是没有看到有人用Spring去实现,其他人实现的基本上都是用了SpringBoot,没有参考意义。

希望对你有帮助!

相关推荐
daqinzl3 分钟前
java获取机器ip、mac
java·mac·ip
激流丶19 分钟前
【Kafka 实战】如何解决Kafka Topic数量过多带来的性能问题?
java·大数据·kafka·topic
Themberfue22 分钟前
Java多线程详解⑤(全程干货!!!)线程安全问题 || 锁 || synchronized
java·开发语言·线程·多线程·synchronized·
让学习成为一种生活方式39 分钟前
R包下载太慢安装中止的解决策略-R语言003
java·数据库·r语言
晨曦_子画1 小时前
编程语言之战:AI 之后的 Kotlin 与 Java
android·java·开发语言·人工智能·kotlin
假装我不帅1 小时前
asp.net framework从webform开始创建mvc项目
后端·asp.net·mvc
南宫生1 小时前
贪心算法习题其三【力扣】【算法学习day.20】
java·数据结构·学习·算法·leetcode·贪心算法
神仙别闹1 小时前
基于ASP.NET+SQL Server实现简单小说网站(包括PC版本和移动版本)
后端·asp.net
Heavydrink1 小时前
HTTP动词与状态码
java