2. 程式人生 > >springcloud專案搭建（五）----使用Spring aop完成統一日誌和異常管理

springcloud專案搭建（五）----使用Spring aop完成統一日誌和異常管理

阿新 • • 發佈：2019-01-07

專案地址：https://gitee.com/lwydyby/springcloud-adplatform
注：由於專案初期搭建，暫未使用springcloud-sleuth進行追蹤分析，而是使用AOP進行統一的日誌記錄
1.編寫切面類
1）.DisableGameleyLog為自定義註解，為了可以通過該註解跳過一些不必記錄的操作
2）目前只記錄controller層日誌
3）該攔截器除日誌記錄功能外，也進行了統一的異常處理，如丟擲異常，統一返回給介面500
4）由於將該配置儲存在公共的基礎common包中，只要引入common的所有專案都會預設在啟動時載入該配置，無需再進行單獨的配置。

package com.gameley.common.Interceptor;

import com.gameley.common.exception.BaseException;
import com.gameley.common.util.ClientUtil;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory
 
;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util
 
.Arrays;

@Aspect
@Component
public class HttpAspect {

    private final static Logger logger = LoggerFactory.getLogger(HttpAspect.class);


    @SuppressWarnings("unchecked")
    @Pointcut("execution(public * com.gameley.controller.*.*(..)) && [email protected](com.gameley.common.DisableGameleyLog))")
    public void log(){

    }

    @Before("log()")
    public void doBefore(JoinPoint joinPoint){
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 記錄下請求內容
        logger.info("請求地址 : " + request.getRequestURL().toString());
        logger.info("HTTP METHOD : " + request.getMethod());
        // 獲取真實的ip地址
        logger.info("IP : " + ClientUtil.getClientIp(request));
        logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                + joinPoint.getSignature().getName());
        logger.info("引數 : " + Arrays.toString(joinPoint.getArgs()));
    }

    @Around("log()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        try {
            long startTime = System.currentTimeMillis();
            Object ob= proceedingJoinPoint.proceed();
            logger.info("耗時 : " + (System.currentTimeMillis() - startTime));
            return ob;
        } catch (Exception e) {
            logger.error("error:",e);
            return new BaseException("後臺操作異常",500);

        }


    }

    @AfterReturning(pointcut = "log()",returning = "object")//列印輸出結果
    public void doAfterReturing(Object object){
        logger.info("response={}",object.toString());
    }
}

2.編寫DisableGameleyLog自定義註解

package com.gameley.common;


import java.lang.annotation.*;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DisableGameleyLog {
}

3.建立logback配置檔案（目前為從網上下載的模板，待使用後再修改）

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--
       說明：
       1、日誌級別及檔案
           日誌記錄採用分級記錄，級別與日誌檔名相對應，不同級別的日誌資訊記錄到不同的日誌檔案中
           例如：error級別記錄到log_error_xxx.log或log_error.log（該檔案為當前記錄的日誌檔案），而log_error_xxx.log為歸檔日誌，
           日誌檔案按日期記錄，同一天內，若日誌檔案大小等於或大於2M，則按0、1、2...順序分別命名
           例如log-level-2013-12-21.0.log
           其它級別的日誌也是如此。
       2、檔案路徑
           若開發、測試用，在Eclipse中執行專案，則到Eclipse的安裝路徑查詢logs資料夾，以相對路徑../logs。
           若部署到Tomcat下，則在Tomcat下的logs檔案中
       3、Appender
           FILEERROR對應error級別，檔名以log-error-xxx.log形式命名
           FILEWARN對應warn級別，檔名以log-warn-xxx.log形式命名
           FILEINFO對應info級別，檔名以log-info-xxx.log形式命名
           FILEDEBUG對應debug級別，檔名以log-debug-xxx.log形式命名
           stdout將日誌資訊輸出到控制上，為方便開發測試使用
    -->
    <contextName>userservice</contextName>
    <property name="LOG_PATH" value="/home" />
    <!--設定系統日誌目錄-->
    <property name="APPDIR" value="userService" />

    <!-- 日誌記錄器，日期滾動記錄 -->
    <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${LOG_PATH}/${APPDIR}/log_error.log</file>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日誌檔案的路徑，例如今天是2013-12-21日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
            而2013-12-21的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日誌記錄之外，還配置了日誌檔案不能超過2M，若超過2M，日誌檔案會以索引0開始，
            命名日誌檔案，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式記錄日誌 -->
        <append>true</append>
        <!-- 日誌檔案的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日誌檔案只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日誌記錄器，日期滾動記錄 -->
    <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日誌檔案的路徑，例如今天是2013-12-21日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
            而2013-12-21的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日誌記錄之外，還配置了日誌檔案不能超過2M，若超過2M，日誌檔案會以索引0開始，
            命名日誌檔案，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式記錄日誌 -->
        <append>true</append>
        <!-- 日誌檔案的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日誌檔案只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>warn</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 日誌記錄器，日期滾動記錄 -->
    <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${LOG_PATH}/${APPDIR}/log_info.log</file>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 歸檔的日誌檔案的路徑，例如今天是2013-12-21日誌，當前寫的日誌檔案路徑為file節點指定，可以將此檔案與file指定檔案路徑設定為不同路徑，從而將當前日誌檔案或歸檔日誌檔案置不同的目錄。
            而2013-12-21的日誌檔案在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引 -->
            <fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 除按日誌記錄之外，還配置了日誌檔案不能超過2M，若超過2M，日誌檔案會以索引0開始，
            命名日誌檔案，例如log-error-2013-12-21.0.log -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>2MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 追加方式記錄日誌 -->
        <append>true</append>
        <!-- 日誌檔案的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!-- 此日誌檔案只記錄info級別的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!--encoder 預設配置為PatternLayoutEncoder-->
        <encoder>
            <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--此日誌appender是為開發使用，只配置最底級別，控制檯輸出的日誌級別是大於或等於此級別的日誌資訊-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <logger name="org.springframework" level="WARN" />
    <logger name="org.hibernate" level="WARN" />

    <!-- 生產環境下，將此級別配置為適合的級別，以免日誌檔案太多或影響程式效能 -->
    <root level="INFO">
        <appender-ref ref="FILEERROR" />
        <appender-ref ref="FILEWARN" />
        <appender-ref ref="FILEINFO" />

        <!-- 生產環境將請stdout,testfile去掉 -->
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

相關推薦

springcloud專案搭建（五）----使用Spring aop完成統一日誌和異常管理

專案地址：https://gitee.com/lwydyby/springcloud-adplatform 注：由於專案初期搭建，暫未使用springcloud-sleuth進行追蹤分析，而是使用AOP進行統一的日誌記錄 1.編寫切面類 1）.Disa

企業分布式微服務雲SpringCloud SpringBoot mybatis （五）Spring Boot中Web應用的統一異常處理

src one exception learn 微服務 public .net 可能 訪問 我們在做Web應用的時候，請求處理過程中發生錯誤是非常常見的情況。Spring Boot提供了一個默認的映射：/error，當處理中拋出異常之後，會轉到該請求中處理，並且該請求有一個

Java Spring MVC專案搭建（一）——Spring MVC框架整合

轉自：https://www.cnblogs.com/eczhou/p/6287852.html 1、Java JDK及Tomcat安裝 我這裡安裝的是JDK 1.8 及 Tomcat 8，安裝步驟詳見：http://www.cnblogs.com/eczhou/p/6285248.html

java程式設計師菜鳥進階（十七）linux基礎入門（五）linux檔案/目錄的許可權和歸屬管理

在linux中的每一個檔案或目錄都包含有訪問許可權，這些訪問許可權決定了誰能訪問和如何訪問這些檔案和目錄。相應的每一個檔案和目錄都有所屬的屬主和屬組，合理的設定檔案和目錄的屬組和屬主在檔案/目錄管理中佔據著很重要的地位，所以，今天我就和大家一起來看一下有關檔案/目錄的許可權和歸屬的相關設定

Java Spring MVC專案搭建（二）——專案配置

文章轉載自：https://www.cnblogs.com/eczhou/p/6287876.html 1、站點配置檔案web.xml 每一個Spring MVC 專案都必須有一個站點配置檔案web.xml，他的主要功能嗎....有一位大哥已經整理的很好，我借來了，大家看看： 引用部落格

Java程式設計師從笨鳥到菜鳥之（七十三）細談Spring（五）spring之AOP底層大揭祕

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

Spring AOP（五）—— Spring的基於AspectJ的AOP開發

Spring的基於AspectJ的AOP開發 之前我們已經講過了實現AOP的兩種方式，那麼下面我們講一下Spring中的AOP開發。與Spring中的IOC控制反轉類似，我們可以在xml中實現和使用註解

maven 專案（五） spring整合springMVC開發統一接入API--實現test介面

為什麼要採用測試介面的方式：貼完程式碼我再來說； 1.貼張圖片 2.是測試介面地址的暴露方式： @Controller public class ApiTestController { @Value("${epeit.api.server}") private St

個人網站的搭建（六）——Spring之AOP

    之前已經配置好日誌系統，現在的想法是將頁面上每個請求的資訊都記錄下了。包括url，引數，返回值，執行時間等。    我想到了spring的aop功能。    一、理論準備    一句話：切點通知切面。    二、新建LogAspect.java@Aspect @Com

Spring學習（二十五）Spring AOP之增強介紹

課程概要： Spring AOP的基本概念Spring AOP的增強型別Spring AOP的前置增強Spring AOP的後置增強Spring AOP的環繞增強Spring AOP的異常丟擲增強Sp

Spring Web MVC專案搭建（二）Swagger搭建

Maven引入swagger相關jar包 <dependency> <groupId>com.mangofactory</groupId> <artifactId>swagger-spring

【原創】從零開始搭建Electron+Vue+Webpack專案框架（五）預載入和Electron自動更新

導航： （一）Electron跑起來（二）從零搭建Vue全家桶+webpack專案框架（三）Electron+Vue+Webpack，聯合除錯整個專案（四）Electron配置潤色（五）預載入及自動更新（六）構建、釋出整個專案（包括client和web）（未完待續） 摘要：到目前為止，我們的專案已經具備了PC

spring---aop（3）---Spring AOP的攔截器鏈

ati handler 攔截器 odi hand zab chain 記載 封裝 寫在前面 　　時間斷斷續續，這次寫一點關於spring aop攔截器鏈的記載。至於如何獲取spring的攔截器，前一篇博客已經寫的很清楚（spring---aop（2）---Spring AO

spring---aop（6）---Spring AOP中ProxyFactoryBean介紹

except trace col fine erl 參數 owa per face 寫在前面 　　這篇文章裏面就要說說Spring自己的AOP，搞清楚哪種方式是Spring自己實現的AOP，哪種方式是Spring引入aspectj的AOP。 簡單例子 　　Spring

（轉）spring aop

nal 需要 註解 環境 col 日誌 多說 list ns-3 工作忙，時間緊，不過事情再多，學習是必須的。記得以前的部門老大說過：“開發人員不可能一天到晚只有工作，肯定是需要自我學習。第一：為了更充實自己，保持進步狀態。第二：為了提升技術，提高開發能力。第三：保持程序員

（轉）spring aop(下）

pointcut too point stat 小時 size bin arch org 昨天記錄了Spring AOP學習的一部分（http://www.cnblogs.com/yanbincn/archive/2012/08/13/2635413.html），本來是想一

Spring Boot參考教程（五）Spring Boot配置使用之配置類用法

expr web程序 成功 驗證 pan hub parameter lan fix 4.2. SpringBoot配置使用之配置類使用 Spring Boot的大部分自動配置都可以滿足應用要求，但如果想精確的控制應用，或者想覆蓋自動配置，使用配置類是另一種很好的選擇，強調

Spring Boot實戰筆記（五）-- Spring高級話題（Spring Aware）

ktr mea 框架 .com cat 分享 aware war uic 一、Spring Aware 　　Spring 依賴註入的最大亮點就是你所有的 Bean 對 Spring容器的存在是沒有意識的。即你可以將你的容器替換成其他的容器，如Google Guice，這時

Spring AOP高級——源碼實現（2）Spring AOP中通知器（Advisor）與切面（Aspect）

color oaf 小麻煩 ntc tro sta ins pack package 本文例子完整源碼地址：https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/Spring%20AO

企業分布式微服務雲SpringCloud SpringBoot mybatis （七）Spring Boot中使用JdbcTemplate訪問數據庫

ger sele 應該 創建 測試環境 oid reg tis eat 本文介紹在Spring Boot基礎下配置數據源和通過JdbcTemplate編寫數據訪問的示例。 數據源配置 在我們訪問數據庫的時候，需要先配置一個數據源，下面分別介紹一下幾種不同的數據庫配置方式。