Spring进阶之代理与AOP编程

作者: Acamy丶 | 来源:发表于2017-06-17 18:10 被阅读42次

本文先介绍了代理中的静态代理，动态代理和Cglib代理，然后通过示例分别展示了如何通过注解和XML方式实现AOP编程，并且列举了切入点表达式的常用形式。

1. 代理

代理（Proxy）是一种设计模式，为需要访问的对象提供了一个替身或者点位符以控制对这个对象的访问。使得可以在目标对象实现的基础上，增强额外的功能操作。

代理模式

1.1 静态代理

代理对象与真实对象实现相同的接口，实现访问控制。

举例：

静态代理

public class App {
    public static void main(String[] args) {
        // 目标对象
        IUserDao target = new UserDao();
        
        // 代理
        IUserDao proxy = new UserDaoProxy(target);
        proxy.save();  // 执行的是，代理的方法
    }
}

interface IUserDao {
    void save();
}

class UserDao implements IUserDao{
    @Override
    public void save() {
        System.out.println("-----已经保存数据！！！------");
    }
}

class UserDaoProxy implements IUserDao{
    // 接收保存目标对象
    private IUserDao target;
    public UserDaoProxy(IUserDao target) {
        this.target = target;
    }
    
    @Override
    public void save() {
        System.out.println("开始事务...");
        
        target.save();          // 执行目标对象的方法
        
        System.out.println("提交事务...");
    }   
}

总结：可以做到在不修改目标对象的功能前提下，对目标对象功能扩展。但因为代理对象，需要与目标对象实现一样的接口。所以会有很多代理类，类太多。而且一旦接口增加方法，目标对象与代理对象都要维护。

1.2 动态代理

代理对象，不需要实现接口，代理对象的生成，是利用JDKAPI，动态的在内存中构建代理对象

动态代理

public class App {
    public static void main(String[] args) {
        // 目标对象
        IUserDao target = new UserDao();
        // 【原始的类型 class cn.itcast.b_dynamic.UserDao】
        System.out.println(target.getClass());
        
        // 给目标对象，创建代理对象
        IUserDao proxy = (IUserDao) new ProxyFactory(target).getProxyInstance();
        // class $Proxy0   内存中动态生成的代理对象
        System.out.println(proxy.getClass());
        
        // 执行方法   【代理对象】
        proxy.save();
    }
}

class ProxyFactory {
    // 维护一个目标对象
    private Object target;
    public ProxyFactory(Object target){
        this.target = target;
    }
    
    // 给目标对象，生成代理对象  
    public Object getProxyInstance() {
        return Proxy.newProxyInstance(
                target.getClass().getClassLoader(), 
                target.getClass().getInterfaces(),
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args)
                            throws Throwable {
                        System.out.println("开启事务");
                        
                        // 执行目标对象方法
                        Object returnValue = method.invoke(target, args);
                        
                        System.out.println("提交事务");
                        return returnValue;
                    }
                });
    }
}

interface IUserDao {
    void save();    
}

class UserDao implements IUserDao{
    @Override
    public void save() {
        System.out.println("-----已经保存数据！！！------");
    }
}

总结:代理对象不需要实现接口，但是目标对象一定要实现接口；否则不能用动态代理！

1.3 Cglib代理

也叫做子类代理。可以代理没有实现接口的类，通过在内存中构建一个子类对象从而实现对目标对象功能的扩展

注意：

需要引入cglib – jar文件，但是spring的核心包中已经包括了cglib功能，所以直接引入spring-core-3.2.5.jar即可。
2）引入功能包后，就可以在内存中动态构建子类
3）代理的类不能为final，否则报错。
4）目标对象的方法如果为final/static, 那么就不会被拦截，即不会执行目标对象额外的业务方法。

cglib代理

public class App {
    public static void main(String[] args) {
        // 目标对象
        UserDao target = new UserDao();
        // class cn.itcast.c_cglib.UserDao
        System.out.println(target.getClass());
        
        // 代理对象
        UserDao proxy = (UserDao) new ProxyFactory(target).getProxyInstance();
        // UserDao子类：class cn.itcast.c_cglib.UserDao$$EnhancerByCGLIB$$25d4aeab
        System.out.println(proxy.getClass());
        
        // 执行代理对象的方法
        proxy.save();
    }
}

class ProxyFactory implements MethodInterceptor{    
    // 维护目标对象
    private Object target;
    public ProxyFactory(Object target){
        this.target = target;
    }
    
    // 给目标对象创建代理对象
    public Object getProxyInstance(){
        //1. 工具类
        Enhancer en = new Enhancer();
        //2. 设置父类
        en.setSuperclass(target.getClass());
        //3. 设置回调函数
        en.setCallback(this);
        //4. 创建子类(代理对象)
        return en.create();
    }   

    @Override
    public Object intercept(Object obj, Method method, Object[] args,
            MethodProxy proxy) throws Throwable {
        
        System.out.println("开始事务.....");
        
        // 执行目标对象的方法
        Object returnValue = method.invoke(target, args);
        
        System.out.println("提交事务.....");
        
        return returnValue;
    }
}

2. AOP编程

Aspect Oriented Programming,即面向切面编程。对很多功能都有的重复的代码抽取，再在运行的时候网业务方法上动态植入“切面类代码”,让关注点(大量重复)代码与业务代码分离！开发者对关注点代码写一次即可,只需要关注核心业务,大大减少了代码的重复量。

关注点：重复代码就叫做关注点；
切面: 关注点形成的类，就叫切面(类)！
切入点: 执行目标对象方法，动态植入切面代码。
可以通过切入点表达式，指定拦截哪些类的哪些方法；给指定的类在运行的时候植入切面类代码。

举例：

// 保存一个用户
public void add(User user) { 
        Session session = null; 
        Transaction trans = null; 
        try { 
            session = HibernateSessionFactoryUtils.getSession();   // 【关注点代码】
            trans = session.beginTransaction();    // 【关注点代码】
             
            session.save(user);     // 核心业务代码
             
            trans.commit();     //…【关注点代码】

        } catch (Exception e) {     
            e.printStackTrace(); 
            if(trans != null){ 
                trans.rollback();   //..【关注点代码】
            } 
        } finally{ 
            HibernateSessionFactoryUtils.closeSession(session);   ////..【关注点代码】
        } 
   }

2.1 注解方式实现AOP编程

步骤：

1）先引入aop相关jar文件（aspectj aop优秀组件）

spring-aop-3.2.5.RELEASE.jar   【spring3.2源码】
aopalliance.jar               【spring2.5源码/lib/aopalliance】
aspectjweaver.jar             【spring2.5源码/lib/aspectj】或【aspectj-1.8.2\lib】
aspectjrt.jar                 【spring2.5源码/lib/aspectj】或【aspectj-1.8.2\lib】

2） bean.xml中引入aop名称空间,并开启aop注解

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">
    
    <!-- 开启注解扫描 -->
    <context:component-scan base-package="cn.itcast.e_aop_anno"></context:component-scan>
    
    <!-- 开启aop注解方式 -->
    <aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>

编写注解类

@Component
@Aspect  // 指定当前类为切面类
public class Aop {
    // 指定切入点表单式： 拦截哪些方法； 即为哪些类生成代理对象
    
    @Pointcut("execution(* cn.itcast.e_aop_anno.*.*(..))")
    public void pointCut_(){
    }
    
    // 前置通知 : 在执行目标方法之前执行
    @Before("pointCut_()")
    public void begin(){
        System.out.println("开始事务/异常...begin()");
    }
    
    // 后置/最终通知：在执行目标方法之后执行  【无论是否出现异常最终都会执行】
    @After("pointCut_()")
    public void after(){
        System.out.println("提交事务/关闭...after()");
    }
    
    // 返回后通知： 在调用目标方法结束后执行 【出现异常不执行】
    @AfterReturning("pointCut_()")
    public void afterReturning() {
        System.out.println("afterReturning()");
    }
    
    // 异常通知： 当目标方法执行异常时候执行此关注点代码
    @AfterThrowing("pointCut_()")
    public void afterThrowing(){
        System.out.println("afterThrowing()");
    }
    
    // 环绕通知：环绕目标方式执行
    @Around("pointCut_()")
    public void around(ProceedingJoinPoint pjp) throws Throwable{
        System.out.println("环绕前....around(ProceedingJoinPoint pjp)");
        pjp.proceed();  // 执行目标方法
        System.out.println("环绕后....around(ProceedingJoinPoint pjp)");
    }   
}

测试

public class App {  
    ApplicationContext ac = 
        new ClassPathXmlApplicationContext("cn/itcast/e_aop_anno/bean.xml");

    // 目标对象有实现接口，spring会自动选择“JDK代理”
    @Test
    public void testApp() {
        IUserDao userDao = (IUserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());//$Proxy001  
        userDao.save();
    }
    
    // 目标对象没有实现接口， spring会用“cglib代理”
    @Test
    public void testCglib() {
        OrderDao orderDao = (OrderDao) ac.getBean("orderDao");
        System.out.println(orderDao.getClass());
        orderDao.save();
    }
    
    @Deprecated
    // 共性问题：如果目标对象有实现接口，在从容器中获取目标对象的时候，只能通过接口接收对象。
    public void testApp2() {
        // 错误代码： 只能用接口接收
        UserDao userDao = (UserDao) ac.getBean("userDao");
        System.out.println(userDao.getClass());//$Proxy001  
        userDao.save();
    }   
    
    @Test
    public void testGetObj() throws Exception {
        OrderDao orderDao1 = (OrderDao) ac.getBean("orderDao");
        OrderDao orderDao2 = (OrderDao) ac.getBean("orderDao");
        
        System.out.println(orderDao1);
        System.out.println(orderDao2);      
    }
}

interface IUserDao {
    void save();
}

//目标对象1,实现了接口
@Component   // 加入容器
class UserDao implements IUserDao{
    @Override
    public void save() {
        System.out.println("-----核心业务：保存！！！------"); 
    }
}

//目标对象1,没有实现接口
@Component   // 加入容器
@Scope("prototype")
class OrderDao{
    public void save() {
        System.out.println("-----核心业务：保存！！！------");
    }
}

效果如下：

2.2 XML方式实现AOP编程

相对于上面的方式，在aop类中不再需要使用注解

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:aop="http://www.springframework.org/schema/aop"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd">
    
    <!-- dao 实例 -->
    <bean id="userDao" class="cn.itcast.f_aop_xml.UserDao"></bean>
    <bean id="orderDao" class="cn.itcast.f_aop_xml.OrderDao"></bean>
    
    <!-- 切面类 -->
    <bean id="aop" class="cn.itcast.f_aop_xml.Aop"></bean>
    
    <!-- Aop配置 -->
    <aop:config>
        <!-- 定义一个切入点表达式： 拦截哪些方法 -->
        <aop:pointcut expression="execution(* cn.itcast.f_aop_xml.*.*(..))" id="pt"/>
        <!-- 切面 -->
        <aop:aspect ref="aop">
            <!-- 环绕通知 -->
            <aop:around method="around" pointcut-ref="pt"/>
            <!-- 前置通知： 在目标方法调用前执行 -->
            <aop:before method="begin" pointcut-ref="pt"/>
            <!-- 后置通知： -->
            <aop:after method="after" pointcut-ref="pt"/>
            <!-- 返回后通知 -->
            <aop:after-returning method="afterReturning" pointcut-ref="pt"/>
            <!-- 异常通知 -->
            <aop:after-throwing method="afterThrowing" pointcut-ref="pt"/>
            
        </aop:aspect>
    </aop:config>
</beans>

3.3 切入点表达式

可以对指定的“方法”进行拦截；从而给指定的方法所在的类生层代理对象

        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.*.*(..))" id="pt"/>-->
        
        <!-- 【拦截所有public方法】 -->
        <!--<aop:pointcut expression="execution(public * *(..))" id="pt"/>-->
        
        <!-- 【拦截所有save开头的方法 】 -->
        <!--<aop:pointcut expression="execution(* save*(..))" id="pt"/>-->
        
        <!-- 【拦截指定类的指定方法, 拦截时候一定要定位到方法】 -->
        <!--<aop:pointcut expression="execution(public * cn.itcast.g_pointcut.OrderDao.save(..))" id="pt"/>-->
        
        <!-- 【拦截指定类的所有方法】 -->
        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.UserDao.*(..))" id="pt"/>-->
        
        <!-- 【拦截指定包，以及其自包下所有类的所有方法】 -->
        <!--<aop:pointcut expression="execution(* cn..*.*(..))" id="pt"/>-->
        
        <!-- 【多个表达式】 -->
        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.UserDao.save()) || execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>-->
        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.UserDao.save()) or execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>-->
        <!-- 下面2个且关系的，没有意义 -->
        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.UserDao.save()) && execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>-->
        <!--<aop:pointcut expression="execution(* cn.itcast.g_pointcut.UserDao.save()) and execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>-->
        
        <!-- 【取非值】 -->
        <!--<aop:pointcut expression="!execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>-->
        <aop:pointcut expression=" not execution(* cn.itcast.g_pointcut.OrderDao.save())" id="pt"/>

Spring进阶之代理与AOP编程

1. 代理

1.1 静态代理

1.2 动态代理

1.3 Cglib代理

2. AOP编程

2.1 注解方式实现AOP编程

2.2 XML方式实现AOP编程

3.3 切入点表达式

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Java

JAVA基础知识

Java学习笔记