SpringAop实现日志记录功能

AOP(面向切面编程)

AOP是OOP的延续,是软件开发中的一个热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高了开发的效率。

AOP术语

AOP 领域中的特性术语:

  • 通知(Advice): AOP 框架中的增强处理。通知描述了切面何时执行以及如何执行增强处理。
  • 连接点(join point): 连接点表示应用执行过程中能够插入切面的一个点,这个点可以是方法的调用、异常的抛出。在 Spring AOP 中,连接点总是方法的调用。
  • 切点(PointCut): 可以插入增强处理的连接点。
  • 切面(Aspect): 切面是通知和切点的结合。
  • 引入(Introduction):引入允许我们向现有的类添加新的方法或者属性。
  • 织入(Weaving): 将增强处理添加到目标对象中,并创建一个被增强的对象,这个过程就是织入

AOP实例

AOP的实现有几种方式,这里我们用Aspect(切面)来实现一个日志记录的功能

1.基于SpringBoot项目添加依赖

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2.自定义注解

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

}

3.定义日志记录实体类

@Data
public class LogRecord {

    //访问用户
    private String userName;

    //访问时间
    private String startTime;

    //接口地址
    private String url;

    //请求方式
    private String method;

    //访问者ip地址
    private String ip;

    @Override
    public String toString() {
        return "LogRecord{" +
                "userName='" + userName + '\'' +
                ", startTime='" + startTime + '\'' +
                ", url='" + url + '\'' +
                ", method='" + method + '\'' +
                ", ip='" + ip + '\'' +
                '}';
    }
}

4.定义日志切面类

/**
 * 日志切面类
 */
@Aspect
@Component
public class LogAspect {

    private final static Logger log = LoggerFactory.getLogger(LogAspect.class);

    /**
     * 切点
     */
//  @Pointcut("execution(* com.csdn.controller..*.*(..))")
    @Pointcut("@annotation(com.csdn.annotation.WebLog)")
    private void LogAspectPointcut(){};

    /**
     * 前置通知
     * 通知方法会在目标方法调用之前执行
     * @param joinPoint 连接点
     */
    @Before("LogAspectPointcut()")
    public void doBefore(JoinPoint joinPoint) {
        //获取当前请求对象
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        SimpleDateFormat sim=new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String time=sim.format(new Date());
        LogRecord logRecord = new LogRecord();
        logRecord.setIp(request.getRemoteAddr());
        logRecord.setMethod(request.getMethod());
        logRecord.setUrl(request.getRequestURL().toString());
        logRecord.setStartTime(time);
        logRecord.setUserName("测试用户");

        //输出日志
        log.info(logRecord.toString());

    }
}

5.接口类

@RestController
@RequestMapping("/log")
public class LogController {

    @WebLog
    @GetMapping("")
    public String getList(){
        return "{\"message\":\"SUCCESS\",\"code\":200}";
    }

}

6.用PostMan访问接口

aop接口.png

7.日志记录结果

2021-05-23 19:04:42.362  INFO 14800 --- [nio-9020-exec-1] com.csdn.aspect.LogAspect                : LogRecord{userName='测试用户', startTime='2021-05-23 19:04:42', url='http://127.0.0.1:9020/log/', method='GET', ip='127.0.0.1'}

完美记录日志

@Pointcut的另一种表达形式(execution)

例:execution(* com.csdn.controller...(..)) 代表切com.csdn.controller包下所有类
整个表达式可以分为五个部分:
1、execution()::表达式主体。
2、第一个号:表示返回类型, 号表示所有的类型。
3、包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,com.sample.service包、子包下所有类的方法。
4、第二个
号:表示类名,
号表示所有的类。
5、(..):最后这个星号表示方法名,号表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数

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

推荐阅读更多精彩内容

  • 目录 一、Spring是什么 二、常见问题与核心概念 工厂与反射等循环依赖如何解决 核心概念- 拓展接口:bean...
    全栈无用阅读 963评论 0 1
  • 在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式...
    千淘萬漉阅读 5,175评论 3 9
  • AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期间...
    丿星纟彖彳亍阅读 430评论 0 1
  • target 了解什么是Spring了解Spring产生的背景了解Spring的生态体系掌握如何编写一个Sprin...
    yi只特立独行地zhu阅读 1,387评论 0 23
  • 1.集合有哪些?数据结构?初始长度?扩容机制?哪些是线程安全的?hashmap的底层原理? 集合类型主要有3种:s...
    烂泥lanni阅读 1,597评论 0 1