前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >springboot整合aop实现请求参数的输出

springboot整合aop实现请求参数的输出

作者头像
码农王同学
发布2020-03-25 10:56:59
6950
发布2020-03-25 10:56:59
举报
文章被收录于专栏:后端Coder

Aop即面向切面编程,这次分享的是借助aop实现记录外部请求参数输出,这篇文章整理完后面还会输出20篇左右文章就要真正结束基础性内容的输出了,打算书写100篇左右的基础性文章,之前写的文章现在看来有点偏业务逻辑了加上日常的业务逻辑导致之前用的东西慢慢也忘记了很多,后面打算输出一些其它的内容,不然总是感觉有点原地踏步的意思。

我们先看下整个项目用到的pom文件,也就是使用aop这个技术点需要的jar包依赖。

代码语言:javascript
复制
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.wpw</groupId>
    <artifactId>a-o-p</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>a-o-p</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>、
            <version>2.2.4.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.10</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>5.2.3.RELEASE</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>
代码语言:javascript
复制
首先我们暂时定义一个基础的类,即User
package com.wpw.aop;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@Accessors(chain = true)
public class User {
    private String name;
    private Integer age;
}

上面的内容去除一些基本的get/set方法的生成,使用第三方库lombok进行简化代码的编写。

下面我们需要编写一个切面类,让其装入到spring容器。

代码语言:javascript
复制
package com.wpw.aop;

import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.Optional;

/**
 * @author pc
 */
@Aspect
@Component
@Order(1)
@Slf4j
public class AspectConfig {
    private static final Gson gson=new Gson();
    @Pointcut("execution(* com.wpw.aop..*.*(..))")
    private void webLog(){

    }
    @Before(value="webLog()")
    public void before(JoinPoint joinPoint){
         ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = requestAttributes.getRequest();
        log.info("验证请求日志的打印");
        log.info("请求地址:{}", Optional.ofNullable(request.getRequestURI().toString()).orElse(null));
        log.info("请求方式:{}",request.getMethod());
        log.info("请求类方法:{}",joinPoint.getSignature());
        log.info("请求类方法参数:{}", Arrays.toString(joinPoint.getArgs()));
    }
    @AfterReturning(returning = "o",pointcut = "webLog()")
    public void after(Object o){
        log.info("返回的内容:{}",gson.toJson(o));
    }
}
代码语言:javascript
复制
a.@Aspect注解,表示将这个类定义为一个切面类
b.@Component注解,表示将这个类装入spring容器进行管理
c.@Order注解,表示切面类的优先级处理
d.@Slf4j注解,表示使用其提供的log进行日志信息的输出

在切面类上我们先定义一个切点。

代码语言:javascript
复制
 @Pointcut("execution(* com.wpw.aop..*.*(..))")//这是一个表达式,应用于方法或者类的作用域的范围,所以可以根据具体情况自行定义
 private void webLog(){

 }

与此同时,我们可以根据下面的这行代码进行请求参数对象的获取。

代码语言:javascript
复制
ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();

上面的整个流程还是很易于理解的,启动我们的应用程序,然后执行下面的方法可以看到控制台日志参数的输出。

代码语言:javascript
复制
http://localhost:8080/aop/get

控制台日志参数的输出,也就是我们经常在服务器上看到的请求参数。

代码语言:javascript
复制
INFO 18816 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
INFO 18816 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
INFO 18816 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 9 ms
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 验证请求日志的打印
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 请求地址:/aop/get
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 请求方式:GET
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 请求类方法:User com.wpw.aop.UserController.getUser()
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 请求类方法参数:[]
INFO 18816 --- [nio-8080-exec-1] com.wpw.aop.AspectConfig                 : 返回的内容:{"name":"微信公众号~WwpwW","age":1}
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2020-01-27,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 码农王同学 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
容器服务
腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档