{"id":1942,"date":"2023-04-01T10:06:26","date_gmt":"2023-04-01T02:06:26","guid":{"rendered":"https:\/\/www.appblog.cn\/?p=1942"},"modified":"2023-04-22T08:44:16","modified_gmt":"2023-04-22T00:44:16","slug":"using-spring-boot-aop-to-record-operation-logs-and-exception-logs","status":"publish","type":"post","link":"https:\/\/www.appblog.cn\/index.php\/2023\/04\/01\/using-spring-boot-aop-to-record-operation-logs-and-exception-logs\/","title":{"rendered":"\u4f7f\u7528 Spring Boot AOP \u8bb0\u5f55\u64cd\u4f5c\u65e5\u5fd7\u3001\u5f02\u5e38\u65e5\u5fd7"},"content":{"rendered":"

Spring \u4e09\u5927\u7279\u6027\uff0cIOC\uff08\u63a7\u5236\u53cd\u8f6c\uff09\uff0cDI\uff08\u4f9d\u8d56\u6ce8\u5165\uff09\uff0cAOP\uff08\u9762\u5411\u5207\u9762\uff09\uff0c\u90a3\u5176\u4e2dAOP\u7684\u4e3b\u8981\u529f\u80fd\u5c31\u662f\u5c06\u65e5\u5fd7\u8bb0\u5f55\uff0c\u6027\u80fd\u7edf\u8ba1\uff0c\u5b89\u5168\u63a7\u5236\uff0c\u4e8b\u52a1\u5904\u7406\uff0c\u5f02\u5e38\u5904\u7406\u7b49\u4ee3\u7801\u4ece\u4e1a\u52a1\u903b\u8f91\u4ee3\u7801\u4e2d\u5212\u5206\u51fa\u6765\u3002\u672c\u6587\u5b9e\u73b0 Spring Boot Aop \u65e5\u5fd7\u8bb0\u5f55\u3002<\/p>\n

\u6dfb\u52a0Maven\u4f9d\u8d56<\/h2>\n

<\/p>\n

<dependency>\n    <groupId>org.springframework.boot<\/groupId>\n    <artifactId>spring-boot-starter-aop<\/artifactId>\n<\/dependency><\/code><\/pre>\n
\u521b\u5efa\u64cd\u4f5c\u65e5\u5fd7\u6ce8\u89e3\u7c7b<\/h2>\n
import java.lang.annotation.Documented;\nimport java.lang.annotation.ElementType;\nimport java.lang.annotation.Retention;\nimport java.lang.annotation.RetentionPolicy;\nimport java.lang.annotation.Target;\n\n\/**\n * \u81ea\u5b9a\u4e49\u64cd\u4f5c\u65e5\u5fd7\u6ce8\u89e3\n *\/\n@Target(ElementType.METHOD) \/\/\u6ce8\u89e3\u653e\u7f6e\u7684\u76ee\u6807\u4f4d\u7f6e\uff0cMETHOD\u662f\u53ef\u6ce8\u89e3\u5728\u65b9\u6cd5\u7ea7\u522b\u4e0a\n@Retention(RetentionPolicy.RUNTIME) \/\/\u6ce8\u89e3\u5728\u54ea\u4e2a\u9636\u6bb5\u6267\u884c\n@Documented\npublic @interface OperLog {\n    String operModul() default "";  \/\/ \u64cd\u4f5c\u6a21\u5757\n    String operType() default "";  \/\/ \u64cd\u4f5c\u7c7b\u578b\n    String operDesc() default "";  \/\/ \u64cd\u4f5c\u8bf4\u660e\n}<\/code><\/pre>\n
\u521b\u5efa\u5207\u9762\u7c7b\u8bb0\u5f55\u64cd\u4f5c\u65e5\u5fd7<\/h2>\n
import java.lang.reflect.Method;\nimport java.util.Date;\nimport java.util.HashMap;\nimport java.util.Map;\n\nimport javax.servlet.http.HttpServletRequest;\n\nimport org.aspectj.lang.JoinPoint;\nimport org.aspectj.lang.annotation.AfterReturning;\nimport org.aspectj.lang.annotation.AfterThrowing;\nimport org.aspectj.lang.annotation.Aspect;\nimport org.aspectj.lang.annotation.Pointcut;\nimport org.aspectj.lang.reflect.MethodSignature;\nimport org.springframework.beans.factory.annotation.Autowired;\nimport org.springframework.beans.factory.annotation.Value;\nimport org.springframework.stereotype.Component;\nimport org.springframework.web.context.request.RequestAttributes;\nimport org.springframework.web.context.request.RequestContextHolder;\n\nimport com.gexin.fastjson.JSON;\nimport cn.appblog.pay.common.utils.IPUtil;\nimport cn.appblog.pay.common.utils.annotation.OperLog;\nimport cn.appblog.pay.common.utils.base.UuidUtil;\nimport cn.appblog.pay.common.utils.security.UserShiroUtil;\nimport cn.appblog.pay.entity.system.log.ExceptionLog;\nimport cn.appblog.pay.entity.system.log.OperationLog;\nimport cn.appblog.pay.service.system.log.ExceptionLogService;\nimport cn.appblog.pay.service.system.log.OperationLogService;\n\n\/**\n * \u5207\u9762\u5904\u7406\u7c7b\uff0c\u64cd\u4f5c\u65e5\u5fd7\u5f02\u5e38\u65e5\u5fd7\u8bb0\u5f55\u5904\u7406\n *\/\n@Aspect\n@Component\npublic class OperLogAspect {\n\n    \/**\n     * \u64cd\u4f5c\u7248\u672c\u53f7\n     * <p>\n     * \u9879\u76ee\u542f\u52a8\u65f6\u4ece\u547d\u4ee4\u884c\u4f20\u5165\uff0c\u4f8b\u5982\uff1ajava -jar xxx.war --version=201902\n     * <\/p>\n     *\/\n    @Value("${version}")\n    private String operVer;\n\n    @Autowired\n    private OperationLogService operationLogService;\n\n    @Autowired\n    private ExceptionLogService exceptionLogService;\n\n    \/**\n     * \u8bbe\u7f6e\u64cd\u4f5c\u65e5\u5fd7\u5207\u5165\u70b9 \u8bb0\u5f55\u64cd\u4f5c\u65e5\u5fd7 \u5728\u6ce8\u89e3\u7684\u4f4d\u7f6e\u5207\u5165\u4ee3\u7801\n     *\/\n    @Pointcut("@annotation(cn.appblog.pay.common.utils.annotation.OperLog)")\n    public void operLogPoinCut() {\n    }\n\n    \/**\n     * \u8bbe\u7f6e\u64cd\u4f5c\u5f02\u5e38\u5207\u5165\u70b9\u8bb0\u5f55\u5f02\u5e38\u65e5\u5fd7 \u626b\u63cf\u6240\u6709controller\u5305\u4e0b\u64cd\u4f5c\n     *\/\n    @Pointcut("execution(* cn.appblog.pay.controller..*.*(..))")\n    public void operExceptionLogPoinCut() {\n    }\n\n    \/**\n     * \u6b63\u5e38\u8fd4\u56de\u901a\u77e5\uff0c\u62e6\u622a\u7528\u6237\u64cd\u4f5c\u65e5\u5fd7\uff0c\u8fde\u63a5\u70b9\u6b63\u5e38\u6267\u884c\u5b8c\u6210\u540e\u6267\u884c\uff0c \u5982\u679c\u8fde\u63a5\u70b9\u629b\u51fa\u5f02\u5e38\uff0c\u5219\u4e0d\u4f1a\u6267\u884c\n     *\n     * @param joinPoint \u5207\u5165\u70b9\n     * @param keys      \u8fd4\u56de\u7ed3\u679c\n     *\/\n    @AfterReturning(value = "operLogPoinCut()", returning = "keys")\n    public void saveOperLog(JoinPoint joinPoint, Object keys) {\n        \/\/ \u83b7\u53d6RequestAttributes\n        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();\n        \/\/ \u4ece\u83b7\u53d6RequestAttributes\u4e2d\u83b7\u53d6HttpServletRequest\u7684\u4fe1\u606f\n        HttpServletRequest request = (HttpServletRequest) requestAttributes\n                .resolveReference(RequestAttributes.REFERENCE_REQUEST);\n\n        OperationLog operlog = new OperationLog();\n        try {\n            operlog.setOperId(UuidUtil.get32UUID()); \/\/ \u4e3b\u952eID\n\n            \/\/ \u4ece\u5207\u9762\u7ec7\u5165\u70b9\u5904\u901a\u8fc7\u53cd\u5c04\u673a\u5236\u83b7\u53d6\u7ec7\u5165\u70b9\u5904\u7684\u65b9\u6cd5\n            MethodSignature signature = (MethodSignature) joinPoint.getSignature();\n            \/\/ \u83b7\u53d6\u5207\u5165\u70b9\u6240\u5728\u7684\u65b9\u6cd5\n            Method method = signature.getMethod();\n            \/\/ \u83b7\u53d6\u64cd\u4f5c\n            OperLog opLog = method.getAnnotation(OperLog.class);\n            if (opLog != null) {\n                String operModul = opLog.operModul();\n                String operType = opLog.operType();\n                String operDesc = opLog.operDesc();\n                operlog.setOperModul(operModul); \/\/ \u64cd\u4f5c\u6a21\u5757\n                operlog.setOperType(operType); \/\/ \u64cd\u4f5c\u7c7b\u578b\n                operlog.setOperDesc(operDesc); \/\/ \u64cd\u4f5c\u63cf\u8ff0\n            }\n            \/\/ \u83b7\u53d6\u8bf7\u6c42\u7684\u7c7b\u540d\n            String className = joinPoint.getTarget().getClass().getName();\n            \/\/ \u83b7\u53d6\u8bf7\u6c42\u7684\u65b9\u6cd5\u540d\n            String methodName = method.getName();\n            methodName = className + "." + methodName;\n\n            operlog.setOperMethod(methodName); \/\/ \u8bf7\u6c42\u65b9\u6cd5\n\n            \/\/ \u8bf7\u6c42\u7684\u53c2\u6570\n            Map<String, String> rtnMap = converMap(request.getParameterMap());\n            \/\/ \u5c06\u53c2\u6570\u6240\u5728\u7684\u6570\u7ec4\u8f6c\u6362\u6210json\n            String params = JSON.toJSONString(rtnMap);\n\n            operlog.setOperRequParam(params); \/\/ \u8bf7\u6c42\u53c2\u6570\n            operlog.setOperRespParam(JSON.toJSONString(keys)); \/\/ \u8fd4\u56de\u7ed3\u679c\n            operlog.setOperUserId(UserShiroUtil.getCurrentUserLoginName()); \/\/ \u8bf7\u6c42\u7528\u6237ID\n            operlog.setOperUserName(UserShiroUtil.getCurrentUserName()); \/\/ \u8bf7\u6c42\u7528\u6237\u540d\u79f0\n            operlog.setOperIp(IPUtil.getRemortIP(request)); \/\/ \u8bf7\u6c42IP\n            operlog.setOperUri(request.getRequestURI()); \/\/ \u8bf7\u6c42URI\n            operlog.setOperCreateTime(new Date()); \/\/ \u521b\u5efa\u65f6\u95f4\n            operlog.setOperVer(operVer); \/\/ \u64cd\u4f5c\u7248\u672c\n            operationLogService.insert(operlog);\n        } catch (Exception e) {\n            e.printStackTrace();\n        }\n    }\n\n    \/**\n     * \u5f02\u5e38\u8fd4\u56de\u901a\u77e5\uff0c\u7528\u4e8e\u62e6\u622a\u5f02\u5e38\u65e5\u5fd7\u4fe1\u606f \u8fde\u63a5\u70b9\u629b\u51fa\u5f02\u5e38\u540e\u6267\u884c\n     *\n     * @param joinPoint \u5207\u5165\u70b9\n     * @param e         \u5f02\u5e38\u4fe1\u606f\n     *\/\n    @AfterThrowing(pointcut = "operExceptionLogPoinCut()", throwing = "e")\n    public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {\n        \/\/ \u83b7\u53d6RequestAttributes\n        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();\n        \/\/ \u4ece\u83b7\u53d6RequestAttributes\u4e2d\u83b7\u53d6HttpServletRequest\u7684\u4fe1\u606f\n        HttpServletRequest request = (HttpServletRequest) requestAttributes\n                .resolveReference(RequestAttributes.REFERENCE_REQUEST);\n\n        ExceptionLog excepLog = new ExceptionLog();\n        try {\n            \/\/ \u4ece\u5207\u9762\u7ec7\u5165\u70b9\u5904\u901a\u8fc7\u53cd\u5c04\u673a\u5236\u83b7\u53d6\u7ec7\u5165\u70b9\u5904\u7684\u65b9\u6cd5\n            MethodSignature signature = (MethodSignature) joinPoint.getSignature();\n            \/\/ \u83b7\u53d6\u5207\u5165\u70b9\u6240\u5728\u7684\u65b9\u6cd5\n            Method method = signature.getMethod();\n            excepLog.setExcId(UuidUtil.get32UUID());\n            \/\/ \u83b7\u53d6\u8bf7\u6c42\u7684\u7c7b\u540d\n            String className = joinPoint.getTarget().getClass().getName();\n            \/\/ \u83b7\u53d6\u8bf7\u6c42\u7684\u65b9\u6cd5\u540d\n            String methodName = method.getName();\n            methodName = className + "." + methodName;\n            \/\/ \u8bf7\u6c42\u7684\u53c2\u6570\n            Map<String, String> rtnMap = converMap(request.getParameterMap());\n            \/\/ \u5c06\u53c2\u6570\u6240\u5728\u7684\u6570\u7ec4\u8f6c\u6362\u6210json\n            String params = JSON.toJSONString(rtnMap);\n            excepLog.setExcRequParam(params); \/\/ \u8bf7\u6c42\u53c2\u6570\n            excepLog.setOperMethod(methodName); \/\/ \u8bf7\u6c42\u65b9\u6cd5\u540d\n            excepLog.setExcName(e.getClass().getName()); \/\/ \u5f02\u5e38\u540d\u79f0\n            excepLog.setExcMessage(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace())); \/\/ \u5f02\u5e38\u4fe1\u606f\n            excepLog.setOperUserId(UserShiroUtil.getCurrentUserLoginName()); \/\/ \u64cd\u4f5c\u5458ID\n            excepLog.setOperUserName(UserShiroUtil.getCurrentUserName()); \/\/ \u64cd\u4f5c\u5458\u540d\u79f0\n            excepLog.setOperUri(request.getRequestURI()); \/\/ \u64cd\u4f5cURI\n            excepLog.setOperIp(IPUtil.getRemortIP(request)); \/\/ \u64cd\u4f5c\u5458IP\n            excepLog.setOperVer(operVer); \/\/ \u64cd\u4f5c\u7248\u672c\u53f7\n            excepLog.setOperCreateTime(new Date()); \/\/ \u53d1\u751f\u5f02\u5e38\u65f6\u95f4\n\n            exceptionLogService.insert(excepLog);\n\n        } catch (Exception e2) {\n            e2.printStackTrace();\n        }\n    }\n\n    \/**\n     * \u8f6c\u6362request \u8bf7\u6c42\u53c2\u6570\n     *\n     * @param paramMap request\u83b7\u53d6\u7684\u53c2\u6570\u6570\u7ec4\n     *\/\n    public Map<String, String> converMap(Map<String, String[]> paramMap) {\n        Map<String, String> rtnMap = new HashMap<String, String>();\n        for (String key : paramMap.keySet()) {\n            rtnMap.put(key, paramMap.get(key)[0]);\n        }\n        return rtnMap;\n    }\n\n    \/**\n     * \u8f6c\u6362\u5f02\u5e38\u4fe1\u606f\u4e3a\u5b57\u7b26\u4e32\n     *\n     * @param exceptionName    \u5f02\u5e38\u540d\u79f0\n     * @param exceptionMessage \u5f02\u5e38\u4fe1\u606f\n     * @param elements         \u5806\u6808\u4fe1\u606f\n     *\/\n    public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {\n        StringBuffer strbuff = new StringBuffer();\n        for (StackTraceElement stet : elements) {\n            strbuff.append(stet + "\\n");\n        }\n        String message = exceptionName + ":" + exceptionMessage + "\\n\\t" + strbuff.toString();\n        return message;\n    }\n}\n\n## \u5728Controller\u5c42\u65b9\u6cd5\u6dfb\u52a0@OperLog\u6ce8\u89e3\n\n```java\n@RequestMapping(value = \"addOrderInfo\")\n@ResponseBody\n@OperLog(operModul=\"\u9500\u552e\u7ba1\u7406-\u8ba2\u5355\u65b0\u589e\", operType=OprLogConst.ADD, operDesc=\"\u8ba2\u5355\u65b0\u589e\u529f\u80fd\")\npublic WebAjaxResponse addOrderInfo(OrderInfo orderInfo) {\n    ...\n}<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
Spring \u4e09\u5927\u7279\u6027\uff0cIOC\uff08\u63a7\u5236\u53cd\u8f6c\uff09\uff0cDI\uff08\u4f9d\u8d56\u6ce8\u5165\uff09\uff0cAOP\uff08\u9762\u5411\u5207\u9762\uff09\uff0c\u90a3\u5176\u4e2dAOP\u7684\u4e3b\u8981\u529f\u80fd\u5c31\u662f\u5c06 […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[41],"tags":[100],"class_list":["post-1942","post","type-post","status-publish","format-standard","hentry","category-spring-boot","tag-aop"],"_links":{"self":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts\/1942","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/comments?post=1942"}],"version-history":[{"count":0,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/posts\/1942\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/media?parent=1942"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/categories?post=1942"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.appblog.cn\/index.php\/wp-json\/wp\/v2\/tags?post=1942"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}