一个注解搞定，记录项目日志

　　最近正在录制TienChin项目视频采用SpringBootVue3技术栈，里边会涉及到各种好玩的技术，小伙伴们来和我一起做一个完成率超90的项目。
　　前段时间做了一个支线任务，现在还是回到我们的主线上面来，继续完成TienChin项目。
　　小伙伴们知道我最近在录制TienChin项目视频教程，这是一个基于RuoYiVue脚手架的项目，用过这个脚手架的小伙伴可能知道，这个脚手架有一个功能，就是如果你需要记录下来一个接口的操作信息，那么只需要在Controller接口中加上一个Log注解即可，非常方便，最终记录到数据库中的日志类似下面这样：
　　可能有小伙伴要吐槽了，这不该记录到Elasticsearch中吗？上ELK啊！怎么说呢，如果你会将日志存入数据库，那么将来存Elasticsearch其实非常Easy，结合我之前录制的Es视频，我相信这个问题你能自己搞定。
　　今天我们主要来分析一下这个脚手架中Log注解的玩法。1。日志表设计
　　先来看看日志表的设计。CREATETABLEsysoperlog（operidbigint（20）NOTNULLAUTOINCREMENTCOMMENTahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志a主键，titlevarchar（50）COLLATEutf8mb4unicodeciDEFAULTCOMMENT模块标题，businesstypeint（2）DEFAULT0COMMENT业务类型（0其它1新增2修改3删除），methodvarchar（100）COLLATEutf8mb4unicodeciDEFAULTCOMMENT方法名称，requestmethodvarchar（10）COLLATEutf8mb4unicodeciDEFAULTCOMMENT请求方式，operatortypeint（1）DEFAULT0COMMENT操作类别（0其它1后台用户2手机端用户），opernamevarchar（50）COLLATEutf8mb4unicodeciDEFAULTCOMMENT操作人员，deptnamevarchar（50）COLLATEutf8mb4unicodeciDEFAULTCOMMENT部门名称，operurlvarchar（255）COLLATEutf8mb4unicodeciDEFAULTCOMMENT请求URL，operipvarchar（128）COLLATEutf8mb4unicodeciDEFAULTCOMMENT主机地址，operlocationvarchar（255）COLLATEutf8mb4unicodeciDEFAULTCOMMENT操作地点，operparamvarchar（2000）COLLATEutf8mb4unicodeciDEFAULTCOMMENT请求参数，jsonresultvarchar（2000）COLLATEutf8mb4unicodeciDEFAULTCOMMENT返回参数，statusint（1）DEFAULT0COMMENT操作状态（0正常1异常），errormsgvarchar（2000）COLLATEutf8mb4unicodeciDEFAULTCOMMENT错误消息，opertimedatetimeDEFAULTNULLCOMMENT操作时间，PRIMARYKEY（operid））ENGINEInnoDBAUTOINCREMENT280DEFAULTCHARSETutf8mb4COLLATEutf8mb4unicodeciCOMMENT操作ahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志a记录；
　　这里各个字段的含义我来解释下：operid：这是日志主键，自增的。title：这个标题，一般就是用来说明这个操作是干嘛的，例如删除一个用户、添加一条线索等待。businesstype：这个是指业务类型，一般来说有：添加、修改、删除、导入、导出等等。method：执行的接口方法名称。requestmethod：这个是指请求的方法类型，如GET、POST、PUT、DELETE等。operatortype：这个是指操作类别，分为三种：后台用户、手机用户以及其他。opername：操作人员的名称。deptname：操作人员所属的部门。operurl：请求的URL地址。operip：请求的IP地址。operlocation：请求IP地址所属的区域。operparam：请求的参数。jsonresult：响应的JSON参数。status：操作的状态，成功还是失败。errormsg：如果是失败，失败的内容是什么。opertime：操作的时间。
　　这里给出来的就这些字段，基本上满足项目需求了，如果不够的话，也可以自定添加即可。2。注解的定义
　　再来看看Log注解的定义，该注解位于org。javaboy。tienchin。common。annotation。Log：Target（｛ElementType。PARAMETER，ElementType。METHOD｝）Retention（RetentionPolicy。RUNTIME）DocumentedpublicinterfaceLog｛模块publicStringtitle（）default；功能publicBusinessTypebusinessType（）defaultBusinessType。OTHER；操作人类别publicOperatorTypeoperatorType（）defaultOperatorType。MANAGE；是否保存请求的参数publicbooleanisSaveRequestData（）defaulttrue；是否保存响应的参数publicbooleanisSaveResponseData（）defaulttrue；｝
　　这个注解一共有五个属性，结合上面表的定义，五个属性含义很好理解，不多说。3。注解的解析
　　经典搭配：自定义注解AOP切面。解析该注解的AOP切面是LogAspect，位于org。javaboy。tienchin。framework。aspectj。LogAspect：AspectComponentpublicclassLogAspect｛privatestaticfinalLoggerlogLoggerFactory。getLogger（LogAspect。class）；处理完请求后执行paramjoinPoint切点AfterReturning（pointcutannotation（controllerLog），returningjsonResult）publicvoiddoAfterReturning（JoinPointjoinPoint，LogcontrollerLog，ObjectjsonResult）｛handleLog（joinPoint，controllerLog，null，jsonResult）；｝拦截异常操作paramjoinPoint切点parame异常AfterThrowing（valueannotation（controllerLog），throwinge）publicvoiddoAfterThrowing（JoinPointjoinPoint，LogcontrollerLog，Exceptione）｛handleLog（joinPoint，controllerLog，e，null）；｝protectedvoidhandleLog（finalJoinPointjoinPoint，LogcontrollerLog，finalExceptione，ObjectjsonResult）｛try｛获取当前的用户LoginUserloginUserSecurityUtils。getLoginUser（）；数据库ahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志aSysOperLogoperLognewSysOperLog（）；operLog。setStatus（BusinessStatus。SUCCESS。ordinal（））；请求的地址StringipIpUtils。getIpAddr（ServletUtils。getRequest（））；operLog。setOperIp（ip）；operLog。setOperUrl（ServletUtils。getRequest（）。getRequestURI（））；if（loginUser！null）｛operLog。setOperName（loginUser。getUsername（））；｝if（e！null）｛operLog。setStatus（BusinessStatus。FAIL。ordinal（））；operLog。setErrorMsg（StringUtils。substring（e。getMessage（），0，2000））；｝设置方法名称StringclassNamejoinPoint。getTarget（）。getClass（）。getName（）；StringmethodNamejoinPoint。getSignature（）。getName（）；operLog。setMethod（className。methodName（））；设置请求方式operLog。setRequestMethod（ServletUtils。getRequest（）。getMethod（））；处理设置注解上的参数getControllerMethodDescription（joinPoint，controllerLog，operLog，jsonResult）；保存数据库AsyncManager。me（）。execute（AsyncFactory。recordOper（operLog））；｝catch（Exceptionexp）｛记录本地异常ahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志alog。error（前置通知异常）；log。error（异常信息：｛｝，exp。getMessage（））；exp。printStackTrace（）；｝｝获取注解中对方法的描述信息用于Controller层注解paramlogahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志aparamoperLog操作ahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志athrowsExceptionpublicvoidgetControllerMethodDescription（JoinPointjoinPoint，Loglog，SysOperLogoperLog，ObjectjsonResult）throwsException｛设置action动作operLog。setBusinessType（log。businessType（）。ordinal（））；设置标题operLog。setTitle（log。title（））；设置操作人类别operLog。setOperatorType（log。operatorType（）。ordinal（））；是否需要保存request，参数和值if（log。isSaveRequestData（））｛获取参数的信息，传入到数据库中。setRequestValue（joinPoint，operLog）；｝是否需要保存response，参数和值if（log。isSaveResponseData（）StringUtils。isNotNull（jsonResult））｛operLog。setJsonResult（StringUtils。substring（JSON。toJSONString（jsonResult），0，2000））；｝｝获取请求的参数，放到log中paramoperLog操作ahrefhttps：www。bs178。comrizhitargetblankclassinfotextkey日志athrowsException异常privatevoidsetRequestValue（JoinPointjoinPoint，SysOperLogoperLog）throwsException｛StringrequestMethodoperLog。getRequestMethod（）；if（HttpMethod。PUT。name（）。equals（requestMethod）HttpMethod。POST。name（）。equals（requestMethod））｛StringparamsargsArrayToString（joinPoint。getArgs（））；operLog。setOperParam（StringUtils。substring（params，0，2000））；｝else｛Maplt；？，？paramsMap（Maplt；？，？）ServletUtils。getRequest（）。getAttribute（HandlerMapping。URITEMPLATEVARIABLESATTRIBUTE）；operLog。setOperParam（StringUtils。substring（paramsMap。toString（），0，2000））；｝｝参数拼装privateStringargsArrayToString（Object〔〕paramsArray）｛Stringparams；if（paramsArray！nullparamsArray。length0）｛for（Objecto：paramsArray）｛if（StringUtils。isNotNull（o）！isFilterObject（o））｛try｛ObjectjsonObjJSON。toJSON（o）；paramsjsonObj。toString（）；｝catch（Exceptione）｛｝｝｝｝returnparams。trim（）；｝判断是否需要过滤的对象。paramo对象信息。return如果是需要过滤的对象，则返回true；否则返回false。publicbooleanisFilterObject（finalObjecto）｛Classlt；？clazzo。getClass（）；if（clazz。isArray（））｛returnclazz。getComponentType（）。isAssignableFrom（MultipartFile。class）；｝elseif（Collection。class。isAssignableFrom（clazz））｛Collectioncollection（Collection）o；for（Objectvalue：collection）｛returnvalueinstanceofMultipartFile；｝｝elseif（Map。class。isAssignableFrom（clazz））｛Mapmap（Map）o；for（Objectvalue：map。entrySet（））｛Map。Entryentry（Map。Entry）value；returnentry。getValue（）instanceofMultipartFile；｝｝returnoinstanceofMultipartFileoinstanceofHttpServletRequestoinstanceofHttpServletResponseoinstanceofBindingResult；｝｝
　　大概跟小伙伴们捋一下这个切面的逻辑。首先定义了两种不同类型的通知：返回通知和异常通知，正常流程就是在返回通知中处理日志写入操作，但是如果系统不幸抛出异常，就在异常通知中处理日志写入操作（此时就多了一个异常对象）。日志数据保存在SysOperLog对象中，采集各种日志数据都是常规操作，不多说。当收集接口参数的时候，有两个需要注意的地方：1。如果请求类型是PUT或者POST，就直接从接口的参数中获取想要的数据，但是接口的参数中可能会存在一些并不需要记录的内容，例如HttpServletRequest、HttpServletResponse或者文件上传对象MultipartFile等，这些类型的内容是不需要记录到日志中的，这里通过一个isFilterObject方法完成了数据过滤操作；2。如果请求类型是GET或者DELETE，则请求参数就直接从请求对象提取了。为什么设计成这样呢？很明显，直接从请求对象中提取参数是最为方便的，一行代码就搞定，但是如果请求类型是PUT或者POST，就意味着请求参数是在请求体中，请求参数有可能是二进制数据（例如上传的文件），二进制数据就不好保存了，所以对于POST和PUT还是从接口参数中提取，然后过滤掉二进制数据即可。数据收集齐了，接下来就是往数据库中写入了。因为我们现在用的SpringMVC这一套是线程阻塞的，也就是得等到服务端都处理完毕之后，接口才会给客户端响应，而写日志是一个业务无关的操作，所以可以直接放在一个子线程中去完成。在RuoYiVue脚手架中，使用了JavaJUC中的ScheduledExecutorService去完成这个延时任务，AsyncManager。me（）。execute方法实际上就是去执行一个延时任务，这个延时任务就是一个往数据库中写入一条记录。4。记录日志
　　弄好之后，日志注解具体用法如下：Log（title参数管理，businessTypeBusinessType。EXPORT）PreAuthorize（ss。hasPermi（system：config：export））PostMapping（export）publicvoidexport（HttpServletResponseresponse，SysConfigconfig）｛ListSysConfiglistconfigService。selectConfigList（config）；ExcelUtilSysConfigutilnewExcelUtilSysConfig（SysConfig。class）；util。exportExcel（response，list，参数数据）；｝
　　好啦，这就是整体操作，实际上看起来并不难，后面要是有空的话，我把这个日志整成一个ELK的，和小伙伴们一起探讨。
　　我最近正在录制TienChin项目视频采用SpringBootVue3技术栈，里边会涉及到各种好玩的技术，小伙伴们来和我一起做一个完成率超90的项目。