SpringBoot结合Aop记录请求日志

Aop指面向切面编程,在spring mvc 里已经出现,springBoot作为体系之一,也包含AOP。在一个Web应用中,我希望记录所有请求的远端地址,请求客户端类型,请求URI等记录,一方面是为了做安全记录,同时也可以提供后期考虑数据分析的基础数据,具体可以通过Headers信息获取。常见的比较重要的头信息包括 user-agent, accept等,其他如URI,queryString 等在serveletRequest中得到。如果单独考虑每个方法里附加方法,太过笨拙,AOP的特性提供了很好的方案。可以按照包,类,方法,注解各个级别作为切点,拦截访问请求,做附加处理。当然,现实中各种项目也是通过AOP实现类似的功能,包括访问日志记录,验证头信息,数据库SQL分析统计,redis请求统计等。


看个图放松

基本功能已经完成,中间有遇到AOP不生效的情况,查找相关资料,有建议添加配置项spring.aop.auto=true , spring.aop.proxy-target-class=true,后者是使用CGLIB代理,可能有性能下降。其实都不需要这些配置,默认是生效的,后面解释原因;还有建议添加@EnableProxyTargetClass,原因也类似;以及建议添加@ComponentScan覆盖AOP目录。以上可能是在某些情况下的适用方案。这次遇到的问题其实是切入条件不正确,在相关例子中缺少了public前缀,导致的不生效。正确是:@Pointcut("execution (public * com.igoso.me.gallery.controller.*.*(..))")
另外有个缺陷是,为查询记录,添加了查询的HTTP请求,本身也会被记录其中,后续再考虑在入库之前进行过滤,目前没有影响。

补充:多个Aop可以使用@Order(n),来控制顺序。

如下是整个Aspect的代码:

/**
 * created by igoso at 2018/5/26
 **/
@Aspect
@Component
public class HttpLogAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger("HTTP_LOG");

    @Resource
    private HeaderDetailDao headerDetailDao;

    @Pointcut("execution (public * com.igoso.me.gallery.controller.*.*(..))")
    public void log() {

    }

    @Before("log()")
    public void doBefore(JoinPoint joinPoint) {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (null == attributes) {
            LOGGER.error("get servlet request attributes null");
            return;
        }
        HttpServletRequest request = attributes.getRequest();

        Map<String,String> headers = new HashMap<>();
        String name;
        request.getAttributeNames();
        for (Enumeration e = request.getHeaderNames(); e.hasMoreElements();) {
            name = e.nextElement().toString();
            headers.put(name, request.getHeader(name));
        }

        headers.put("uri", request.getRequestURI());
        headers.put("queryString", request.getQueryString());
        headers.put("remoteAddr", request.getRemoteAddr());
        headers.put("method", request.getMethod());
        headers.put("remoteHost",request.getRemoteHost());
        headers.put("remotePort",String.valueOf(request.getRemotePort()));
        headers.put("protocol",request.getProtocol());

        HeaderDetail headerDetail = new HeaderDetail(headers, JSON.toJSONString(headers));
        LOGGER.debug(JSON.toJSONString(headers,true));

        try {
            headerDetailDao.insert(headerDetail);
        } catch (Exception e) {
            LOGGER.error("insert header detail error:{}",e);
        }

    }

}


/**
 * created by igoso at 2018/5/26
 **/

@Getter
@Setter
@NoArgsConstructor
public class HeaderDetail extends Entity{

    private String acceptLanguage;
    private String method;
    private String remoteHost;
    private String remotePort;
    private String remoteAddr;
    private String queryString;
    private String uri;
    private String accept;
    private String localHost;
    private String acceptEncoding;
    private String userAgent;
    private String protocol;
    private String extensions;//json

    public HeaderDetail(Map<String,String> origin, String extensions) {
        this.acceptLanguage = origin.get(HeaderAttributes.ACCEPT_LANGUAGE);
        this.method = origin.get(HeaderAttributes.METHOD);
        this.remoteAddr = origin.get(HeaderAttributes.REMOTE_ADDR);
        this.remoteHost = origin.get(HeaderAttributes.REMOTE_HOST);
        this.remotePort = origin.get(HeaderAttributes.REMOTE_PORT);
        this.queryString = origin.get(HeaderAttributes.QUERY_STRING);
        this.uri = origin.get(HeaderAttributes.URI);
        this.accept = origin.get(HeaderAttributes.ACCEPT);
        this.localHost = origin.get(HeaderAttributes.LOCAL_HOST);
        this.acceptEncoding = origin.get(HeaderAttributes.ACCEPT_ENCODING);
        this.userAgent = origin.get(HeaderAttributes.USER_AGENT);
        this.protocol = origin.get(HeaderAttributes.PROTOCOL);

        this.extensions = extensions; //other
    }

    private class HeaderAttributes{
        static final String ACCEPT_LANGUAGE = "accept-language";
        static final String METHOD = "method";
        static final String REMOTE_ADDR = "remoteAddr";
        static final String REMOTE_HOST = "remoteHost";
        static final String REMOTE_PORT = "remotePort";
        static final String QUERY_STRING = "queryString";
        static final String URI = "uri";
        static final String ACCEPT = "accept";
        static final String LOCAL_HOST = "host";
        static final String ACCEPT_ENCODING = "accept-encoding";
        static final String USER_AGENT = "user-agent";
        static final String PROTOCOL = "protocol";
    }
}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,652评论 18 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 22,394评论 1 92
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,804评论 6 342
  • 要加“m”说明是MB,否则就是KB了. -Xms:初始值 -Xmx:最大值 -Xmn:最小值 java -Xms8...
    dadong0505阅读 4,829评论 0 53
  • 从开始读书课到现在已经进行一个月的时间,每天事情超级多,看书的进度也很慢。看啦《拆掉思维里的墙》还有正在进行的《...
    莹268吕瑞莹阅读 222评论 0 0