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

前言

   面向切面编程(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>

三、测试事务配置

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

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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,039评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,223评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,916评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,009评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,030评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,011评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,934评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,754评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,202评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,433评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,590评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,321评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,917评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,568评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,738评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,583评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,482评论 2 352

推荐阅读更多精彩内容