Aop实现日志功能

众所周知AOP（Aspect-OrientedProgramming，面向方面编程），可以说是OOP（Object-Oriented Programing，面向对象编程）的补充和完善。可以对业务方法进行扩展，常用在缓存，日志、权限等方面。这里我用aop对日志进行一个小demo演示，帮助自己更好的理解和使用aop的功能。
本案例基于一个小的增删改查的demo，用springboot+mybatisPlus快速搭建的crud ，然后再其功能上加上aop的使用，将每个方法进行一个日志记录。这里主要讲述aop的使用过程，项目环境的基本搭建就不阐述了，如有需要可自行百度

1、创建表和日志实体

• sys_log 表

CREATE TABLE `sys_log`  (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `username` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '用户名',
  `operation` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '用户操作',
  `method` varchar(200) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '请求方法',
  `params` varchar(5000) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '请求参数',
  `time` bigint(20) NOT NULL COMMENT '执行时长(毫秒)',
  `ip` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT 'IP地址',
  `create_date` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '系统日志' ROW_FORMAT = Dynamic;

• SysLogEntity 实体

@Data
@TableName("sys_log")
public class SysLogEntity implements Serializable {
    private static final long serialVersionUID = 1L;
    @TableId
    private Long id;
    //用户名
    private String username;
    //用户操作
    private String operation;
    //请求方法
    private String method;
    //请求参数
    private String params;
    //执行时长(毫秒)
    private Long time;
    //IP地址
    private String ip;
    //创建时间
    private Date createDate;

}

2、编写dao、service类

这里使用的是mybatisPlus，内部封装了基本方法

@Mapper
public interface SysLogDao extends BaseMapper<SysLogEntity> {
	
}


//service接口
public interface SysLogService extends IService<SysLogEntity> {
}
//service实现类
@Service("sysLogService")
public class SysLogServiceImpl extends ServiceImpl<SysLogDao, SysLogEntity> implements SysLogService {

}

3、导入maven依赖

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

4、编写注解和切面类

• SysLog

/**
 * 系统日志注解
 *
 * @author lincheng
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

	String value() default "";
}

• SysLogAspect 切面类

/**
 * 系统日志，切面处理类
 *
 * @author lincheng
 */
@Aspect
@Component
public class SysLogAspect {
	@Autowired
	private SysLogService sysLogService;
	
	//定义切点 切点表达式指向SysLog注解，我们再业务方法上可以加上SysLog注解，然后所标注
	//的方法都能进行日志记录
	@Pointcut("@annotation(com.lin.annotation.SysLog)")
	public void logPointCut() { 
		
	}

	@Around("logPointCut()")
	public Object around(ProceedingJoinPoint point) throws Throwable {
		long beginTime = System.currentTimeMillis();
		//执行方法
		Object result = point.proceed();
		//执行时长(毫秒)
		long time = System.currentTimeMillis() - beginTime;

		//保存日志
		saveSysLog(point, time);

		return result;
	}

	private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {
		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
		Method method = signature.getMethod();

		SysLogEntity sysLog = new SysLogEntity();
		SysLog syslog = method.getAnnotation(SysLog.class);
		if(syslog != null){
			//注解上的描述
			sysLog.setOperation(syslog.value());
		}

		//请求的方法名
		String className = joinPoint.getTarget().getClass().getName();
		String methodName = signature.getName();
		sysLog.setMethod(className + "." + methodName + "()");

		//请求的参数
		Object[] args = joinPoint.getArgs();
		try{
			String params = Arrays.toString(args);
			sysLog.setParams(params);
		}catch (Exception e){

		}

		//获取request
		HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
		//设置IP地址
		sysLog.setIp(IPUtils.getIpAddr(request));

		sysLog.setTime(time);
		sysLog.setCreateDate(new Date());
		//保存系统日志
		sysLogService.save(sysLog);
	}
}

5、配置所需要的工具类

• HttpContextUtils

public class HttpContextUtils {

    public static HttpServletRequest getHttpServletRequest() {
        return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
    }

    public static String getDomain(){
        HttpServletRequest request = getHttpServletRequest();
        StringBuffer url = request.getRequestURL();
        return url.delete(url.length() - request.getRequestURI().length(), url.length()).toString();
    }

    public static String getOrigin(){
        HttpServletRequest request = getHttpServletRequest();
        return request.getHeader("Origin");
    }
}

• IPUtils

public class IPUtils {
	private static Logger logger = LoggerFactory.getLogger(IPUtils.class);

	/**
	 * 获取IP地址
	 * 
	 * 使用Nginx等反向代理软件， 则不能通过request.getRemoteAddr()获取IP地址
	 * 如果使用了多级反向代理的话，X-Forwarded-For的值并不止一个，而是一串IP地址，X-Forwarded-For中第一个非unknown的有效IP字符串，则为真实IP地址
	 */
	public static String getIpAddr(HttpServletRequest request) {
    	String ip = null;
        try {
            ip = request.getHeader("x-forwarded-for");
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("WL-Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("HTTP_CLIENT_IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getHeader("HTTP_X_FORWARDED_FOR");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)) {
                ip = request.getRemoteAddr();
            }
        } catch (Exception e) {
        	logger.error("IPUtils ERROR ", e);
        }
        
//        //使用代理，则获取第一个IP地址
//        if(StringUtils.isEmpty(ip) && ip.length() > 15) {
//			if(ip.indexOf(",") > 0) {
//				ip = ip.substring(0, ip.indexOf(","));
//			}
//		}
        
        return ip;
    }
	
}

6、系统测试

@RestController
public class UserController {
    @Autowired
    private UserService userService;

	//这里加上了注解，再调用该方法时就会进行aop的增强 进行日志记录
    @SysLog("查询用户列表")
    @GetMapping("/list")
    public String getUserList(){
        List<UserEntity> list = userService.list();
        return list.toString();
    }

    @SysLog("根据用户id查询用户")
    @GetMapping("/user/{id}")
    public String getUserById(@PathVariable("id") Integer id){
        UserEntity user = userService.getById(id);
        return user.toString();
    }

    @SysLog("添加用户")
    @PostMapping("/save")
    public String save(UserEntity userEntity){
        boolean save = userService.save(userEntity);
        return save == true ? "success":"failure";
    }


}

浏览器能返回列表数据

再来看看日志表里面，可以看到我们调用的方法已经被加入到日志里去了
一个很简单的小案例，让自己更好的理解aop的使用。在这里通过注解+切面类的方式 来进行相关的定义，我们只需要再所需的业务方法上加入该注解就能进行日志记录，可以再需要的方法加上注解来进行记录日志，比较灵活。切面类也可以根据自己的需求来实现相关功能，这里只是一个很简单的功能来演示一些aop的使用，更多的还需要根据具体的需求来进行设计了吧。

本案例的代码主要来源是人人开源 中的renren-fast，再使用renren-fast的时候看见项目里通过aop记录日志的方式，自己便弄了一个小demo来测试aop的具体使用。很简单的小demo ，让自己再了解aop概念时有个具体的实际应用场景来测试。