AOP+自定義註解+策略模式 記錄操做日誌，避免過多的if else

時間  2019-11-21
標籤 aop 自定義 註解 策略 模式 記錄 日誌 避免 過多 简体版
原文   原文鏈接

演示案例代碼java

首先看下業務需求： git

image.png
如圖所示，就是將用戶的操做行爲記錄到日誌表中,並且有些內容是動態的，如圖是六種操做，可是後期確定是要增長的，也就是說就這六種須要記錄到日誌表中，日誌表所對應的對象是 AnalysisMessage,標題，內存，接收時間，對應對象中字段名爲 title, content, create_time；看到需求的第一眼就想到AOP來實現；可是隻是使用AOP的會寫一些if else,後期若是要增長一些是否是要增長if else,後期維護起來是至關麻煩，我就想到了使用策略模式；

這裏有個前提就是必須這些操做是成功以後才能夠入庫，因此我選擇了使用@Around，在切入點先後切入內容;由於這樣能夠在調用接口結束以後拿到接口返回的參數，從而判斷接口是否調用成功；下面就用代碼來實現一下github

首先我會將這個操做以key value 的形式存放到json文件中，以url 爲key,操做title爲value; 在項目的resources目錄下有個test.json文件，內容以下：spring

{
  "/user/addUser": "帳號添加",
  "/user/isLock": "帳號禁用",
  "/user/delUser": "帳號刪除"
}
複製代碼

這裏只列舉三種操做，之因此存放到json文件中，目的是想讓本案例更簡化，不想涉及到數據庫，因此這個演示案例只放到了json文件中；在生成環境中是配置在數據庫中的； 在項目啓動的時候將json文件中的內容以key value 的形式加載到map中； 代碼實現以下：數據庫

@Component
@Slf4j
public class MessageInitHandler implements CommandLineRunner {

    /** * 文件名 */
    private static String fileName = "test.json";

    /** * 初始化 Map */
    private Map<String, String> initMap = Maps.newHashMap();

    @Override
    public void run(String... args) throws Exception {

        JSONObject jsonObject = loadingJSONFile();
        log.info("json Data are as follows:{}", jsonObject);
       //使用Gson將json轉成map
        Gson gson = new Gson();
        initMap = gson.fromJson(jsonObject.toJSONString(), Map.class);
       //將initMap賦值給MapCacheUtils.mapCaheInit
        MapCacheUtils.mapCaheInit = initMap;
    }

    private JSONObject loadingJSONFile() {

        log.info("開始加載resources/test.json");

        Enumeration<URL> resources;
        JSONObject jsonObject = new JSONObject();
        try {
            resources = getClassLoader().getResources(fileName);
        } catch (IOException e) {
            log.warn("getJsonResource fail {}", fileName, e);
            return jsonObject;
        }
        while (resources.hasMoreElements()) {
            URL url = resources.nextElement();
            try {
                String json = Resources.toString(url, Charsets.UTF_8);
                jsonObject.putAll(JSON.parseObject(json)); // 有多個的時候，後面的覆蓋前面的
            } catch (IOException e) {
                log.warn("addJsonFile fail url:{}", url, e);
            }
        }
        return jsonObject;
    }

    private static ClassLoader getClassLoader() {
        ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
        if (classLoader != null) {
            return classLoader;
        }
        return MessageInitHandler.class.getClassLoader();
    }
}
複製代碼

MessageIntiHandler實現CommandLineRuner,並實現run方法； 這樣MapCacheUtils.mapCaheInit中就有三條數據；初始化工做完成；json

而後自定義一個註解@MessageLog,標註在須要aop攔截的接口上；也就是上圖中須要存庫的操做接口上；例如 帳號添加，帳號刪除...等springboot

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MessageLog {
}
複製代碼

而後編寫接口：包括帳號添加，帳號刪除，等。。接口，並標識MessageLog註解，app

@RestController
@RequestMapping("user")
public class UserController {

    @Autowired
    private AnalysisUserService analysisUserService;

    /** * 添加用戶 */
    @RequestMapping("addUser")
    @MessageLog
    public String addUser(@RequestParam("roleId") Long roleId, AnalysisUser user){
        return analysisUserService.addUser(roleId,user);
    }

    /** * 刪除用戶 * 須要參數：userid username realname * 由於這裏把用戶刪除以後在策略類中就查詢不到該用戶的信息 */
    @RequestMapping("delUser")
    @MessageLog
    public String delUser(@RequestBody AnalysisUser analysisUser){
        return analysisUserService.delUser(analysisUser.getId());
    }

    /** * 鎖定用戶這裏就不模擬了。。。 */
}
複製代碼

而後編寫策略類 首先 定義個StrategyBase接口ide

//策略父類
public interface StrategyBase {
    
    String run(Object[] args);

}
複製代碼

接下來就是StrategyBase的子類：函數

帳號添加策略

@Component(value="/user/addUser")
public class MessageAddUserStrategy implements StrategyBase {

    @Autowired
    private AnalysisRoleService analysisRoleService;
    @Override
    public String run(Object[] args) {
        Long roleId = null;
        AnalysisUser analysisUser = null;
        for (Object arg : args) {
            if (arg instanceof Long) {
                roleId = (Long) arg;
            } else if (arg instanceof AnalysisUser) {
                analysisUser = (AnalysisUser) arg;
            } else {
                return null;
            }
        }
        String username = analysisUser.getUsername();
        AnalysisRole role = analysisRoleService.findByRoleId(roleId);
       return "添加了帳號" + username + "(" + role.getName() + ")";
    }
}
複製代碼

帳號刪除策略

@Component("/user/delUser")
public class MessageDelUserStrategy implements StrategyBase {

    @Override
    public String run(Object[] args) {

        for (Object arg : args) {
            if (arg instanceof AnalysisUser) {
                AnalysisUser analysisUser = (AnalysisUser) arg;
              return "刪除了帳號" + analysisUser.getUsername() + "(" + analysisUser.getRealname() + ")";
            }
        }
        return null;
    }
}
複製代碼

禁用帳號策略

@Component("/user/isLock")
public class MessageIsLockStrategy implements StrategyBase {

    @Autowired
    private AnalysisUserService analysisUserService;

    @Override
    public String run(Object[] args) {
        AnalysisUser analysisUser = null;
        for (Object arg : args) {
            if (arg instanceof AnalysisUser) {
                analysisUser = (AnalysisUser) arg;
                if (analysisUser.getStatus().equals((byte) 1)) {
                    analysisUser = analysisUserService.selectById(analysisUser.getId());
                    return "啓用了帳號" + analysisUser.getUsername() + " (" + analysisUser.getRealname() + ")";
                } else if (analysisUser.getStatus().equals((byte) 2)) {
                    analysisUser = analysisUserService.selectById(analysisUser.getId());
                    return "禁用了帳號" + analysisUser.getUsername() + " (" + analysisUser.getRealname() + ")";
                }
            }
        }
        return null;
    }
}
複製代碼

這裏稍微的注意一下@Component註解中的value值，

策略控制器

@Component
public class DataSourceContextAware {

    @Autowired
    private final Map<String, StrategyBase> strategyMap = new ConcurrentHashMap<>(3);

    public StrategyBase getStrategyInstance(String dsType) {
        StrategyBase strategyBase = strategyMap.get(dsType);
        return strategyBase;
    }
}
複製代碼

這裏定義一個ConcurrentHashMap,這個類的做用就是將策略名(@Component註解中的value值),和實現StrategyBase的類，以key,value的形式保存到了ConcurrentHashMap中；

到了這裏@MessageLog註解只是定義出來了，尚未正式的用上，下面該輪到@MessageLog和aop上場了。

定義切面

  • 使用@Aspect註解將一個java類定義爲切面類
  • 使用@Pointcut定義一個切入點，能夠是一個規則表達式，好比某個package下的全部函數，也能夠是一個註解等。
  • 根據須要在切入點不一樣位置的切入內容
    • 使用@Before在切入點開始處切入內容
    • 使用@After在切入點結尾處切入內容
    • 使用@AfterReturning在切入點return內容以後切入內容（能夠用來對處理返回值作一些加工處理）
    • 使用@Around在切入點先後切入內容，並本身控制什麼時候執行切入點自身的內容
    • 使用@AfterThrowing用來處理當切入內容部分拋出異常以後的處理邏輯

上面也說到了，就是必須這些操做是成功以後才能夠入庫，因此我選擇了使用@Around，在切入點先後切入內容;由於這樣能夠在調用接口結束以後拿到接口返回的參數，從而判斷接口是否調用成功；

@Aspect
@Component
public class MessageMonitorHandler {

    private Logger logger = LoggerFactory.getLogger(MessageMonitorHandler.class);

    @Autowired
    private AnalysisMessageService messageService;

    @Autowired
    private MessageStrategyService messageStrategyService;
    
    @Autowired
    private StringHttpMessageConverter converter;

    //@MessageLog
    @Pointcut("@annotation(cn.haoxy.strategy.aop.annotation.MessageLog)")
    public void checkMessageHandler() {

    }

    @Around("checkMessageHandler()")
    public void doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {

        logger.info("start run doAround.....");
        Object obj = proceedingJoinPoint.proceed();//調用執行目標方法
        //返回客戶端結果
        HttpServletResponse response = getHttpServletResponse();
        HttpOutputMessage outputMessage = new ServletServerHttpResponse(response);
        //converter.write(obj, MediaType.APPLICATION_JSON, outputMessage);
        converter.write(obj.toString(),null, outputMessage);
        shutdownResponse(response);
        //判斷調用是否成功
        //省略判斷 ......
        //若是調用成功
        processOutPutObj(proceedingJoinPoint);
    }

    private void processOutPutObj(ProceedingJoinPoint proceedingJoinPoint) {

       Object[] args = proceedingJoinPoint.getArgs();
        //獲得HttpServletRequest
        HttpServletRequest request = getHttpServletRequest();
        //獲得請求url
        String url = request.getServletPath();
        //根據url從MapCacheUtils.mapCaheInit中取出操做title,
        // 這裏是從test.json文件中讀取的，固然也能夠配置在數據庫中
        String operatorLog = MapCacheUtils.mapCaheInit.get(url);
        //根據url取出對應的策略類,這裏的url也就是和策略類上@Component註解的value值
        StrategyBase messageChild = messageStrategyService.run(url);
        //拿到策略類執行相應的策略方法
        String content = messageChild.run(args);
        AnalysisMessage analysisMessage = new AnalysisMessage();
        analysisMessage.setId(1L);
        analysisMessage.setTitle(operatorLog);
        analysisMessage.setContent(content);
        //在這裏模擬存庫
        messageService.insert(analysisMessage);

       logger.info(" end run doAround....." + content);
    }


    /** * 獲取 HttpServletRequest */
    private HttpServletRequest getHttpServletRequest() {
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        return servletRequestAttributes.getRequest();
    }
    /** * 獲取 HttpServletResponse */
    private HttpServletResponse getHttpServletResponse() {
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        return servletRequestAttributes.getResponse();
    }
    /** * 關流 * @param response * @throws IOException */
    private void shutdownResponse(HttpServletResponse response) throws IOException {
        response.getOutputStream().close();
    }
}

複製代碼

這裏@Pointcut是使用註解的方式；在檢測接口上含有@MessageLog註解時就會被AOP攔截；

這裏貼一下MessageStrategyService類：

@Component
public class MessageStrategyService {

    @Autowired
    private DataSourceContextAware dataSourceContextAware;

    public StrategyBase run(String dsType) {
         //這裏調用策略控制器中的getStrategyInstance方法，來獲取對應的策略類
        StrategyBase strategyInstance = dataSourceContextAware.getStrategyInstance(dsType);
        return strategyInstance;
    }
}
複製代碼

下面進行測試

使用postman 測試帳號添加：

image.png

帳號添加測試結果打印：

image.png

帳號刪除測試結果打印：

image.png

打印content結果缺乏主語（當前登錄的用戶），需求是：xxx添加了帳號xxx(角色名)；這裏有不少種方式能夠拿到當前用戶，若是使用token的話，能夠從token中解析出當前用戶的id,我這裏使用的是shrio,從而也很方便的拿到當前用戶，爲了減小本演示案例的複雜度就沒去引入，這裏只突出主要部分；

到這裏就結束了，是否是避免不少的 if else，若是有更好的方式歡迎探討。

演示案例代碼

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程