Spring如何基於aop實現操作日誌功能
阿新 • • 發佈:2020-11-10
1. 在pom中新增所需依賴
建立一個springboot工程,新增所需要的依賴,持久化用的是mybatis
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--springboot aop依賴--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <!--mybatis--> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.1.3</version> </dependency> <!--mysql連線--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.19</version> <scope>runtime</scope> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
2. 建立日誌實體類
import lombok.Data; import java.io.Serializable; @Data public class AdminLog implements Serializable { private static final long serialVersionUID = -291495801959706565L; private Integer id; //日誌記錄id private Integer userId;//操作人id private String userName;//操作人name private String loginip;//登入ip private int type; private String url; private String operation; private String createtime; private String remark; }
3. 自定義log註解
import java.lang.annotation.*; /** * 自定義日誌註解 */ @Target(ElementType.METHOD) //註解防止位置 @Retention(RetentionPolicy.RUNTIME)//執行時可見 @Documented //生成文件 public @interface MyLog { String operation() default ""; int type(); }
4. 建立aop切面處理類
import cn.***.springaopdemo.anno.MyLog; import cn.***.springaopdemo.dao.MyLogMapper; import cn.***.springaopdemo.pojo.Admin; import cn.***.springaopdemo.pojo.AdminLog; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.annotation.Pointcut; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; import javax.servlet.http.HttpServletRequest; import java.lang.reflect.Method; /** * 切面處理類 */ @Aspect @Component public class SysLogAspect { /** * 使用log4j2把一些資訊列印在控制檯上面 */ private static final Logger log = LogManager.getLogger(SysLogAspect.class); @Autowired private MyLogMapper myLogMapper; //定義切點 @Pointcut //在註解的位置切入程式碼 @Pointcut("@annotation(cn.***.springaopdemo.anno.MyLog)") public void logPointCut() { } //切面 配置為前置通知 @Before("logPointCut()") public void saveOperation(JoinPoint joinPoint) { log.info("---------------介面日誌記錄---------------"); //建立一個日誌物件 AdminLog adminLog = new AdminLog(); //獲取切面織處入點的方法 MethodSignature signature = (MethodSignature) joinPoint.getSignature(); //獲取切入點所在的方法 Method method = signature.getMethod(); //獲取操作日誌的屬性值 MyLog myLog = method.getAnnotation(MyLog.class); if (myLog != null) { //操作事件 String operation = myLog.operation(); adminLog.setOperation(operation); //日誌型別 int type = myLog.type(); adminLog.setType(type); log.info("operation=" + operation + ",type=" + type); } //獲取url HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest(); String requestURL = request.getRequestURI().toString(); adminLog.setUrl(requestURL); //獲取客戶端ip String ip = request.getRemoteAddr(); adminLog.setLoginip(ip); //獲取操作人賬號、姓名(需要提前將使用者資訊儲存到Session) Admin admin = (Admin) request.getSession().getAttribute("admin"); if (admin != null) { Integer id = admin.getId(); String name = admin.getName(); adminLog.setUserId(id); adminLog.setUserName(name); } log.info("url=" + requestURL + ",ip=" + ip); //呼叫service儲存Operation實體類到資料庫 //可以在這設定id,因為是測試,這裡就使用的是資料庫的自增id myLogMapper.insertLog(adminLog); } }
5. mapper層把日誌資料儲存到mysql資料庫中
mapper介面
import cn.***.springaopdemo.pojo.AdminLog; import java.util.List; public interface MyLogMapper { void insertLog(AdminLog adminLog); }
mapper.xml檔案
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="cn.***.springaopdemo.dao.MyLogMapper"> <insert id="insertLog" parameterType="cn.***.springaopdemo.pojo.AdminLog"> INSERT INTO admin_log (user_id,user_name,loginip,type,url,operation,createtime,remark) VALUES (#{userId},#{userName},#{loginip},#{type},#{url},#{operation},now(),#{remark}) </insert> </mapper>
6. 測試
先直接登入使用者,因為是測試,直接從資料庫中獲取後登入,把admin儲存到session中
import cn.***.springaopdemo.pojo.Admin; import cn.***.springaopdemo.service.IAdminService; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletRequest; import java.util.List; @RestController @RequestMapping("/admin") public class AdminController { private static final Logger log = LogManager.getLogger(AdminController.class); //中間service層可以省略,直接通過mapper介面操作資料即可 @Autowired private IAdminService adminService; @RequestMapping("/login") public Admin login(HttpServletRequest request) { List<Admin> adminList = adminService.findAllAdmin(); Admin admin = adminList.get(0); request.getSession().setAttribute("admin",admin ); return admin; } }
在瀏覽器中輸入localhost:8080/admin/login,可以看到登入的admin
進行插入和查詢操作,插入資料直接通過後臺提供
import cn.***.springaopdemo.anno.MyLog; import cn.***.springaopdemo.pojo.Type; import cn.***.springaopdemo.service.ITypeService; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import java.util.ArrayList; import java.util.List; @RestController @RequestMapping("/type") public class TypeController { private static final Logger log = LogManager.getLogger(TypeController.class); @Autowired private ITypeService typeService; @MyLog(operation = "增加書籍型別",type = 2) @RequestMapping("/add") public void insertType() { List<Type> typeList = new ArrayList<>(); Type type = new Type(); type.setName("自然科學"); typeList.add(type); typeService.addTypeList(typeList); log.info("新增書籍型別" + type.getName()); } @MyLog(operation = "查詢所有書籍型別",type = 1) @RequestMapping("/findAll") public List<Type> findAllType() { List<Type> typeList = typeService.findAllType(); log.info("查詢所有書籍型別"); return typeList; } }
在瀏覽器中輸入localhost:8080/type/add,後臺日誌列印記錄
再輸入查詢請求localhost:8080/type/findAll,獲得查詢出的分類
檢視資料庫是否新增成功
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。