該項目源碼地址：https://github.com/ggb2312/JavaNotes/tree/master/springboot-integration-examples （其中包含SpringBoot和其他常用技術(shù)的整合上沐，配套源碼以及筆記∩袼В基于最新的 SpringBoot2.1+立肘，歡迎各位 Star）
1. 開發(fā)前準備
1.1 前置知識
- java基礎(chǔ)自定義注解、反射
- Spring aop
- SpringBoot簡單基礎(chǔ)知識即可
1.2 環(huán)境參數(shù)
- 開發(fā)工具：IDEA
- 基礎(chǔ)環(huán)境：Maven+JDK8
- 所用技術(shù)：SpringBoot抛人、lombok假栓、mybatisplus情臭、Spring aop
- SpringBoot版本：2.1.4
1.3 涉及知識點
- 自定義注解年鸳、 反射
- spring aop 環(huán)繞通知
2. aop日志實現(xiàn)
AOP（Aspect Oriented Programming）是一個大話題趴久，這里不做介紹，直接使用搔确。
實現(xiàn)效果：用戶在瀏覽器操作web頁面彼棍，對應的操作會被記錄到數(shù)據(jù)庫中。
實現(xiàn)思路：自定義一個注解膳算，將注解加到某個方法上滥酥，使用aop環(huán)繞通知代理帶有注解的方法，在環(huán)繞前進行日志準備畦幢，執(zhí)行完方法后進行日志入庫。
項目結(jié)構(gòu)：
項目結(jié)構(gòu)
2.1 log表
CREATE TABLE `log` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`operateor` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`operateType` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`operateDate` datetime(0) NULL DEFAULT NULL,
`operateResult` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
`ip` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 13 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;
2.2 pojo
log表對應的實體類缆蝉，使用了lombok的@Data注解宇葱，也可以使用get、set代替刊头，使用了mybatisplus黍瞧，所以配置了@TableName等注解，如果使用mybatis或者其他的orm原杂，可以把注解拿掉印颤。
package cn.lastwhisper.springbootaop.pojo;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.util.Date;
@Data
@TableName("log")
public class Log {
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
@TableField("operateor")
private String operateor;
@TableField("operateType")
private String operatetype;
@TableField("operateDate")
@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
private Date operatedate;
@TableField("operatereSult")
private String operateresult;
@TableField("ip")
private String ip;
}
2.3 controller
該Controller用于接收用戶的請求，并對用戶操作進行記錄穿肄。
package cn.lastwhisper.springbootaop.controller;
import cn.lastwhisper.springbootaop.core.annotation.LogAnno;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author lastwhisper
* @desc
* @email gaojun56@163.com
*/
@RestController
public class UserController {
/**
* @desc 這里為了方便直接在controller上進行aop日志記錄年局，也可以放在service上际看。
* @author lastwhisper
* @Param
* @return
*/
@LogAnno(operateType = "添加用戶")
@RequestMapping(value = "/user/add")
public void add() {
System.out.println("向數(shù)據(jù)庫中添加用戶!!");
}
}
2.4 mapper
該mapper用于對log表進行操作
package cn.lastwhisper.springbootaop.mapper;
import cn.lastwhisper.springbootaop.pojo.Log;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
/**
* @desc
*
* @author lastwhisper
* @email gaojun56@163.com
*/
public interface LogMapper extends BaseMapper<Log> {
}
2.5 core
2.5.1 日志注解
該注解用于標識需要被環(huán)繞通知進行日志操作的方法
package cn.lastwhisper.springbootaop.core.annotation;
import org.springframework.core.annotation.Order;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* 日志注解
*
* @author lastwhisper
*/
@Target(ElementType.METHOD) // 方法注解
@Retention(RetentionPolicy.RUNTIME) // 運行時可見
public @interface LogAnno {
String operateType();// 記錄日志的操作類型
}
2.5.2 aop環(huán)繞通知類
對帶有LogAnno注解的方法進行環(huán)繞通知日志記錄。
@Order(3)注解一定要帶上矢否，標記支持AspectJ的切面排序仲闽。
package cn.lastwhisper.springbootaop.core.aop;
import java.lang.reflect.Method;
import java.sql.SQLException;
import java.util.Date;
import cn.lastwhisper.springbootaop.core.annotation.LogAnno;
import cn.lastwhisper.springbootaop.core.common.HttpContextUtil;
import cn.lastwhisper.springbootaop.mapper.LogMapper;
import cn.lastwhisper.springbootaop.pojo.Log;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
/**
* AOP實現(xiàn)日志
*
* @author 最后的輕語_dd43
*
*/
@Order(3)
@Component
@Aspect
public class LogAopAspect {
// 日志mapper，這里省事少寫了service
@Autowired
private LogMapper logMapper;
/**
* 環(huán)繞通知記錄日志通過注解匹配到需要增加日志功能的方法
*
* @param pjp
* @return
* @throws Throwable
*/
@Around("@annotation(cn.lastwhisper.springbootaop.core.annotation.LogAnno)")
public Object aroundAdvice(ProceedingJoinPoint pjp) throws Throwable {
// 1.方法執(zhí)行前的處理僵朗，相當于前置通知
// 獲取方法簽名
MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
// 獲取方法
Method method = methodSignature.getMethod();
// 獲取方法上面的注解
LogAnno logAnno = method.getAnnotation(LogAnno.class);
// 獲取操作描述的屬性值
String operateType = logAnno.operateType();
// 創(chuàng)建一個日志對象(準備記錄日志)
Log log = new Log();
log.setOperatetype(operateType);// 操作說明
// 設(shè)置操作人赖欣，從session中獲取，這里簡化了一下验庙，寫死了顶吮。
log.setOperateor("lastwhisper");
String ip = HttpContextUtil.getIpAddress();
log.setIp(ip);
Object result = null;
try {
// 讓代理方法執(zhí)行
result = pjp.proceed();
// 2.相當于后置通知(方法成功執(zhí)行之后走這里)
log.setOperateresult("正常");// 設(shè)置操作結(jié)果
} catch (SQLException e) {
// 3.相當于異常通知部分
log.setOperateresult("失敗");// 設(shè)置操作結(jié)果
} finally {
// 4.相當于最終通知
log.setOperatedate(new Date());// 設(shè)置操作日期
logMapper.insert(log);// 添加日志記錄
}
return result;
}
}
2.5.3 common
用于獲取用戶的ip
package cn.lastwhisper.springbootaop.core.common;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
/**
* @desc
*
* @author lastwhisper
* @email gaojun56@163.com
*/
public class HttpContextUtil {
public static HttpServletRequest getRequest() {
return ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes())
.getRequest();
}
/**
* 獲取IP地址的方法
*
* @param request 傳一個request對象下來
* @return
*/
public static String getIpAddress() {
HttpServletRequest request = getRequest();
String ip = request.getHeader("x-forwarded-for");
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("WL-Proxy-Client-IP");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("HTTP_CLIENT_IP");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getHeader("HTTP_X_FORWARDED_FOR");
}
if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
ip = request.getRemoteAddr();
}
return ip;
}
}
2.6 最終配置
配置application.properties文件
spring.application.name = lastwhisper-aoplog
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/wxlogin?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
配置springboot啟動類SpringbootaopApplication
package cn.lastwhisper.springbootaop;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("cn.lastwhisper.springbootaop.mapper") //設(shè)置mapper接口的掃描包
@SpringBootApplication
public class SpringbootaopApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootaopApplication.class, args);
}
}
至此一個完整的SpringBoot AOP日志系統(tǒng)基本成型。
3. 測試
啟動SpringbootaopApplication的main方法粪薛。訪問 http://localhost:8080/user/add
會在idea的控制臺看到 ``
console
然后再看一下數(shù)據(jù)庫悴了，保存了日志信息。
aop 日志
如果是springmvc項目沒有生效汗菜，應該是自定義aop與事務aop順序問題让禀，需要在配置文件中配置order="200"。如果配置文件配置order無效陨界，建議不要使用配置文件事務巡揍，使用注解事務。
springmvc項目配置示例
<!-- 開啟注解AOP -->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
<!-- 注解方式配置事物菌瘪，為了配合自定義注解 -->
<tx:annotation-driven
transaction-manager="transactionManager" proxy-target-class="true"
order="200" />
