spring aop 自動(dòng)打印接口的出入?yún)ⅲ屇愀鼘W⒂跇I(yè)務(wù)邏輯

簡(jiǎn)介

AOP意為“面向切面編程”,這樣的名字并不是非常容易理解,且容易產(chǎn)生一些誤導(dǎo)。AOP是新一代軟件開發(fā)方式”,在Spring中提供了面向切面編程的豐富支持,允許通過(guò)分離應(yīng)用的業(yè)務(wù)邏輯與系統(tǒng)級(jí)服務(wù)(例如審計(jì)(auditing)和事務(wù)(transaction)管理)進(jìn)行內(nèi)聚性的開發(fā)。應(yīng)用對(duì)象只實(shí)現(xiàn)它們應(yīng)該做的——完成業(yè)務(wù)邏輯——僅此而已。它們并不負(fù)責(zé)(甚至是意識(shí))其它的系統(tǒng)級(jí)關(guān)注點(diǎn),例如日志或事務(wù)支持。
AOP主要功能有 日志記錄,性能統(tǒng)計(jì),安全控制,事務(wù)處理,異常處理。

OK,教程走起。。。。(看完保證你不再手動(dòng)打印出入?yún)⒘松?/em>)

PS:本教程是基于spring boot項(xiàng)目講解的

1、第一步肯定是新建項(xiàng)目,引入依賴?yán)?/h2>

pom文件如下:

<?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.4.8</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>springboot-logback-async</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-logback-async</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</artifactId>
        </dependency>
        <!-- 構(gòu)建成可運(yùn)行的Web項(xiàng)目 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
                <!--  AOP 依賴必須加進(jìn)來(lái)-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>
        <!-- 打印日志需要 -->
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.8.5</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

2、新建兩個(gè)實(shí)體類 UserDto、Result,代碼如下:

import lombok.Data;

/**
 * body入?yún)? */
@Data
public class UserDto {
    private String userId;
    private String userName;
}
import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * 返回對(duì)象
 * @param <T>
 */
@Data
@AllArgsConstructor
public class Result<T> {

    private static final int success = 0;
    private static final int fail = -1;

    private static final String successMsg = "請(qǐng)求成功";
    private static final String failMsg = "請(qǐng)求失敗";

    private int code;
    private String message;
    private T data;
    
    public static <T> Result<T> returnSuccess(T data) {
        return new Result<T>(success, successMsg, data);
    }

    public static <T> Result<T> returnFail(T data) {
        return new Result<T>(fail, failMsg, null);
    }
}

3、新建一個(gè)測(cè)試接口類InitRest

import com.example.demo.dto.UserDto;
import com.example.demo.model.Result;
import org.springframework.web.bind.annotation.*;

//使用restful風(fēng)格
@RestController
public class InitRest {
    //測(cè)試get入?yún)?    @GetMapping("/hello")
    public Result<String> hello(@RequestParam String userId) {
        return Result.returnSuccess("Hello get...");
    }
    //測(cè)試body入?yún)?    @PostMapping("/hello")
    public Result<UserDto> hello(@RequestBody UserDto userDto) {
        userDto.setUserId("你的名字被修改啦。。。");
        return Result.returnSuccess(userDto);
    }
}

4、關(guān)鍵的一步,新建一個(gè)AOP類:WebLog.java

import com.google.gson.Gson;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.util.UUID;

@Slf4j
//下面兩個(gè)注解是必須的,少一個(gè)都不行哦
@Aspect
@Configuration
public class WebLog {

    //標(biāo)記切入點(diǎn),為指定包下的所有類的所有public方法
    @Pointcut(value = "execution(public * com.example.demo.rest.*.* (*))")
    public void webLog() {
    }

    @Around(value = "webLog()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        String requestId = UUID.randomUUID().toString().replace("-", "");
        //打印入?yún)?        log.info("requestId={},請(qǐng)求入?yún)?{}", requestId, new Gson().toJson(joinPoint.getArgs()));

        Object object = joinPoint.proceed();
        //打印出參
        log.info("requestId={},請(qǐng)求出參 {}", requestId, new Gson().toJson(object));
        return object;
    }
}

5、OK,整完了,看一下目前的目錄結(jié)構(gòu):

目錄結(jié)構(gòu)

6、啟動(dòng)項(xiàng)目,訪問(wèn)接口,注意看日志打印哦

啟動(dòng)成功

get請(qǐng)求

get請(qǐng)求日志

post請(qǐng)求

post請(qǐng)求日志

OK,完美實(shí)現(xiàn),出入?yún)⑷罩敬蛴。朔ê?jiǎn)單又方便,你領(lǐng)會(huì)了嘛???

關(guān)于此教程用到的幾個(gè)注解,有不太清楚的朋友可留言詢問(wèn)哦!

OK,若覺(jué)得本文還不錯(cuò),記得點(diǎn)贊評(píng)論加轉(zhuǎn)發(fā)哦

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容