在系统开发完成后就是系统维护了,系统中打印的日志是我们定位问题的关键。但是在真正问题来临时,经常会遇到同一时间日志庞大,不知道何去何从,尤其是并发用户庞大的系统,仅仅告知问题发生时间点,也很难一眼看出系统日志确切的位置。
那何如来解决这个问题呢?使得能够一眼找到用户发生错误的日志。
有一个比较好的技巧,也在一些比较好的应用系统中使用过,就是通过设置请求所在的线程名称,使得线程名称可读,而在日志中通常也会将线程名称打印出来,这样在遇到系统异常时,将线程名称提示给用户,让用户系统异常反馈时能够将这些信息反馈回来,这样能根据用户反馈,快速找到系统异常日志,快速解决问题提供帮助。
在Spring boot构建的Web系统中,可以通过增加Filter过滤器来实现,具体实现如下:
在Application.java入口类中,增加@ServletComponentScan声明,如下:
@Configuration
@EnableAutoConfiguration
@SpringBootApplication
@EnableDiscoveryClient
@ServletComponentScan
@EnableRedisHttpSession(redisFlushMode = RedisFlushMode.IMMEDIATE)
public class Application
{
public static void main( String[] args )
{
new SpringApplicationBuilder(Application.class).run(args);
}
}
实现UserLogFilter过滤器,声明为@WebFilter("/*"),在doFilter()中通过Thread.currentThread()获取当前请求的线程,并根据SESSION中存放的用户信息,来设置线程名称从而达到问题快速定位,如下所示:
package com.king.business.custom;
import java.io.IOException;
import java.util.UUID;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import com.alibaba.fastjson.JSON;
import com.king.business.bean.User;
@WebFilter("/*")
public class UserLogFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
HttpServletRequest httpReq = (HttpServletRequest)request;
HttpSession session = httpReq.getSession();
Object userStr = session.getAttribute("user");
if(null != userStr)
{
User user = JSON.parseObject((String)userStr,User.class);
Thread current = Thread.currentThread();
current.setName(user.getAccount()+"-"+UUID.randomUUID());
}
chain.doFilter(request, response);
}
@Override
public void destroy() {
// TODO Auto-generated method stub
}
}
最终日志中显示的内容为带用户账号信息的线程名称,如下:
可见,简单调整一下系统线程名称,就能极大改善系统的可维护性。设置线程名称,已经在有些开发规范要求,尤其在多线程开发时,问题也能快速定位。
上述线程命名实现只是一个示例,需要根据自己业务需要,设置不同的线程名称,具体问题具体分析了,不过通常可以使用登录用户账号+服务器名+时间戳+UUID来命名,一般能够达到常用的需要。