SpringBoot AOP导致service注入后是null的问题
作者：Xiao_zuo_ya
本文主要讲述了如何利用SpringAOP实现用户操作日志的记录,首先,引入SpringBoot的AOP依赖,然后,选择基于注解的形式来实现日志操作,以避免污染原有代码和逻辑,在理解了SpringBootAOP的一些注解后,需要记录用户的正常请求以及异常请求的信息
SpringBoot AOP导致service注入后是null
1.由于业务需求需要
记录用户操作日志，无疑需要使用到SpringAOP。
2.先引入SpringBoot的AOP maven 依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>3.实现这个日志操作可以有很多种方法
比如写拦截器，或者基于注解形式，在或者在原来写好的代码中添加也行，但是最后的一种无疑会污染原来的代码，同时会对原来的逻辑有一定污染，而现在的业务场景，所有的逻辑代码都已经编写完成，自测完成，而且查询接口的数量明显大于（增删改），而且用户的操作日志我们最关心的无疑是对数据的操作。所以选择基于注解的形式实现。
4.注解编写
上代码
@Retention(RetentionPolicy.RUNTIME)//元注解，定义注解被保留策略，一般有三种策略
//1、RetentionPolicy.SOURCE 注解只保留在源文件中，在编译成class文件的时候被遗弃
//2、RetentionPolicy.CLASS 注解被保留在class中，但是在jvm加载的时候北欧抛弃，这个是默认的声明周期
//3、RetentionPolicy.RUNTIME 注解在jvm加载的时候仍被保留
@Target({ElementType.METHOD}) //定义了注解声明在哪些元素之前
@Documented
public @interface SystemOperaLog {
//定义成员
String descrption() default "" ;//描述
String actionType() default "添加" ;//操作的类型，1、添加 2、修改 3、删除
}5.下面需要对SpringBoot AOP 中一些注解
了解一下
- @Aspect：描述一个切面类，定义切面类的时候需要打上这个注解
- @Configuration：spring-boot配置类
- @Pointcut：声明一个切入点，切入点决定了连接点关注的内容，使得我们可以控制通知什么时候执行。Spring AOP只支持Spring bean的方法执行连接点。所以你可以把切入点看做是Spring bean上方法执行的匹配。一个切入点声明有两个部分：一个包含名字和任意参数的签名，还有一个切入点表达式，该表达式决定了我们关注那个方法的执行。
注：作为切入点签名的方法必须返回void 类型
Spring AOP支持在切入点表达式中使用如下的切入点指示符：
- execution - 匹配方法执行的连接点，这是你将会用到的Spring的最主要的切入点指示符。
- within - 限定匹配特定类型的连接点（在使用Spring AOP的时候，在匹配的类型中定义的方法的执行）。
- this - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中bean reference（Spring AOP 代理）是指定类型的实例。
- target - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中目标对象（被代理的应用对象）是指定类型的实例。
- args - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中参数是指定类型的实例。
- @target - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中正执行对象的类持有指定类型的注解。
- @args - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中实际传入参数的运行时类型持有指定类型的注解。
- @within - 限定匹配特定的连接点，其中连接点所在类型已指定注解（在使用Spring AOP的时候，所执行的方法所在类型已指定注解）。
- @annotation - 限定匹配特定的连接点（使用Spring AOP的时候方法的执行），其中连接点的主题持有指定的注解。
其中execution使用最频繁，即某方法执行时进行切入。定义切入点中有一个重要的知识，即切入点表达式，我们一会在解释怎么写切入点表达式。
切入点意思就是在什么时候切入什么方法，定义一个切入点就相当于定义了一个“变量”，具体什么时间使用这个变量就需要一个通知。
即将切面与目标对象连接起来。
如例子中所示，通知均可以通过注解进行定义，注解中的参数为切入点。
spring aop支持的通知：
- @Before：前置通知：在某连接点之前执行的通知，但这个通知不能阻止连接点之前的执行流程（除非它抛出一个异常）。
- @AfterReturning ：后置通知：在某连接点正常完成后执行的通知，通常在一个匹配的方法返回的时候执行。
6.了解完以上步骤
需要做的是记录用户正常请求，以及异常请求需要记录的信息，对应一下实体操作
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
@ApiModel(value="SysOperaLog对象", description="")
public class SysOperaLog implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "log_id", type = IdType.AUTO)
private Integer logId;
@ApiModelProperty(value = "操作类型")
private String type;
@ApiModelProperty(value = "访问资源路径")
private String url;
@ApiModelProperty(value = "操作人员")
private String operaUser;
@ApiModelProperty(value = "方法名称")
private String methodName;
@ApiModelProperty(value = "访问携带参数")
private String params;
@ApiModelProperty(value = "远程ip地址")
private String ipAddress;
@ApiModelProperty(value = "访问时间")
@TableField("operaTime")
@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
private LocalDateTime operaTime;
@ApiModelProperty(value = "访问总时长单位毫秒")
@TableField("timeLong")
private Long timeLong;
@ApiModelProperty(value = "描述")
private String des;
@ApiModelProperty(value = "访问状态 0 访问成功 -1 访问失败")
private Integer visitState;
@ApiModelProperty(value = "异常信息")
private String exceptionDetail;
}7.用户正常请求
在用户正常请求头部加上自定义的注解
@PostMapping("/save")
@SystemOperaLog(descrption = "新增车位信息")
public Result saveParkLot(@ApiParam(name = "parkLotsDTO", value = "车位信息") @RequestBody ParkLotsDTO parkLotsDTO, BindingResult bindingResult) {
// 现在表示执行的验证出现错误
if (bindingResult.hasErrors()) {
// 获取全部错误信息
List<ObjectError> allErrors = bindingResult.getAllErrors();
String errorMsg = "";
if (!CollectionUtils.isEmpty(allErrors)) {
errorMsg = allErrors.get(0).getDefaultMessage();
}
return ResultSupport.fail(errorMsg);
} else {
parkLotsService.save(parkLotsDTO);
return ResultSupport.saveSuccess();
}
}8.在AOP中拦截进入该方法的前置操作以及异常操作
@Aspect
@Configuration
@Slf4j
public class SystemOperaLogAop {
@Autowired
private SysOperaLogMapper sysOperaLogMapper;
/***
* 定义controller切入点拦截规则，拦截SystemControllerLog注解的方法
*/
@Pointcut("@annotation(cn.hayll.parking.local.common.annotation.SystemOperaLog)")
public void controllerAspect(){}
/***
* 拦截控制层的操作日志
* @param joinPoint
* @return
* @throws Throwable
*/
@Around("controllerAspect()")
public Object recordLog(ProceedingJoinPoint joinPoint) throws Throwable {
//1、开始时间
long beginTime = System.currentTimeMillis();
//利用RequestContextHolder获取requst对象
ServletRequestAttributes requestAttr = (ServletRequestAttributes)RequestContextHolder.currentRequestAttributes();
String uri = requestAttr.getRequest().getServletPath();
//访问目标方法的参数 可动态改变参数值
Object[] args = joinPoint.getArgs();
//方法名获取
String methodName = joinPoint.getSignature().getName();
//可能在反向代理请求进来时，获取的IP存在不正确行 这里直接摘抄一段来自网上获取ip的代码
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
SysUserDetails sysUserDetails = (SysUserDetails) authentication.getPrincipal();
Signature signature = joinPoint.getSignature();
if(!(signature instanceof MethodSignature)) {
throw new IllegalArgumentException("暂不支持非方法注解");
}
//调用实际方法
Object object = joinPoint.proceed();
//获取执行的方法
MethodSignature methodSign = (MethodSignature) signature;
Method method = methodSign.getMethod();
//判断是否包含了 无需记录日志的方法
long endTime = System.currentTimeMillis();
//模拟异常
//System.out.println(1/0);
SysOperaLog systemLogDTO = new SysOperaLog();
systemLogDTO.setType(getAnnontationMethodDescription(joinPoint,1));
systemLogDTO.setUrl(uri);
systemLogDTO.setOperaUser(sysUserDetails.getUsername());
systemLogDTO.setMethodName(methodName);
systemLogDTO.setIpAddress(getIpAddr(requestAttr.getRequest()));
List list = CollectionUtils.arrayToList(args);
List arrayList = new ArrayList(list);
//移除操作需要将数组转换的集合类型在此转换为集合类型
Iterator iterator = arrayList.iterator();
while (iterator.hasNext()){
if(iterator.next().toString().contains("BeanPropertyBindingResult")){
iterator.remove();
break;
}
}
systemLogDTO.setParams(arrayList.toString());
systemLogDTO.setOperaTime(LocalDateTime.now());
systemLogDTO.setDes(getAnnontationMethodDescription(joinPoint,0));
systemLogDTO.setTimeLong(endTime - beginTime);
sysOperaLogMapper.insert(systemLogDTO);
return object;
}
//异常处理
@AfterThrowing(pointcut = "controllerAspect()",throwing="e")
public void doAfterThrowing(JoinPoint joinPoint, Throwable e) throws Throwable{
//1、开始时间
long beginTime = System.currentTimeMillis();
//利用RequestContextHolder获取requst对象
ServletRequestAttributes requestAttr = (ServletRequestAttributes)RequestContextHolder.currentRequestAttributes();
String uri = requestAttr.getRequest().getServletPath();
//访问目标方法的参数 可动态改变参数值
Object[] args = joinPoint.getArgs();
//方法名获取
String methodName = joinPoint.getSignature().getName();
//可能在反向代理请求进来时，获取的IP存在不正确行 这里直接摘抄一段来自网上获取ip的代码
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
SysUserDetails sysUserDetails = (SysUserDetails) authentication.getPrincipal();
Signature signature = joinPoint.getSignature();
if(!(signature instanceof MethodSignature)) {
throw new IllegalArgumentException("暂不支持非方法注解");
}
//获取执行的方法
MethodSignature methodSign = (MethodSignature) signature;
Method method = methodSign.getMethod();
//判断是否包含了 无需记录日志的方法
long endTime = System.currentTimeMillis();
//模拟异常
SysOperaLog systemLogDTO = new SysOperaLog();
systemLogDTO.setUrl(uri);
systemLogDTO.setType(getAnnontationMethodDescription(joinPoint,1));
systemLogDTO.setOperaUser(sysUserDetails.getUsername());
systemLogDTO.setMethodName(methodName);
systemLogDTO.setIpAddress(getIpAddr(requestAttr.getRequest()));
List list = CollectionUtils.arrayToList(args);
List arrayList = new ArrayList(list);
//移除操作需要将数组转换的集合类型在此转换为集合类型
Iterator iterator = arrayList.iterator();
while (iterator.hasNext()){
if(iterator.next().toString().contains("BeanPropertyBindingResult")){
iterator.remove();
break;
}
}
systemLogDTO.setParams(arrayList.toString());
systemLogDTO.setOperaTime(LocalDateTime.now());
systemLogDTO.setTimeLong(endTime - beginTime);
systemLogDTO.setDes(getAnnontationMethodDescription(joinPoint,0));
systemLogDTO.setVisitState(-1);
systemLogDTO.setExceptionDetail(e.getMessage());
sysOperaLogMapper.insert(systemLogDTO);
}
public static String getIpAddr(HttpServletRequest request) {
String ipAddress = null;
try {
ipAddress = request.getHeader("x-forwarded-for");
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("WL-Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getRemoteAddr();
if (ipAddress.equals("127.0.0.1")) {
// 根据网卡取本机配置的IP
InetAddress inet = null;
try {
inet = InetAddress.getLocalHost();
} catch (UnknownHostException e) {
log.error("获取ip异常：{}" ,e.getMessage());
e.printStackTrace();
}
ipAddress = inet.getHostAddress();
}
}
// 对于通过多个代理的情况，第一个IP为客户端真实IP,多个IP按照','分割
if (ipAddress != null && ipAddress.length() > 15) {
// = 15
if (ipAddress.indexOf(",") > 0) {
ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
}
}
} catch (Exception e) {
ipAddress = "";
}
return ipAddress;
}
/***
* 获取controller的操作信息
* @param point
* @return
*/
public String getAnnontationMethodDescription(JoinPoint point,Integer type) throws Exception{
//获取连接点目标类名
String targetName = point.getTarget().getClass().getName() ;
//获取连接点签名的方法名
String methodName = point.getSignature().getName() ;
//获取连接点参数
Object[] args = point.getArgs() ;
//根据连接点类的名字获取指定类
Class targetClass = Class.forName(targetName);
//获取类里面的方法
Method[] methods = targetClass.getMethods() ;
String description="" ;
for (Method method : methods) {
if (method.getName().equals(methodName)){
Class[] clazzs = method.getParameterTypes();
if (clazzs.length == args.length){
if(type==0){
description = method.getAnnotation(SystemOperaLog.class).descrption();
break;
}else{
description = method.getAnnotation(SystemOperaLog.class).actionType();
break;
}
}
}
}
return description ;
}9.说一下踩的一个坑
现在日志已经可以正常工作了，但是业务代码却失效了，service注入的时候是空的（部分代码），
一顿百度以后发现，原来AOP只能对public 和provide 生效，如果你的方法限制是private，那么service注入就为空，在springboot 中默认使用的是cglib来代理操作对象，首先，私有方法是不会出现在代理类中，这也就是为什么代理对象无法对private操作的根本原因
- jdk是代理接口，私有方法必然不会存在在接口里，所以就不会被拦截到；
- cglib是子类，private的方法照样不会出现在子类里，也不能被拦截。
10.解决的根本办法
不是强制使用cglib来代理，而是要将你的controller中的方法不设置私有属性，以上仅仅代表个人观点哟。
总结
以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。