SSM系列+源码注释（四）使用注解配置切面

2019-03-04 本文已影响1人程序员七平

前言

面向切面编程（aspect-oriented programming，AOP），前面的文章里面描述AOP主要的作用是：日志记录，性能统计，安全控制，事务处理，异常处理，权限登录等等。本文中，我们使用切面来配置日志记录，其他的使用方式基本和这个一样。

源码下载

该项目持续更新中，会在代码以及该文档里面详细注释和介绍。项目托管在码云开源平台上，持续更新项目源码链接：
https://gitee.com/nelucifer/ssm-note，点击克隆/下载获取该项目。

本文内容

一、注解

注解(Annotation)：一个注解就是一个类，@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式： public @interface 注解名 {定义体，定义体中的方法名称就是注解参数名称}
注解参数的可支持数据类型：
1. 所有基本数据类型（int、float、boolean、byte、double、char、long、short）；
2. String 类型；
3. Class 类型；
4. enum 枚举类型；
5. Annotation类型；
6. 以上所有类型的数组

二、面向切面编程

面向切面编程（AOP）：利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。可以参考本文内容：Spring系列学习之IoC与AOP；切面就是为了实现各个业务模块通用功能的复用，比如业务操作（Service）中我们需要记录日志，就使用切面来织入各业务模块。5种通知类型：前置通知、后置通知、环绕通知、返回通知、异常通知。

Spring 提供

配置注解驱动的切面

一、添加依赖

pom.xml

    <spring.version>4.2.5.RELEASE</spring.version>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aop</artifactId>
        <version>${spring.version}</version>
        <type>jar</type>
        <scope>compile</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-aspects</artifactId>
        <version>${spring.version}</version>
        <type>jar</type>
        <scope>compile</scope>
    </dependency>

二、配置注解类

这个类是为了打印日志的时候声明该方法作用，也就是方法的注释。

Log.java


package com.weyoung.annotation;

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    String value() default "";
}

该注解的使用方式，如下：

// 方法名
@Log("登录")
@RequestMapping(value = "/login", method = RequestMethod.POST)
public String systemLogin(HttpServletRequest request, HttpServletResponse response) throws Exception {
    String viewName = "/welcome";
    return viewName;
}

三、配置切面

LogAspect.java代码如下：


package com.weyoung.aspect;
//import ...; 导入包

/**
 * @Author Mr.wang
 * @Description // 配置业务处理-系统日志切面
 * @Date 2019/3/3 2:19
 * @Param
 * @return
 **/
@Aspect
@Component
public class LogAspect {

    @Autowired
    LoggerService loggerService;

    /**
     * @Author Mr.wang
     * @Description // 异常日志打印到日志文件中
     **/
    private static final Logger logger = LogManager.getLogger(LogAspect.class);

    /**
     * @Author Mr.wang
     * @Description // Controller层切点
     **/
    @Pointcut("@annotation(com.weyoung.annotation.Log)")
    public void logPointCut() {
    }

    /**
     * @Author Mr.wang
     * @Description // 环绕通知
     **/
    @Around("logPointCut()")
    public Object aroundMethod(ProceedingJoinPoint joinPoint) throws Throwable {
        logger.info("进入切点...");
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        // 获取注解上的描述
        Log log = method.getAnnotation(Log.class);
        String description = "";
        if (log != null) {
            description = log.value();
        }
        // 类名
        String className = joinPoint.getTarget().getClass().getName();
        // 方法名
        String methodName = signature.getName();
        // 方法参数
        Object[] args = joinPoint.getArgs();
        // 进入方法
        logger.info("进入方法...");
        Object returnValue = joinPoint.proceed(args);
        stopWatch.stop();
        logger.info("执行之后...");
        stopWatch.getTotalTimeMillis()
        // 方法执行之后
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        if (attributes != null) {
            HttpServletRequest request = attributes.getRequest();
        }
        return returnValue;
    }
}

四、Spring装配该日志切面

spring-mvc.xml

    <!-- 启动AOP AspectJ注解自动代理 -->
    <aop:aspectj-autoproxy />
    <bean class="com.weyoung.aspect.LogAspect" />

注意： 在spring-mvc中添加如上配置即可，不需要再添加其他扫描。配置的日志执行后如下：

使用AOP方式配置事务

使用xml方式管理AOP事务；

一、添加依赖

pom.xml

    <spring.version>4.2.5.RELEASE</spring.version>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-tx</artifactId>
        <version>${spring.version}</version>
        <type>jar</type>
        <scope>compile</scope>
    </dependency>

二、配置AOP事务

spring-config.xml

<!-- 事务管理 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="MySQLDataSource"/>
    </bean>

    <!-- 配置事务通知属性 -->
    <tx:advice id="txAdvice" transaction-manager="transactionManager">
        <!-- 定义事务传播属性，添加事务的方法名，因此service命名时需要遵循该原则 -->
        <tx:attributes>
            <tx:method name="insert*" propagation="REQUIRED"/>
            <tx:method name="update*" propagation="REQUIRED"/>
            <tx:method name="edit*" propagation="REQUIRED"/>
            <tx:method name="save*" propagation="REQUIRED"/>
            <tx:method name="add*" propagation="REQUIRED"/>
            <tx:method name="new*" propagation="REQUIRED"/>
            <tx:method name="set*" propagation="REQUIRED"/>
            <tx:method name="remove*" propagation="REQUIRED"/>
            <tx:method name="delete*" propagation="REQUIRED"/>
            <tx:method name="change*" propagation="REQUIRED"/>
            <tx:method name="get*" propagation="REQUIRED" read-only="true"/>
            <tx:method name="find*" propagation="REQUIRED" read-only="true"/>
            <tx:method name="load*" propagation="REQUIRED" read-only="true"/>
            <tx:method name="*" propagation="REQUIRED" read-only="true"/>
        </tx:attributes>
    </tx:advice>

    <!-- 配置事务切面 -->
    <aop:config>
        <aop:pointcut id="serviceOperation" expression="execution(* com.weyoung.service.*.*Impl.*(..))"/>
        <aop:advisor advice-ref="txAdvice" pointcut-ref="serviceOperation"/>
    </aop:config>

三、测试事务配置

代码添加保存方法，确保该保存方法能够正常保存。
添加两条参数，确保一条可以成功一条不能成功，在一个符合事务配置格式的service方法中调用该方法；
查询数据库：无数据插入，后台报错；
添加两条参数，确保一条可以成功一条不能成功，注释掉事务配置切面，再调用方法进行测试；
查询数据库：有一条数据插入，后台报错；
结论：事务配置成功，可正常回滚。

service中方法示例代码如下，具体内容可在文首查看源码或留言讨论：

    public void saveTest() {
        Map<String, Object> map1 = new HashMap<>();
        map1.put("userId", "007");
        map1.put("petname", "genius");
        map1.put("name", "weyoung");
        map1.put("sex", "man");
        map1.put("birth", "2019-03-03");
        map1.put("icon", "icon");
        map1.put("phone", "phone");
        map1.put("email", "ne_lucifer@163.com");
        map1.put("address", "");
        map1.put("level", 0);
        map1.put("signature", "signature");
        map1.put("brief", "brief");
        loginDao.saveUserInfo(map1);
        Map<String, Object> map = new HashMap<>();
        map.put("userId", "001");
        map.put("petname", "weyoug");
        map.put("name", "lixia");
        map.put("sex", "man");
        map.put("birth", "2019-03-03");
        map.put("icon", "icon");
        map.put("phone", "phone");
        map.put("email", "ne_lucifer@163.com");
        map.put("address", "");
        map.put("level", 0);
        map.put("signature", "signature");
        map.put("brief", "brief");
        loginDao.saveUserInfo(map);
    }

日志切面和事务切面配置成功!

欢迎扫描下方二维码，关注weyoung公众号，一起交流学习~~

更多联系方式

平台	链接
预览项目：	https://nelucifer.gitee.io/
个人微信公众号：	weyoung
segmentfault:	https://segmentfault.com/u/nelucifer
CSDN:	https://me.csdn.net/wlx001
简书：	https://www.jianshu.com/u/99211cc23788
掘金：	https://juejin.im/user/59b08c575188250f4850e80e

SSM系列+源码注释（四）使用注解配置切面

前言

相关文章

源码下载

本文内容

一、注解

二、面向切面编程

配置注解驱动的切面

一、添加依赖

二、配置注解类

三、配置切面

四、Spring装配该日志切面

使用AOP方式配置事务

一、添加依赖

二、配置AOP事务

三、测试事务配置

分享

猜你喜欢

热点阅读