Использование AOP для записи журналов доступа к интерфейсу в приложениях SpringBoot

Spring Boot

Фактический адрес торгового центра проекта электронной коммерции SpringBoot:GitHub.com/macro-positive/…

Резюме

В этой статье в основном описывается применение АОП в проекте торгового центра и реализуется унифицированное ведение журнала доступа к интерфейсу путем создания аспекта на уровне контроллера.

AOP

АОП — это аббревиатура Аспектно-ориентированного программирования, что означает: Аспектно-ориентированное программирование, технология для достижения унифицированного обслуживания программных функций посредством предварительной компиляции и динамических агентов во время выполнения. Использование АОП может изолировать каждую часть бизнес-логики, тем самым уменьшая связь между каждой частью бизнес-логики, улучшая возможность повторного использования программы и повышая эффективность разработки.

Термины, связанные с АОП

Совет

Уведомления описывают работу, которую должен выполнить аспект, и время ее выполнения. Например, если нашему аспекту журнала необходимо записать продолжительность каждого вызова интерфейса, нам нужно записать текущее время до и после вызова интерфейса, а затем взять разницу.

  • Перед уведомлением (Before): вызовите функцию уведомления до вызова целевого метода;
  • Опубликовать уведомление (после): функция уведомления вызывается после вызова целевого метода, и возвращаемый результат метода не затрагивается;
  • Уведомление о возврате (AfterReturning): функция уведомления вызывается после успешного выполнения целевого метода;
  • Уведомление об исключении (AfterThrowing): функция уведомления вызывается после того, как целевой метод выдает исключение;
  • Совет вокруг (Around): совет оборачивает целевой метод, выполняя настраиваемые действия до и после вызова целевого метода.

Присоединяйся

Когда применяется функция уведомления. Например, когда вызывается метод интерфейса, это точка подключения аспекта ведения журнала.

Точечная резка

Pointcuts определяют область, к которой применяются функции уведомлений. Например, областью применения аспекта журнала являются все интерфейсы, то есть методы интерфейса всех слоев контроллера.

Аспект

Аспекты представляют собой комбинацию уведомлений и точек, которые определяют, когда и где применяются функции уведомлений.

Введение (Введение)

Добавляйте новые методы или свойства в существующий класс, не изменяя существующий класс.

Ткачество

Процесс применения аспекта к целевому объекту и создания нового прокси-объекта.

Использование аннотаций для создания аспектов в Spring

Связанные комментарии

  • @Aspect: используется для определения аспектов
  • @Before: метод уведомления будет выполнен до вызова целевого метода.
  • @After: метод уведомления будет выполнен после того, как целевой метод вернет или выдаст исключение.
  • @AfterReturning: метод уведомления будет выполнен после возврата целевого метода.
  • @AfterThrowing: метод уведомления будет выполнен после того, как целевой метод выдаст исключение.
  • @Around: метод уведомления будет инкапсулировать целевой метод.
  • @Pointcut: определяет выражение pointcut

выражение pointcut

Указывает область, к которой применяется уведомление, формат выражения:

execution(方法修饰符 返回类型 方法所属的包.类名.方法名称(方法参数)

//com.macro.mall.tiny.controller包中所有类的public方法都应用切面里的通知
execution(public * com.macro.mall.tiny.controller.*.*(..))
//com.macro.mall.tiny.service包及其子包下所有类中的所有方法都应用切面里的通知
execution(* com.macro.mall.tiny.service..*.*(..))
//com.macro.mall.tiny.service.PmsBrandService类中的所有方法都应用切面里的通知
execution(* com.macro.mall.tiny.service.PmsBrandService.*(..))

Добавить аспект AOP для реализации ведения журнала интерфейса

Добавить класс инкапсуляции информации журнала WebLog

Он используется для инкапсуляции записываемой информации журнала, включая описание операции, время, время потребления, URL-адрес, параметры запроса и результаты возврата.

package com.macro.mall.tiny.dto;

/**
 * Controller层的日志封装类
 * Created by macro on 2018/4/26.
 */
public class WebLog {
    /**
     * 操作描述
     */
    private String description;

    /**
     * 操作用户
     */
    private String username;

    /**
     * 操作时间
     */
    private Long startTime;

    /**
     * 消耗时间
     */
    private Integer spendTime;

    /**
     * 根路径
     */
    private String basePath;

    /**
     * URI
     */
    private String uri;

    /**
     * URL
     */
    private String url;

    /**
     * 请求类型
     */
    private String method;

    /**
     * IP地址
     */
    private String ip;

    /**
     * 请求参数
     */
    private Object parameter;

    /**
     * 请求返回的结果
     */
    private Object result;

    //省略了getter,setter方法
}

Добавьте класс аспекта WebLogAspect

Аспект ведения журнала определяется для получения информации, необходимой для регистрации в окружающем уведомлении, и применения ее ко всем общедоступным методам на уровне контроллера.

package com.macro.mall.tiny.component;

import cn.hutool.core.util.StrUtil;
import cn.hutool.core.util.URLUtil;
import cn.hutool.json.JSONUtil;
import com.macro.mall.tiny.dto.WebLog;
import io.swagger.annotations.ApiOperation;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * 统一日志处理切面
 * Created by macro on 2018/4/26.
 */
@Aspect
@Component
@Order(1)
public class WebLogAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * com.macro.mall.tiny.controller.*.*(..))")
    public void webLog() {
    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
    }

    @AfterReturning(value = "webLog()", returning = "ret")
    public void doAfterReturning(Object ret) throws Throwable {
    }

    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        //获取当前请求对象
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //记录请求信息
        WebLog webLog = new WebLog();
        Object result = joinPoint.proceed();
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method.isAnnotationPresent(ApiOperation.class)) {
            ApiOperation apiOperation = method.getAnnotation(ApiOperation.class);
            webLog.setDescription(apiOperation.value());
        }
        long endTime = System.currentTimeMillis();
        String urlStr = request.getRequestURL().toString();
        webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));
        webLog.setIp(request.getRemoteUser());
        webLog.setMethod(request.getMethod());
        webLog.setParameter(getParameter(method, joinPoint.getArgs()));
        webLog.setResult(result);
        webLog.setSpendTime((int) (endTime - startTime));
        webLog.setStartTime(startTime);
        webLog.setUri(request.getRequestURI());
        webLog.setUrl(request.getRequestURL().toString());
        LOGGER.info("{}", JSONUtil.parse(webLog));
        return result;
    }

    /**
     * 根据方法和传入的参数获取请求参数
     */
    private Object getParameter(Method method, Object[] args) {
        List<Object> argList = new ArrayList<>();
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            //将RequestBody注解修饰的参数作为请求参数
            RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);
            if (requestBody != null) {
                argList.add(args[i]);
            }
            //将RequestParam注解修饰的参数作为请求参数
            RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);
            if (requestParam != null) {
                Map<String, Object> map = new HashMap<>();
                String key = parameters[i].getName();
                if (!StringUtils.isEmpty(requestParam.value())) {
                    key = requestParam.value();
                }
                map.put(key, args[i]);
                argList.add(map);
            }
        }
        if (argList.size() == 0) {
            return null;
        } else if (argList.size() == 1) {
            return argList.get(0);
        } else {
            return argList;
        }
    }
}

Проведите тестирование интерфейса

Запустите проект и посетите:http://localhost:8080/swagger-ui.html

展示图片

Вы можете видеть, что следующая информация журнала будет напечатана в консоли:

{
	"result": {
		"code": 200,
		"data": {
			"total": 11,
			"totalPage": 11,
			"pageSize": 1,
			"list": [{
				"productCommentCount": 100,
				"name": "万和",
				"bigPic": "",
				"logo": "http://macro-oss.oss-cn-shenzhen.aliyuncs.com/mall/images/20180607/timg(5).jpg",
				"showStatus": 1,
				"id": 1,
				"sort": 0,
				"productCount": 100,
				"firstLetter": "W",
				"factoryStatus": 1
			}],
			"pageNum": 1
		},
		"message": "操作成功"
	},
	"basePath": "http://localhost:8080",
	"method": "GET",
	"parameter": [{
		"pageNum": 1
	}, {
		"pageSize": 1
	}],
	"description": "分页查询品牌列表",
	"startTime": 1561273191861,
	"uri": "/brand/list",
	"url": "http://localhost:8080/brand/list",
	"spendTime": 101
}

Адрес исходного кода проекта

GitHub.com/macro-positive/…

публика

проект торгового центраПолный набор учебных пособий сериализуется,Обратите внимание на публичный аккаунтПолучите это прямо сейчас.

公众号图片

Категории