日志处理 三：Filter+自定义注解实现 系统日志跟踪功能

2024-03-20 04:48
文章标签 实现 日志 自定义 功能 处理 注解 filter 跟踪 系统日志

本文主要是介绍日志处理 三：Filter+自定义注解实现 系统日志跟踪功能，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章有点长，可以先看目录。
代码有点多，如果感兴趣或者需要的话，欢迎和我交流。


一般情况下，对来自浏览器的请求的拦截，是利用Filter实现的，这种方式可以实现Bean预处理、后处理。 

这里是利用springmvc的拦截器开发了log功能，用于跟踪、记录系统用户的操作轨迹，以便日后的认责。

该功能使用很方便，是可配置的、细粒度的日志记录功能。之所以细粒度，因为level分为三层，默认包层（rootLogLevel默认值TRACE），自定义包层（customLogLevel），具体方法层（@Log默认值TRACE）

 

简单介绍SpringMVC的HandlerInterceptorAdapter

Spring MVC的拦截器不仅可实现Filter的所有功能，还可以更精确的控制拦截精度。 

Spring为我们提供了org.springframework.web.servlet.handler.HandlerInterceptorAdapter这个适配器，继承此类，可以非常方便的实现自己的拦截器。他有三个方法：

public boolean preHandle(HttpServletRequest request,HttpServletResponse response, Object handler) throws Exception{ return true; } public voidpostHandle( HttpServletRequest request, HttpServletResponse response, Objecthandler, ModelAndView modelAndView) throwsException { } public voidafterCompletion( HttpServletRequest request, HttpServletResponse response, Objecthandler, Exception ex) throwsException { }


分别实现预处理、后处理（调用了Service并返回ModelAndView，但未进行页面渲染）、返回处理（已经渲染了页面） 

在preHandle中，可以进行编码、安全控制等处理； 

在postHandle中，有机会修改ModelAndView； 

在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。 

 

配置：spring-mvc.xml

<!--系统日志跟踪功能 -->
<beanid="log4JDBCImpl"class="com.ketayao.ketacustom.log.impl.Log4JDBCImpl" >
<propertyname="logEntityService" ref="logEntityServiceImpl"/>
<propertyname="rootLogLevel" value="ERROR"/>
<!--自定义日志级别 -->
<propertyname="customLogLevel"><map><entrykey="com.ketayao.ketacustom" value="TRACE" /><entrykey="com.sample" value="INFO" /></map></property>
</bean><mvc:interceptors>
<mvc:interceptor>
<mvc:mappingpath="/management/**" />
<mvc:mappingpath="/login/timeout/success"/>
<beanclass="com.ketayao.ketacustom.log.spring.LogInterceptor" >
<propertyname="logAPI" ref="log4JDBCImpl"/>
</bean>
</mvc:interceptor>                
</mvc:interceptors>

 

mvc:interceptors

这个标签用于注册一个自定义拦截器或者是WebRequestInterceptors.

可以通过定义URL来进行路径请求拦截，可以做到较为细粒度的拦截控制。

 

 

日志的JDBC实现

LogAPI：自定义LogAPI接口

/***        自定义LogAPI接口* 定义日志记录和日志级别规范*/publicinterface LogAPI {
voidlog(String message, LogLevel logLevel);voidlog(String message, Object[] objects, LogLevel logLevel);/**** 得到全局日志等级* @return*/
LogLevelgetRootLogLevel();/**** 得到自定义包的日志等级* @return*/
Map<String,LogLevel> getCustomLogLevel();
}

 

LogLevel：日志级别枚举类型

/*** 值越大，等级越高。        */publicenum LogLevel {
TRACE("TRACE"),DEBUG("DEBUG"),INFO("INFO"),WARN("WARN"),ERROR("ERROR");privateString value;LogLevel(Stringvalue) {
this.value= value;
}publicString value() {
returnthis.value;
}
}

由代码发现，枚举值后面有属性值，这是Enums的构造函数的用法

 

Log4JDBCImpl：实现LogAPI接口

/*** 全局日志等级<包日志等级<类和方法日志等级* @author        <ahref="mailto:ketayao@gmail.com">ketayao</a>* Version 2.1.0* @since  2013-5-3 下午4:41:55*/
publicclass Log4JDBCImpl implements LogAPI {privateLogLevel rootLogLevel = LogLevel.ERROR;privateLogEntityService logEntityService;privateMap<String, LogLevel> customLogLevel = Maps.newHashMap();/**** @param message* @param objects* @param logLevel * @seecom.ketayao.ketacustom.log.impl.LogAdapter#log(java.lang.String,java.lang.Object[], com.ketayao.ketacustom.log.LogLevel)*/
@Override
publicvoid log(String message, Object[] objects, LogLevel logLevel){        MessageFormatmFormat = new MessageFormat(message);
Stringresult = mFormat.format(objects);if(!StringUtils.isNotBlank(result)) {
return;
}Subjectsubject = SecurityUtils.getSubject();
ShiroDbRealm.ShiroUsershiroUser = (ShiroDbRealm.ShiroUser)subject.getPrincipal();//result= shiroUser.toString() + ":" + result;LogEntitylogEntity = new LogEntity();
logEntity.setCreateTime(newDate());logEntity.setUsername(shiroUser.getLoginName());
logEntity.setMessage(result);
logEntity.setIpAddress(shiroUser.getIpAddress());
logEntity.setLogLevel(logLevel);logEntityService.save(logEntity);
}publicvoid setRootLogLevel(LogLevel rootLogLevel) {
this.rootLogLevel= rootLogLevel;
}/**  ** @return * @seecom.ketayao.ketacustom.log.LogTemplate#getRootLogLevel() */
@Override
publicLogLevel getRootLogLevel() {
returnrootLogLevel;
}publicvoid setCustomLogLevel(Map<String, LogLevel> customLogLevel) {
this.customLogLevel= customLogLevel;
}@Override
publicMap<String, LogLevel> getCustomLogLevel() {
returncustomLogLevel;
}publicvoid setLogEntityService(LogEntityService logEntityService) {
this.logEntityService= logEntityService;
}@Override
publicvoid log(String message, LogLevel logLevel) {
log(message,null,logLevel);
}}

 

 

日志的业务逻辑的记录

Log：自定义注解

/***        */
@Documented
@Target({METHOD})
@Retention(RUNTIME)
public@interface Log {
/**** 日志信息* @return*/
Stringmessage();/**** 日志记录等级* @return*/
LogLevellevel() default LogLevel.TRACE;/**** 是否覆盖包日志等级* 1.为false不会参考level属性。* 2.为true会参考level属性。* @return*/
booleanoverride() default false;
}

 

LogUitl：将request放入ThreadLocal用于LOG_ARGUMENTS注入

/***将request放入ThreadLocal用于LOG_ARGUMENTS注入。        */
publicabstract class LogUitl {
//用于存储每个线程的request请求
privatestatic final ThreadLocal<HttpServletRequest> LOCAL_REQUEST = newThreadLocal<HttpServletRequest>();publicstatic void putRequest(HttpServletRequest request) {
LOCAL_REQUEST.set(request);
}publicstatic HttpServletRequest getRequest() {
returnLOCAL_REQUEST.get();
}publicstatic void removeRequest() {
LOCAL_REQUEST.remove();
}/*** 将LogMessageObject放入LOG_ARGUMENTS。* 描述* @param logMessageObject*/
publicstatic void putArgs(LogMessageObject logMessageObject) {
HttpServletRequestrequest = getRequest();
request.setAttribute(SecurityConstants.LOG_ARGUMENTS,logMessageObject);
}/*** 得到LogMessageObject。* 描述* @param logMessageObject*/
publicstatic LogMessageObject getArgs() {
HttpServletRequestrequest = getRequest();
return(LogMessageObject)request.getAttribute(SecurityConstants.LOG_ARGUMENTS);
}
}

 

TaskController ：处理操作Task模块的用户请求逻辑

/***莫紧张，仅仅是一个例子。        */
@Controller
@RequestMapping("/management/sample/task")
publicclass TaskController {@Autowired
privateTaskService taskService;@Autowired
privateValidator validator;privatestatic final String CREATE = "management/sample/task/create";
privatestatic final String UPDATE = "management/sample/task/update";
privatestatic final String LIST = "management/sample/task/list";
privatestatic final String VIEW = "management/sample/task/view";@RequiresPermissions("Task:save")
@RequestMapping(value="/create",method=RequestMethod.GET)
publicString preCreate(Map<String, Object> map) {
returnCREATE;
}/*** LogMessageObject的write用法实例。*/
@Log(message="添加了{0}任务，LogMessageObject的isWritten为true。",level=LogLevel.INFO)
@RequiresPermissions("Task:save")
@RequestMapping(value="/create",method=RequestMethod.POST)
public@ResponseBody String create(Task task) {
BeanValidators.validateWithException(validator,task);
taskService.save(task);//加入一个LogMessageObject，该对象的isWritten为true，会记录日志。
LogUitl.putArgs(LogMessageObject.newWrite().setObjects(newObject[]{task.getTitle()}));
returnAjaxObject.newOk("任务添加成功！").toString();
}/*** LogMessageObject的ignore用法实例，ignore不会记录日志。*/
@Log(message="你永远不会看见该日志，LogMessageObject的isWritten为false。",level=LogLevel.INFO)
@RequiresPermissions("Task:edit")
@RequestMapping(value="/update/{id}",method=RequestMethod.GET)
publicString preUpdate(@PathVariable Long id, Map<String, Object> map) {
Tasktask = taskService.get(id);map.put("task",task);//加入一个LogMessageObject，该对象的isWritten为false，不会记录日志。
LogUitl.putArgs(LogMessageObject.newIgnore());
returnUPDATE;
}/*** Log的level用法实例*1.level分为三层，默认包层（rootLogLevel默认值TRACE），自定义包层（customLogLevel），具体方法层（@Log默认值TRACE）*2.参考顺序：默认包层->自定义包层->具体方法层->LogMessageObject* 3.有自定义包层的level等级会忽略默认包层* 4.@Log的level大于等于自定义包层或者默认的level会输出日志；小于则不会。*/
@Log(message="Log的level用法实例，LogLevel.TRACE小于自定义包层LogLevel.INFO，不会输出日志。",level=LogLevel.TRACE)
@RequiresPermissions("Task:edit")
@RequestMapping(value="/update",method=RequestMethod.POST)
public@ResponseBody String update(Task task) {
BeanValidators.validateWithException(validator,task);
taskService.update(task);returnAjaxObject.newOk("任务修改成功！").toString();
}/*** Log的override用法实例* 假如override为true，会忽略掉level** 批量删除展示*/
@Log(message="Log的override用法实例，override为true，会忽略掉level。删除了{0}任务。",level=LogLevel.TRACE, override=true)
@RequiresPermissions("Task:delete")
@RequestMapping(value="/delete",method=RequestMethod.POST)
public@ResponseBody String deleteMany(Long[] ids) {
String[]titles = new String[ids.length];
for(int i = 0; i < ids.length; i++) {
Tasktask = taskService.get(ids[i]);
taskService.delete(task.getId());titles[i]= task.getTitle();
}LogUitl.putArgs(LogMessageObject.newWrite().setObjects(newObject[]{Arrays.toString(titles)}));
returnAjaxObject.newOk("任务删除成功！").setCallbackType("").toString();
}@RequiresPermissions("Task:view")
@RequestMapping(value="/list",method={RequestMethod.GET, RequestMethod.POST})
publicString list(Page page, String keywords, Map<String, Object> map) {
List<Task>tasks = null;
if(StringUtils.isNotBlank(keywords)) {
tasks= taskService.find(page, keywords);
} else{
tasks= taskService.findAll(page);
}map.put("page",page);
map.put("tasks",tasks);
map.put("keywords",keywords);returnLIST;
}/*** 自定look权限，实例。* 描述* @param id* @param map* @return*/
@RequiresPermissions("Task:look")
@RequestMapping(value="/view/{id}",method={RequestMethod.GET})
publicString view(@PathVariable Long id, Map<String, Object> map) {
Tasktask = taskService.get(id);
map.put("task",task);
returnVIEW;
}
}

 

使用Filter拦截，将日志信息持久化

LogInterceptor:        继承HandlerInterceptorAdapter，覆盖三个方法实现

/***        继承HandlerInterceptorAdapter，覆盖三个方法实现*/publicclass LogInterceptor extends HandlerInterceptorAdapter {
privatefinal static Logger LOGGER = LoggerFactory.getLogger(LogInterceptor.class);privateLogAPI logAPI;/**  * 将request存入LogUitl中的LOCAL_REQUEST。* @param request* @param response* @param handler* @return* @throws Exception */
@Override
publicboolean preHandle(HttpServletRequest request,
HttpServletResponseresponse, Object handler) throws Exception {
LogUitl.putRequest(request);
returntrue;
}@Override
publicvoid postHandle(HttpServletRequest request,
HttpServletResponseresponse, Object handler,
ModelAndViewmodelAndView) throws Exception {if(!(handler instanceof HandlerMethod)) {
return;
}finalHandlerMethod handlerMethod = (HandlerMethod)handler;
Methodmethod = handlerMethod.getMethod();finalLog log = method.getAnnotation(Log.class);
if (log!= null) {
//得到LogMessageObject
finalLogMessageObject logMessageObject = LogUitl.getArgs();
//另起线程异步操作
newThread(new Runnable() {@Override
publicvoid run() {
try {
LogLevellastLogLevel = logAPI.getRootLogLevel();//先对自定义包等级做判断
Map<String,LogLevel> customLogLevel = logAPI.getCustomLogLevel();
if(!customLogLevel.isEmpty()) {
Class<?>clazz = handlerMethod.getBean().getClass();
StringpackageName = clazz.getPackage().getName();Set<String>keys = customLogLevel.keySet();
for(String key : keys) {
if(packageName.startsWith(key)) {
lastLogLevel= customLogLevel.get(key);
break;
}
}
}LogMessageObjectdefaultLogMessageObject = logMessageObject;
if(defaultLogMessageObject == null) {
defaultLogMessageObject= LogMessageObject.newWrite();
}if(defaultLogMessageObject.isWritten()) { // 判断是否写入log
//覆盖，直接写入日志
if(log.override()) {
logAPI.log(log.message(),defaultLogMessageObject.getObjects(), log.level());
}else {
//不覆盖，参考方法的日志等级是否大于等于最终的日志等级
if(!log.override() && log.level().compareTo(lastLogLevel) >= 0 ) {
logAPI.log(log.message(),defaultLogMessageObject.getObjects(), log.level());
}
}
}                                                
}catch (Exception e) {
LOGGER.error(Exceptions.getStackTraceAsString(e));
}
}
}).start();}}/*** 清除LogUitl中的LOCAL_REQUEST。* @param request* @param response* @param handler* @param ex* @throws Exception * @seeorg.springframework.web.servlet.handler.HandlerInterceptorAdapter#afterCompletion(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse, java.lang.Object, java.lang.Exception) */
@Override
publicvoid afterCompletion(HttpServletRequest request,
HttpServletResponseresponse, Object handler, Exception ex)
throwsException {
LogUitl.removeRequest();
}publicvoid setLogAPI(LogAPI logAPI) {
this.logAPI= logAPI;
}


看看最终得到的日志数据

       





这篇关于日志处理 三：Filter+自定义注解实现 系统日志跟踪功能的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/828334。

相关文章

Java实现检查多个时间段是否有重合

Java实现检查多个时间段是否有重合

《Java实现检查多个时间段是否有重合》这篇文章主要为大家详细介绍了如何使用Java实现检查多个时间段是否有重合,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录流程概述步骤详解China编程步骤1：定义时间段类步骤2：添加时间段步骤3：检查时间段是否有重合步骤4：输出结果示例代码结语作
阅读更多...
使用C++实现链表元素的反转

使用C++实现链表元素的反转

《使用C++实现链表元素的反转》反转链表是链表操作中一个经典的问题,也是面试中常见的考题,本文将从思路到实现一步步地讲解如何实现链表的反转,帮助初学者理解这一操作,我们将使用C++代码演示具体实现,同... 目录问题定义思路分析代码实现带头节点的链表代码讲解其他实现方式时间和空间复杂度分析总结问题定义给定
阅读更多...
Java覆盖第三方jar包中的某一个类的实现方法

Java覆盖第三方jar包中的某一个类的实现方法

《Java覆盖第三方jar包中的某一个类的实现方法》在我们日常的开发中,经常需要使用第三方的jar包,有时候我们会发现第三方的jar包中的某一个类有问题,或者我们需要定制化修改其中的逻辑,那么应该如何... 目录一、需求描述二、示例描述三、操作步骤四、验证结果五、实现原理一、需求描述需求描述如下：需要在
阅读更多...
如何使用Java实现请求deepseek

如何使用Java实现请求deepseek

《如何使用Java实现请求deepseek》这篇文章主要为大家详细介绍了如何使用Java实现请求deepseek功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1.deepseek的api创建2.Java实现请求deepseek2.1 pom文件2.2 json转化文件2.2
阅读更多...
python使用fastapi实现多语言国际化的操作指南

python使用fastapi实现多语言国际化的操作指南

《python使用fastapi实现多语言国际化的操作指南》本文介绍了使用Python和FastAPI实现多语言国际化的操作指南,包括多语言架构技术栈、翻译管理、前端本地化、语言切换机制以及常见陷阱和... 目录多语言国际化实现指南项目多语言架构技术栈目录结构翻译工作流1. 翻译数据存储2. 翻译生成脚本
阅读更多...
在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

《在SpringBoot中使用@Autowired和@Bean注解的示例详解》本文通过一个示例演示了如何在SpringBoot中使用@Autowired和@Bean注解进行依赖注入和Bean... 目录在 Spring Boot 中使用 @Autowired 和 @Bean 注解示例背景1. 定义 Stud
阅读更多...
如何通过Python实现一个消息队列

如何通过Python实现一个消息队列

《如何通过Python实现一个消息队列》这篇文章主要为大家详细介绍了如何通过Python实现一个简单的消息队列,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录如何通过 python 实现消息队列如何把 http 请求放在队列中执行1. 使用 queue.Queue 和 reque
阅读更多...
Python如何实现PDF隐私信息检测

Python如何实现PDF隐私信息检测

《Python如何实现PDF隐私信息检测》随着越来越多的个人信息以电子形式存储和传输,确保这些信息的安全至关重要,本文将介绍如何使用Python检测PDF文件中的隐私信息,需要的可以参考下... 目录项目背景技术栈代码解析功能说明运行结php果在当今，数据隐私保护变得尤为重要。随着越来越多的个人信息以电子形
阅读更多...
使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

使用 sql-research-assistant进行 SQL 数据库研究的实战指南(代码实现演示)

《使用sql-research-assistant进行SQL数据库研究的实战指南(代码实现演示)》本文介绍了sql-research-assistant工具,该工具基于LangChain框架,集... 目录技术背景介绍核心原理解析代码实现演示安装和配置项目集成LangSmith 配置（可选）启动服务应用场景
阅读更多...
使用Python快速实现链接转word文档

使用Python快速实现链接转word文档

《使用Python快速实现链接转word文档》这篇文章主要为大家详细介绍了如何使用Python快速实现链接转word文档功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 演示代码展示from newspaper import Articlefrom docx import
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2