現在，如果您有興趣創建一個以Aspectj的@Aspect和@Before批注的形式使用面向方面編程（AOP）的Spring MVC Webapp來審核用戶對屏幕的訪問，那么這是您想要閱讀的博客。

正如我在上一個博客中所說的那樣，審核用戶對屏幕的訪問是面向方面編程（AOP）很好解決的少數幾個交叉問題之一。 就我的演示代碼而言，其想法是，您將注釋添加到適當的控制器，并且每次用戶訪問頁面時，都會記錄該訪問。 使用此技術，您可以構建最流行的屏幕的圖片，從而構建應用程序中最流行的功能塊。 知道了這些細節之后，就可以更輕松地決定將開發目標放在何處，因為開發幾乎沒有人使用過的那些應用程序塊是沒有用的。

對于演示代碼，我創建了一個簡單的Spring MVC應用程序，該應用程序具有兩個屏幕：主頁和幫助頁面。 在此之上，我創建了一個簡單的批注： @Audit ，用于將控制器標記為需要審計的控制器（并非所有控制器都需要，尤其是如果您選擇審計功能點而不是單個屏幕時），并且告訴建議對象的屏幕ID。 我已經在下面的代碼片段中演示了這一點：

@Audit("Home") @RequestMapping(value = "/", method = RequestMethod.GET) public String home(Locale locale, Model model) {

在停留在AspectJ方面之前，首先要做的是使用為工作設計的Spring模板創建標準的Spring MVC Web應用程序：

下一步要做的就是對POM文件進行一堆更改，如我之前的博客中所述 。 這些并不是一切必不可少的，它們對于一切正常工作都是必不可少的。 但是，請確保您添加了aspectJwearver依賴項并刪除了AspectJ插件定義。

該應用程序具有兩個控制器和兩個簡單??的JSP。 第一個控制器是從Spring MVC應用程序中獲取的HomeController ，第二個控制器是旨在在應用程序的任何頁面上顯示幫助的HelpController 。 我在下面包括了HelpController的showHelp(…)方法，但這只是為了完整性。 在這種情況下，只要有幾個要審核的控制器實際上沒有關系。

@Controller() public class HelpController { @Audit("Help")? // User has visited the help page @RequestMapping(value = "/help", method = RequestMethod.GET) public String showHelp(@RequestParam int pageId, Model model) { String help = getHelpPage(pageId); model.addAttribute("helpText", help); return "help"; }

從上面的代碼中，您可以看到我的兩個RequestMapping方法都使用@Audit注釋進行了注釋，因此下一步是其定義：

@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Audit { String value(); }

此代碼的關鍵是保留策略和目標。 保留策略必須設置為RetentionPolicy.RUNTIME ，這意味著編譯器不會丟棄注釋，并確保在運行時將注釋保存在JVM中。 @Target定義可以在何處應用注釋。 在這種情況下，我只希望將其應用于方法，因此目標是ElementType.METHOD 。 注釋必須包含一個值，在這種情況下，該值用于保存用戶當前正在訪問的屏幕的名稱。

下一個關鍵抽象是AuditAdvice類，如下所示：

@Aspect public class AuditAdvice { @Autowired private AuditService auditService; /** * Advice for auditing a user's visit to a page. The rule is that the Before annotation * applies to any method in any class in the com.captaindebug.audit.controller package * where the class name ends in 'Controller' and the method is annotated by @Audit. * * @param auditAnnotation *??????????? Audit annotation holds the name of the screen we're auditing. */ @Before("execution(public String com.captaindebug.audit.controller.*Controller.*(..)) && @annotation(auditAnnotation) ") public void myBeforeLogger(Audit auditAnnotation) { auditService.audit(auditAnnotation.value()); } }

這有兩個AspectJ注釋： @Aspect和@Before 。 @Aspect批注將AuditAdvice類標記為一個方面 ，而@Before批注意味著在定義與作為@Before批注的參數的表達式匹配的任何方法之前，將調用auditScreen(…)方法。

這種表達是很酷的想法。 我已經在Spring應用程序中使用AspectJ的@AfterThrowing建議中的博客中介紹了execution表達式的構造； 但是，總而言之，我將對所有具有公共可見性，返回String且位于com.captaindebug.audit.controller程序包中并且將單詞Controller包含@Before方法都應用@Before注釋方法。班級名稱。 換句話說，我很難將此執行表達式應用于除我的應用程序的控制器以外的任何對象，并且這些控制器必須由@Audit注釋進行注釋，如@annotation(auditAnnotation)表達式和auditScreen(…)方法的Audit auditAnnotation參數。 這意味著我不能無意中將@Audit注釋應用于除控制器之外的任何東西

AuditAdvice類將實際審核的職責委托給AuditService 。 這是一項虛擬服務，因此與其執行諸如將審核事件存儲在數據庫中之類的有用操作，不如將其簡單地添加到日志文件中。

@Service public class AuditService { private static Logger logger = LoggerFactory.getLogger(AuditService.class); /** * Audit this screen against the current user name * * It's more useful to put this info into a database so that that you can count visits to * pages and figure out how often they're used. That way, you can focus your design on the * popular parts of your application. The logger is just for demo purposes. */ public void audit(String screenName) { String userName = getCurrentUser(); logger.info("Audit: {} - {}", userName, screenName); } /** * Get the current logged on user name by whatever mechanism available */ private String getCurrentUser() { return "Fred"; } }

因此，這就是本文所涵蓋的代碼，現在剩下要做的就是整理Spring配置文件，在這里沒有太多要做。 首先，與任何AOP應用程序一樣，您需要添加以下AOP啟用行：

<aop:aspectj-autoproxy/>

…連同其架構詳細信息：

xmlns:aop="http://www.springframework.org/schema/aop" xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd"

其次，您需要通過更新context:components-scan元素將建議類告知Spring上下文：

<context:component-scan base-package="com.captaindebug.audit"><context:include-filter type="aspectj"expression="com.captaindebug.audit.aspectj.AuditAdvice" /></context:component-scan>

您還可以選擇從架構位置URI的末尾刪除版本號。 例如：

http://www.springframework.org/schema/context/spring-context.3.0.xsd

變成：

http://www.springframework.org/schema/context/spring-context.xsd

這樣做的原因是，由于沒有任何版本號的架構URI似乎指向該架構的最新版本，因此它在將來的某個時刻簡化了Spring版本的升級。

為了完整起見，我的配置文件如下所示：

<?xml version="1.0" encoding="UTF-8"?> <beans:beans xmlns="http://www.springframework.org/schema/mvc"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:beans="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:aop="http://www.springframework.org/schema/aop"xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsdhttp://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop.xsd"><!-- DispatcherServlet Context: defines this servlet's request-processing infrastructure --><!-- Enables the Spring MVC @Controller programming model --><annotation-driven /><!-- Handles HTTP GET requests for /resources/** by efficiently serving up static resources in the ${webappRoot}/resources directory --><resources mapping="/resources/**" location="/resources/" /><!-- Resolves views selected for rendering by @Controllers to .jsp resources in the /WEB-INF/views directory --><beans:beanclass="org.springframework.web.servlet.view.InternalResourceViewResolver"><beans:property name="prefix" value="/WEB-INF/views/" /><beans:property name="suffix" value=".jsp" /></beans:bean><aop:aspectj-autoproxy/><context:component-scan base-package="com.captaindebug.audit"><context:include-filter type="aspectj"expression="com.captaindebug.audit.aspectj.AuditAdvice" /></context:component-scan></beans:beans>

最后，當您運行該應用程序時，將記錄用戶對主頁的訪問。 當用戶單擊幫助鏈接時，也會記錄對幫助頁面的訪問。 日志文件中的輸出如下所示：

INFO : com.captaindebug.audit.service.AuditService - Audit: Fred - Home INFO : com.captaindebug.audit.controller.HomeController - Welcome home! the client locale is en_US INFO : com.captaindebug.audit.service.AuditService - Audit: Fred - Help

有關此代碼和下一個博客的代碼，請訪問github： https ： //github.com/roghughe/captaindebug/tree/master/audit-aspectj

參考： 使用AspectJ審計Spring MVC Webapp。 Captain Debug的Blog博客中的JCG合作伙伴 Roger Hughes的第2部分 。

翻譯自: https://www.javacodegeeks.com/2013/07/auditing-a-spring-mvc-webapp-with-aspectj-part-2.html

總結

以上是生活随笔為你收集整理的使用AspectJ审计Spring MVC Webapp。 第2部分的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。