Spring AOP中級——應用場景

　　在《Spring AOP初級——入門及簡單應用》中對AOP作了簡要的介紹，以及一些專業術語的解釋，同時寫了一個簡單的Spring AOPdemo。本文將繼續探討Spring AOP在實際場景中的應用。

　　對用戶操作日志的記錄是很常見的一個應用場景，本文選取“用戶管理”作為本文Spring AOP的示例。當然，該示例只是對真實場景的模擬，實際的環境一定比該示例更復雜。

　　該示例的完整代碼路徑在https://github.com/yu-linfeng/BlogRepositories/tree/master/repositories/Spring%20AOP%E4%B8%AD%E7%BA%A7%E2%80%94%E2%80%94%E5%BA%94%E7%94%A8%E5%9C%BA%E6%99%AF。本文僅對Spring AOP相關的代碼進行講解。

　　在這個示例中首次采用RESTful架構風格，對於以下RESTful API的設計可能並不完美，如果有熟悉、精通RESTful架構風格的朋友希望能夠指出我的錯誤。

　　

　　使用RESTful的前后端分離架構風格后，我感受到了前所未有的暢快，所以此次示例並沒有前端頁面的展示，完全使用JUnit進行單元測試包括對HTTP請求的Mock模擬，這部分代碼不會進行詳細講解，之后會繼續深入JUnit單元測試的一些學習研究。

　　數據庫只有一張表：

　　回到正題，我們回顧下切面由哪兩個部分組成： 通知 切點 首先明確我們需要在何時記錄日志：

　　通知

　　切點

　　首先明確我們需要在何時記錄日志：

　　1. 查詢所有用戶時，並沒有參數（此示例沒有作分頁），只有在返回時才會有數據的返回，所以對查詢所有用戶的方法采用返回通知（AfterReturning）。

　　2. 新增用戶時，會帶有新增的參數，此時可采用前置通知（Before）。

　　3. 修改用戶時，也會帶有新增的參數，此時同樣采用前置通知（Before）。

　　4. 刪除用戶時，通常會帶有唯一標識符ID，此時采用前置通知（Before）記錄待刪除的用戶ID。

　　在明確了通知類型后，此時我們需要明確切點，也就是在哪個地方記錄日志。當然上面實際已經明確了日志記錄的位置，但主要是切面表達式的書寫。 在有了《Spring AOP初級——入門及簡單應用》的基礎，相信對日志切面類已經比較熟悉了：

package com.manager.aspect;

import org.apache.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;

import java.util.Arrays;

/**
 * 日志切面
 * Created by Kevin on 2017/10/29.
 */
@Aspect
@Component
public class LogAspect {
    /**
     * 操作日志文件名
     */
    private static final String OPERATION_LOG_NAME = "operationLog";
    private static final String LOG_FORMATTER = "%s.%s - %s";
    Logger log = Logger.getLogger(OPERATION_LOG_NAME);
    /**
     * 對查詢方法記錄日志的切點
     */
    @Pointcut("execution(* com.manager..*.*Controller.query*(..))")
    public void query(){}

    /**
     * 對新增方法記錄日志的切點
     */
    @Pointcut("execution(* com.manager..*.*Controller.add*(..))")
    public void add(){}

    /**
     * 對修改方法記錄日志的切點
     */
    @Pointcut("execution(* com.manager..*.*Controller.update*(..))")
    public void update(){}

    /**
     * 對刪除方法記錄日志的切點
     */
    @Pointcut("execution(* com.manager..*.*Controller.delete*(..))")
    public void delete(){}

    @AfterReturning(value = "query()", returning = "rvt")
    public void queryLog(JoinPoint joinPoint, Object rvt) {
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        String returnResult = rvt.toString();
        log.info(String.format(LOG_FORMATTER, className, methodName, returnResult));
    }

    @Before("add()")
    public void addLog(JoinPoint joinPoint) {
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] params = joinPoint.getArgs();
        log.info(String.format(LOG_FORMATTER, className, methodName, Arrays.toString(params)));
    }

    @Before("update()")
    public void updateLog(JoinPoint joinPoint) {
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] params = joinPoint.getArgs();
        log.info(String.format(LOG_FORMATTER, className, methodName, Arrays.toString(params)));
    }

    @Before("delete()")
    public void deleteLog(JoinPoint joinPoint) {
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] params = joinPoint.getArgs();
        log.info(String.format(LOG_FORMATTER, className, methodName, Arrays.toString(params)));
    }
}

　　上面的日志切面類中出現了JointPoint類作為參數的情況，這個參數能夠傳遞被通知方法的相信，例如被通知方法所處的類以及方法名等。在第47行中的Object rvt參數就是獲取被通知方法的返回值。 上面的切面並沒有關注被通知方法的參數，如果要使得切面和被通知方法參數參數關聯可以使用以下的方式：

@Pointcut("execution(* com.xxx.demo.Demo.method(int)) && args(arg)")
public void aspectMethod(int arg){}

@Before(“aspectMedhot(arg)”)
    public void method(int arg) {
    //此時arg參數就是被通知方法的參數
}

　　本例中最主要的切面部分就完成了。注意在結合Spring時需要在applicationContext.xml中加入以下語句：

<!--啟用AspectJ自動代理，其中proxy-target-class為true表示使用CGLib的代理方式，false表示JDK的代理方式，默認false-->
<aop:aspectj-autoproxy />

　　示例中關於log4j、pom.xml依賴、JUnit如何結合Spring進行單元測試等等均可可以參考完整代碼。特別是JUnit是很值得學習研究的一部分，這部分在將來慢慢我也會不斷學習推出新的博客，在這里就只貼出JUnit的代碼，感興趣的可以瀏覽一下：

package com.manager.user.controller;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.manager.user.pojo.User;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;

import static org.junit.Assert.assertNotNull;

/**
 * UserController單元測試
 * Created by Kevin on 2017/10/26.
 */
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath*:applicationContext.xml", "classpath*:spring-servlet.xml"})
@WebAppConfiguration
public class UserControllerTest {
    @Autowired
    private WebApplicationContext wac;
    private MockMvc mvc;

    @Before
    public void initMockHttp() {
        this.mvc = MockMvcBuilders.webAppContextSetup(wac).build();
    }

    @Test
    public void testQueryUsers() throws Exception {
        mvc.perform(MockMvcRequestBuilders.get("/users"))
                .andExpect(MockMvcResultMatchers.status().isOk());
    }

    @Test
    public void testAddUser() throws Exception {
        User user = new User();
        user.setName("kevin");
        user.setAge(23);
        mvc.perform(MockMvcRequestBuilders.post("/users")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(new ObjectMapper().writeValueAsString(user)))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("kevin"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.age").value(23));
    }

    @Test
    public void testQueryUserById() throws Exception {
        User user = new User();
        user.setId(8);
        mvc.perform(MockMvcRequestBuilders.get("/users/" + user.getId()))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("kevin"))
                .andExpect(MockMvcResultMatchers.jsonPath("$.age").value(23));

    }

    @Test
    public void testUpdateUserById() throws Exception {
        User user = new User();
        user.setId(9);
        user.setName("tony");
        user.setAge(99);
        mvc.perform(MockMvcRequestBuilders.put("/users/" + user.getId())
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(new ObjectMapper().writeValueAsString(user)))
                .andExpect(MockMvcResultMatchers.status().isOk());
    }

    @Test
    public void testDeleteUserById() throws Exception {
        long id = 10;
        mvc.perform(MockMvcRequestBuilders.delete("/users/" + id))
                .andExpect(MockMvcResultMatchers.status().isOk());
    }
}

　　有了初級和中級，接下來必然就是Spring AOP高級——源碼實現。

 

 

這是一個能給程序員加buff的公眾號