一、SpringFramework介绍
SpringFramework框架结构图:
Core Container
核心容器,在 Spring 环境下使用任何功能都必须基于 IOC 容器。
AOP&Aspects
面向切面编程
TX
声明式事务管理。
Spring MVC
提供了面向Web应用程序的集成功能。
二、Spring IoC容器和核心概念
2.1 组件和组件管理概念
2.1.1 什么是组件?
回顾常规的三层架构处理请求流程:
整个项目就是由各种组件搭建而成的:
2.1.2
Spring充当组件管理角色(IoC)
组件可以完全交给Spring
框架进行管理,Spring框架替代了程序员原有的new对象和对象属性赋值动作等!
Spring具体的组件管理动作包含:
组件对象实例化
组件属性属性赋值
组件对象之间引用
组件对象存活周期管理
......
我们只需要编写元数据(配置文件)告知Spring
管理哪些类组件和他们的关系即可!
注意:组件是映射到应用程序中所有可重用组件的Java对象,应该是可复用的功能对象!
综上所述,Spring
充当一个组件容器,创建、管理、存储组件,减少了我们的编码压力,让我们更加专注进行业务编写!
2.1.3 组件交给Spring管理优势
降低了组件之间的耦合性:Spring
IoC容器通过依赖注入机制,将组件之间的依赖关系削弱,减少了程序组件之间的耦合性,使得组件更加松散地耦合。
提高了代码的可重用性和可维护性:将组件的实例化过程、依赖关系的管理等功能交给Spring
IoC容器处理,使得组件代码更加模块化、可重用、更易于维护。
方便了配置和管理:Spring
IoC容器通过XML文件或者注解,轻松的对组件进行配置和管理,使得组件的切换、替换等操作更加的方便和快捷。
交给Spring管理的对象(组件),方可享受Spring框架的其他功能(AOP,声明事务管理)等
2.2 Spring IoC容器和容器实现
2.2.1 SpringIoC容器介绍
Spring IoC 容器,负责实例化、配置和组装
bean(组件)。容器通过读取配置元数据来获取有关要实例化、配置和组装组件的指令。配置元数据以
XML、Java 注解或 Java
代码形式表现。它允许表达组成应用程序的组件以及这些组件之间丰富的相互依赖关系。
上图显示了 Spring
容器工作原理的高级视图。应用程序类与配置元数据相结合,您拥有完全配置且可执行的系统或应用程序。
2.2.2
SpringIoC容器具体接口和实现类
SpringIoc容器接口 :
BeanFactory
接口提供了一种高级配置机制,能够管理任何类型的对象,它是SpringIoC容器标准化超接口!
ApplicationContext
是 BeanFactory
的子接口。它扩展了以下功能:
更容易与 Spring 的 AOP 功能集成
消息资源处理(用于国际化)
特定于应用程序给予此接口实现,例如Web 应用程序的
WebApplicationContext
简而言之, BeanFactory
提供了配置框架和基本功能,而
ApplicationContext
添加了更多特定于企业的功能。
ApplicationContext
是 BeanFactory
的完整超集!
ApplicationContext容器实现类 :
ClassPathXmlApplicationContext
通过读取类路径下(项目的路径下,比如resources)的 XML
格式 的配置文件创建 IOC 容器对象
FileSystemXmlApplicationContext
通过文件系统路径(项目外)读取 XML
格式 的配置文件创建 IOC 容器对象
AnnotationConfigApplicationContext
通过读取Java配置类 创建 IOC 容器对象
WebApplicationContext
专门为 Web 应用 准备,基于 Web 环境创建 IOC
容器对象,并将对象引入存入 ServletContext 域中。
2.2.3 SpringIoC容器管理配置方式
Spring IoC
容器使用多种形式的配置元数据。此配置元数据表示您作为应用程序开发人员如何告诉
Spring 容器实例化、配置和组装应用程序中的对象。
Spring框架提供了多种配置方式:XML配置方式、注解方式和Java配置类方式
XML配置方式:是Spring框架最早的配置方式之一,通过在XML文件中定义Bean及其依赖关系、Bean的作用域等信息,让Spring
IoC容器来管理Bean之间的依赖关系。该方式从Spring框架的第一版开始提供支持。
注解方式:从Spring
2.5版本开始提供支持,可以通过在Bean类上使用注解来代替XML配置文件中的配置信息。通过在Bean类上加上相应的注解(如@Component,
@Service , @Autowired等 ),将Bean注册到Spring
IoC容器中,这样Spring IoC容器就可以管理这些Bean之间的依赖关系。
Java配置类 方式:从Spring
3.0版本开始提供支持,通过Java类来定义Bean、Bean之间的依赖关系和配置信息,从而代替XML配置文件的方式。Java配置类是一种使用Java编写配置信息的方式,通过@Configuration、@Bean等注解来实现Bean和依赖关系的配置 。
为了迎合当下开发环境,我们将以配置类+注解方式 为主进行讲解!
2.3 Spring IoC / DI概念总结
IoC容器
Spring IoC 容器,负责实例化、配 置和组装
bean(组件)核心容器。容器通过读取配置元数据来获取有关要实例化、配置和组装组件的指令。
IoC(Inversion of Control)控制反转
IoC
主要是针对对象的创建和调用控制而言的,也就是说,当应用程序需要使用一个对象时,不再是应用程序直接创建该对象,而是由
IoC 容器来创建和管理,即控制权由应用程序转移到 IoC
容器中,也就是“反转”了控制权。这种方式基本上是通过依赖查找的方式来实现的,即
IoC 容器维护着构成应用程序的对象,并负责创建这些对象。
DI (Dependency Injection) 依赖注入
DI
是指在组件之间传递依赖关系的过程中,将依赖关系在容器内部进行处理,这样就不必在应用程序代码中硬编码对象之间的依赖关系,实现了对象之间的解耦合。在
Spring 中,DI 是通过 XML
配置文件或注解的方式实现的。它提供了三种形式的依赖注入:构造函数注入、Setter
方法注入和接口注入。
三、Spring IoC实践和应用
3.1 Spring IoC / DI 实现步骤
我们总结下,组件交给Spring
IoC容器管理,并且获取和使用的基本步骤!
1.配置元数据(配置)
配置元数据,既是编写交给SpringIoC容器管理组件的信息,配置方式有三种。
基于 XML 的配置元数据的基本结构:
1 2 3 <bean id ="..." [1 ] class ="..." [2 ]> </bean >
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 <?xml version="1.0" encoding="UTF-8" ?> <beans xmlns ="http://www.springframework.org/schema/beans" xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation ="http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd" > <bean id ="..." [1 ] class ="..." [2 ]> </bean > <bean id ="..." class ="..." > </bean > </beans >
Spring IoC
容器管理一个或多个组件。这些组件是使用你提供给容器的配置元数据(例如,以
XML <bean/>
定义的形式)创建的。
标签 == 组件信息声明
id
属性是标识单个 Bean
定义的字符串(唯一、方便后期读取)。
class
属性定义 Bean 的类型并使用完全限定的类名。
2.实例化IoC容器
提供给 ApplicationContext
构造函数的位置路径是资源字符串地址,允许容器从各种外部资源(如本地文件系统、Java
CLASSPATH
等)加载配置元数据。
我们应该选择一个合适的容器实现类,进行IoC容器的实例化工作:
1 2 3 ApplicationContext context = new ClassPathXmlApplicationContext ("services.xml" , "daos.xml" );
3.获取Bean(组件)
ApplicationContext
是一个高级工厂的接口,能够维护不同
bean 及其依赖项的注册表。通过使用方法
T getBean(String name, Class<T> requiredType)
,您可以检索 bean 的实例。
允许读取 Bean 定义并访问它们,如以下示例所示:
1 2 3 4 5 6 ApplicationContext context = new ClassPathXmlApplicationContext ("services.xml" , "daos.xml" );PetStoreService service = context.getBean("petStore" , PetStoreService.class);List<String> userList = service.getUsernameList();
3.2 基于XML配置方式组件管理
3.2.1 实验一:
组件(Bean)信息声明配置(IoC)
目标
Spring IoC 容器管理一个或多个 bean。这些 Bean
是使用您提供给容器的配置元数据创建的(例如,以 XML
<bean/>
定义的形式)。
我们学习,如何通过定义XML配置文件,声明组件类信息,交给 Spring 的 IoC
容器进行组件管理!
思路
准备项目
创建maven工程(spring-ioc-xml-01)
导入SpringIoC相关依赖
pom.xml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 <dependencies > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-context</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.junit.jupiter</groupId > <artifactId > junit-jupiter-api</artifactId > <version > 5.3.1</version > </dependency > </dependencies >
基于无参数构造函数
当通过构造函数方法创建一个 bean(组件对象) 时,所有普通类都可以由
Spring
使用并与之兼容。也就是说,正在开发的类不需要实现任何特定的接口或以特定的方式进行编码。只需指定
Bean
类信息就足够了。但是,默认情况下,我们需要一个默认(空)构造函数。
准备组件类
1 2 3 4 5 6 7 8 9 10 11 package com.atguigu.ioc;public class HappyComponent { public void doWork () { System.out.println("HappyComponent.doWork" ); } }
xml配置文件编写
创建携带spring约束的xml配置文件
编写配置文件:
文件:resources/spring-bean-01.xml
1 2 <bean id ="happyComponent" class ="com.atguigu.ioc.HappyComponent" />
bean标签:通过配置bean标签告诉IOC容器需要创建对象的组件信息
id属性:bean的唯一标识,方便后期获取Bean!
class属性:组件类的全限定符!
注意:要求当前组件类必须包含无参数构造函数!
基于静态工厂方法实例化
除了使用构造函数实例化对象,还有一类是通过工厂模式实例化对象。接下来我们讲解如何定义使用静态工厂方法创建Bean的配置
!
准备组件类
1 2 3 4 5 6 7 8 9 public class ClientService { private static ClientService clientService = new ClientService (); private ClientService () {} public static ClientService createInstance () { return clientService; } }
xml配置文件编写
文件:resources/spring-bean-01.xml
1 2 3 <bean id ="clientService" class ="examples.ClientService" factory-method ="createInstance" />
class属性:指定工厂类的全限定符!
factory-method:
指定静态工厂方法,注意,该方法必须是static方法。
基于实例工厂方法实例化
接下来我们讲解下如何定义使用实例工厂方法创建Bean的配置 !
准备组建类
1 2 3 4 5 6 7 8 public class DefaultServiceLocator { private static ClientServiceImplclientService = new ClientServiceImpl (); public ClientService createClientServiceInstance () { return clientService; } }
xml配置文件编写
文件:resources/spring-bean-01.xml
1 2 3 4 5 6 7 8 <bean id ="serviceLocator" class ="examples.DefaultServiceLocator" > </bean > <bean id ="clientService" factory-bean ="serviceLocator" factory-method ="createClientServiceInstance" />
factory-bean属性:指定当前容器中工厂Bean 的名称。
factory-method:
指定实例工厂方法名。注意,实例方法必须是非static的!
图解IoC配置流程
3.2.2 实验二:
组件(Bean)依赖注入配置(DI)
目标
通过配置文件,实现IoC容器中Bean之间的引用(依赖注入DI配置)。
主要涉及注入场景:基于构造函数的依赖注入和基于 Setter
的依赖注入。
思路
基于构造函数的依赖注入(单个构造参数)
1.准备组件类
1 2 3 4 5 6 7 8 9 10 11 12 13 public class UserDao {} public class UserService { private UserDao userDao; public UserService (UserDao userDao) { this .userDao = userDao; } }
2.编写配置文件
文件:resources/spring-02.xml
1 2 3 4 5 6 7 8 9 <beans > <bean id ="userService" class ="x.y.UserService" > <constructor-arg ref ="userDao" /> </bean > <bean id ="userDao" class ="x.y.UserDao" /> </beans >
constructor-arg标签:可以引用构造参数 ref引用其他bean的标识。
基于构造函数的依赖注入(多构造参数解析)
1.准备组件类
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 public class UserDao {} public class UserService { private UserDao userDao; private int age; private String name; public UserService (int age , String name ,UserDao userDao) { this .userDao = userDao; this .age = age; this .name = name; } }
2.编写配置文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 <beans > <bean id ="userService" class ="x.y.UserService" > <constructor-arg value ="18" /> <constructor-arg value ="赵伟风" /> <constructor-arg ref ="userDao" /> </bean > <bean id ="userDao" class ="x.y.UserDao" /> </beans > <beans > <bean id ="userService" class ="x.y.UserService" > <constructor-arg name ="name" value ="赵伟风" /> <constructor-arg name ="userDao" ref ="userDao" /> <constructor-arg name ="age" value ="18" /> </bean > <bean id ="userDao" class ="x.y.UserDao" /> </beans > <beans > <bean id ="userService" class ="x.y.UserService" > <constructor-arg index ="1" value ="赵伟风" /> <constructor-arg index ="2" ref ="userDao" /> <constructor-arg index ="0" value ="18" /> </bean > <bean id ="userDao" class ="x.y.UserDao" /> </beans >
constructor-arg标签:name属性指定参数名、index属性指定参数角标、value属性指定普通属性值
基于Setter方法依赖注入
1.介绍
开发中,除了构造函数注入(DI)更多的使用的Setter方法进行注入!
下面的示例演示一个只能使用纯 setter 注入进行依赖项注入的类。
2.准备组件类
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 public Class MovieFinder{} public class SimpleMovieLister { private MovieFinder movieFinder; private String movieName; public void setMovieFinder (MovieFinder movieFinder) { this .movieFinder = movieFinder; } public void setMovieName (String movieName) { this .movieName = movieName; } }
3.编写配置文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 <bean id ="simpleMovieLister" class ="examples.SimpleMovieLister" > <property name ="movieFinder" ref ="movieFinder" /> <property name ="movieName" value ="消失的她" /> </bean > <bean id ="movieFinder" class ="examples.MovieFinder" />
property标签: 可以给setter方法对应的属性赋值
property 标签:
name属性代表set方法标识 、ref代表引用bean的标识id、value属性代表基本属性值
总结:
依赖注入(DI)包含引用类型和基本数据类型,同时注入的方式也有多种!主流的注入方式为setter方法注入和构造函数注入,两种注入语法都需要掌握!
需要特别注意:引用其他bean,使用ref属性。直接注入基本类型值,使用value属性。
3.2.3 实验三: IoC容器创建和使用
1.介绍
上面的实验只是讲解了如何在XML格式的配置文件编写IoC和DI配置!
如图:
想要配置文件中声明组件类信息真正的进行实例化成Bean对象和形成Bean之间的引用关系,我们需要声明IoC容器对象,读取配置文件,实例化组件和关系维护的过程都是在IoC容器中实现的!
2.容器实例化
1 2 3 4 5 6 7 8 9 10 11 12 13 ApplicationContext context = new ClassPathXmlApplicationContext ("services.xml" , "daos.xml" ); ApplicationContext context = new ClassPathXmlApplicationContext (); iocContainer1.setConfigLocations("services.xml" , "daos.xml" ); iocContainer1.refresh();
3.Bean对象读取
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 HappyComponent happyComponent = (HappyComponent) iocContainer.getBean("bean的id标识" ); happyComponent.doWork(); HappyComponent happyComponent = iocContainer.getBean(HappyComponent.class);happyComponent.doWork(); HappyComponent happyComponent = iocContainer.getBean("bean的id标识" , HappyComponent.class);happyComponent.doWork(); 根据类型来获取bean时,在满足bean唯一性的前提下,其实只是看:『对象 instanceof 指定的类型』的返回结果, 只要返回的是true 就可以认定为和类型匹配,能够获取到。
3.2.4 实验四:
高级特性:组件(Bean)作用域和周期方法配置
1.组件周期方法配置
a.周期方法概念
我们可以在组件类中定义方法,然后当IoC容器实例化和销毁组件对象的时候进行调用!这两个方法我们成为
生命周期方法!
类似于Servlet的init/destroy方法,我们可以在周期方法完成初始化和释放资源等工作。
b.周期方法声明
1 2 3 4 5 6 7 8 9 10 11 12 13 14 public class BeanOne { public void init () { } } public class BeanTwo { public void cleanup () { } }
c.周期方法配置
1 2 3 4 <beans > <bean id ="beanOne" class ="examples.BeanOne" init-method ="init" /> <bean id ="beanTwo" class ="examples.BeanTwo" destroy-method ="cleanup" /> </beans >
d.测试周期方法调用情况
1 2 3 4 5 6 7 8 9 10 11 12 @Test public void test () { ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext ("xxxxxxx.xml" ); applicationContext.close(); }
2.组件作用域配置
a.Bean作用域概念
<bean
标签声明Bean,只是将Bean的信息配置给SpringIoC容器!
在IoC容器中,这些<bean
标签对应的信息转成Spring内部
BeanDefinition
对象,BeanDefinition
对象内,包含定义的信息(id,class,属性等等)!
这意味着,BeanDefinition
与类
概念一样,SpringIoC容器可以可以根据BeanDefinition
对象反射创建多个Bean对象实例。
具体创建多少个Bean的实例对象,由Bean的作用域Scope属性指定!
b.作用域可选值
singleton
在 IOC 容器中,这个 bean 的对象始终为单实例
IOC 容器初始化时
是
prototype
这个 bean 在 IOC 容器中有多个实例
获取 bean 时
否
如果是在WebApplicationContext环境下还会有另外两个作用域(但不常用):
request
请求范围内有效的实例
每次请求
否
session
会话范围内有效的实例
每次会话
否
3.作用域配置
配置scope范围
1 2 3 4 5 6 7 8 9 10 11 12 <bean id ="happyMachine8" scope ="prototype" class ="com.atguigu.ioc.HappyMachine" > <property name ="machineName" value ="happyMachine" /> </bean > <bean id ="happyComponent8" scope ="singleton" class ="com.atguigu.ioc.HappyComponent" > <property name ="componentName" value ="happyComponent" /> </bean >
4.作用域测试
1 2 3 4 5 6 7 8 9 10 11 12 13 14 @Test public void testExperiment08 () { ApplicationContext iocContainer = new ClassPathXmlApplicationContext ("配置文件名" ); HappyMachine bean = iocContainer.getBean(HappyMachine.class); HappyMachine bean1 = iocContainer.getBean(HappyMachine.class); System.out.println(bean == bean1); HappyComponent bean2 = iocContainer.getBean(HappyComponent.class); HappyComponent bean3 = iocContainer.getBean(HappyComponent.class); System.out.println(bean2 == bean3); }
3.2.5 实验五:
高级特性:FactoryBean特性和使用
1.FactoryBean简介
FactoryBean
接口是Spring
IoC容器实例化逻辑的可插拔性点。
用于配置复杂的Bean对象,可以将创建过程存储在FactoryBean
的getObject方法!
FactoryBean<T>
接口提供三种方法:
T getObject()
:
返回此工厂创建的对象的实例。该返回值会被存储到IoC容器!
boolean isSingleton()
:
如果此 FactoryBean
返回单例,则返回 true
,否则返回 false
。此方法的默认实现返回 true
(注意,lombok插件使用,可能影响效果)。
Class<?> getObjectType()
: 返回
getObject()
方法返回的对象类型,如果事先不知道类型,则返回
null
。
2.FactoryBean使用场景
代理类的创建
第三方框架整合
复杂对象实例化等
3.Factorybean应用
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 public class HappyFactoryBean implements FactoryBean <HappyMachine> { private String machineName; public String getMachineName () { return machineName; } public void setMachineName (String machineName) { this .machineName = machineName; } @Override public HappyMachine getObject () throws Exception { HappyMachine happyMachine = new HappyMachine (); happyMachine.setMachineName(this .machineName); return happyMachine; } @Override public Class<?> getObjectType() { return HappyMachine.class; } }
1 2 3 4 5 6 <bean id ="happyMachine7" class ="com.atguigu.ioc.HappyFactoryBean" > <property name ="machineName" value ="iceCreamMachine" /> </bean >
测试读取FactoryBean和FactoryBean.getObject对象
1 2 3 4 5 6 7 8 9 10 11 12 13 @Test public void testExperiment07 () { ApplicationContext iocContainer = new ClassPathXmlApplicationContext ("spring-bean-07.xml" ); HappyMachine happyMachine = iocContainer.getBean("happyMachine7" ,HappyMachine.class); System.out.println("happyMachine = " + happyMachine); Object bean = iocContainer.getBean("&happyMachine7" ); System.out.println("bean = " + bean); }
4.FactoryBean和BeanFactory区别
FactoryBean 是 Spring 中一种特殊的 bean,可以在
getObject() 工厂方法自定义的逻辑创建Bean!是一种能够生产其他 Bean 的
Bean。FactoryBean 在容器启动时被创建,而在实际使用时则是通过调用
getObject() 方法来得到其所生产的 Bean。因此,FactoryBean
可以自定义任何所需的初始化逻辑,生产出一些定制化的 bean。
一般情况下,整合第三方框架,都是通过定义FactoryBean实现!!!
BeanFactory 是 Spring
框架的基础,其作为一个顶级接口定义了容器的基本行为,例如管理 bean
的生命周期、配置文件的加载和解析、bean 的装配和依赖注入等。BeanFactory
接口提供了访问 bean 的方式,例如 getBean() 方法获取指定的 bean
实例。它可以从不同的来源(例如 Mysql 数据库、XML 文件、Java
配置类等)获取 bean 定义,并将其转换为 bean 实例。同时,BeanFactory
还包含很多子类(例如,ApplicationContext
接口)提供了额外的强大功能。
总的来说,FactoryBean 和 BeanFactory 的区别主要在于前者是用于创建
bean 的接口,它提供了更加灵活的初始化定制功能,而后者是用于管理 bean
的框架基础接口,提供了基本的容器功能和 bean 生命周期管理。
3.3 基于注解方式管理Bean
3.3.1 实验一: Bean注解标记和扫描
(IoC)
注解理解
和 XML
配置文件一样,注解本身并不能执行,注解本身仅仅只是做一个标记,具体的功能是框架检测到注解标记的位置,然后针对这个位置按照注解标记的功能来执行具体操作。
本质上:所有一切的操作都是 Java 代码来完成的,XML
和注解只是告诉框架中的 Java 代码如何执行。
举例:元旦联欢会要布置教室,蓝色的地方贴上元旦快乐四个字,红色的地方贴上拉花,黄色的地方贴上气球。
班长做了所有标记,同学们来完成具体工作。墙上的标记相当于我们在代码中使用的注解,后面同学们做的工作,相当于框架的具体操作。
扫描理解
Spring
为了知道程序员在哪些地方标记了什么注解,就需要通过扫描的方式,来进行检测。然后根据注解进行后续操作。
准备Spring项目和组件
准备组件类
普通组件
1 2 3 4 5 6 7 8 public class CommonComponent {}
Controller组件
1 2 3 4 5 6 7 8 public class XxxController {}
Service组件
1 2 3 4 5 6 7 8 public class XxxService {}
Dao组件
1 2 3 4 5 6 7 8 public class XxxDao {}
组件添加标记注解
组件标记注解和区别
Spring 提供了以下多个注解,这些注解可以直接标注在 Java
类上,将它们定义成 Spring Bean。
@Component
该注解用于描述 Spring 中的
Bean,它是一个泛化的概念,仅仅表示容器中的一个组件(Bean),并且可以作用在应用的任何层次,例如
Service 层、Dao 层等。 使用时只需将该注解标注在相应类上即可。
@Repository
该注解用于将数据访问层(Dao 层)的类标识为 Spring 中的
Bean,其功能与 @Component 相同。
@Service
该注解通常作用在业务层(Service 层),用于将业务层的类标识为 Spring
中的 Bean,其功能与 @Component 相同。
@Controller
该注解通常作用在控制层(如SpringMVC 的
Controller),用于将控制层的类标识为 Spring 中的 Bean,其功能与 @Component 相同。
通过查看源码我们得知,@Controller 、@Service 、@Repository这三个注解只是在 @Component注解的基础上起了三个新的名字 。
对于Spring使用IOC容器管理这些组件来说没有区别,也就是语法层面没有区别。所以@Controller、@Service 、@Repository这三个注解只是给开发人员看的 ,让我们能够便于分辨组件的作用。
注意:虽然它们本质上一样,但是为了代码的可读性、程序结构严谨!我们肯定不能随便胡乱标记。
使用注解标记
普通组件
1 2 3 4 5 6 7 8 9 @Component public class CommonComponent {}
Controller组件
1 2 3 4 5 6 7 8 9 @Controller public class XxxController {}
Service组件
1 2 3 4 5 6 7 8 9 @Service public class XxxService {}
Dao组件
1 2 3 4 5 6 7 8 9 @Repository public class XxxDao {}
配置文件确定扫描范围
情况1:基本扫描配置
1 2 3 4 5 6 7 8 9 10 11 12 13 <?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:context ="http://www.springframework.org/schema/context" xsi:schemaLocation ="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd" > <context:component-scan base-package ="com.atguigu.components" /> </beans >
情况2:指定排除组件
1 2 3 4 5 6 7 8 <context:component-scan base-package ="com.atguigu.components" > <context:exclude-filter type ="annotation" expression ="org.springframework.stereotype.Controller" /> </context:component-scan >
情况3:指定扫描组件
1 2 3 4 5 6 7 8 <context:component-scan base-package ="com.atguigu.ioc.components" use-default-filters ="false" > <context:include-filter type ="annotation" expression ="org.springframework.stereotype.Controller" /> </context:component-scan >
组件BeanName问题
在我们使用 XML 方式管理 bean 的时候,每个 bean 都有一个唯一标识——id
属性的值,便于在其他地方引用。现在使用注解后,每个组件仍然应该有一个唯一标识。
默认情况:
类名首字母小写就是 bean 的 id。例如:SoldierController 类对应的 bean
的 id 就是 soldierController。
使用value属性指定:
1 2 3 @Controller(value = "tianDog") public class SoldierController {}
当注解中只设置一个属性时,value属性的属性名可以省略:
1 2 3 @Service("smallDog") public class SoldierService {}
总结
注解方式IoC只是标记哪些类要被Spring管理
最终,我们还需要XML方式或者后面讲解Java配置类方式指定注解生效的包
现阶段配置方式为 注解 (标记)+ XML(扫描)
3.3.2 实验二:
组件(Bean)作用域和周期方法注解
周期方法概念
我们可以在组件类中定义方法,然后当IoC容器实例化和销毁组件对象的时候进行调用!这两个方法我们成为生命周期方法!
类似于Servlet的init/destroy方法,我们可以在周期方法完成初始化和释放资源等工作。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 public class BeanOne { @PostConstruct public void init () { } } public class BeanTwo { @PreDestroy public void cleanup () { } }
组件作用域配置
Bean作用域概念
<bean
标签声明Bean,只是将Bean的信息配置给SpringIoC容器!
在IoC容器中,这些<bean
标签对应的信息转成Spring内部
BeanDefinition
对象,BeanDefinition
对象内,包含定义的信息(id,class,属性等等)!
这意味着,BeanDefinition
与类
概念一样,SpringIoC容器可以可以根据BeanDefinition
对象反射创建多个Bean对象实例。
具体创建多少个Bean的实例对象,由Bean的作用域Scope属性指定!
作用域可选值
singleton
在 IOC 容器中,这个 bean 的对象始终为单实例
IOC 容器初始化时
是
prototype
这个 bean 在 IOC 容器中有多个实例
获取 bean 时
否
如果是在WebApplicationContext环境下还会有另外两个作用域(但不常用):
request
请求范围内有效的实例
每次请求
否
session
会话范围内有效的实例
每次会话
否
作用域配置
1 2 3 4 5 6 7 8 9 10 @Scope(scopeName = ConfigurableBeanFactory.SCOPE_SINGLETON) @Scope(scopeName = ConfigurableBeanFactory.SCOPE_PROTOTYPE) public class BeanOne { @PostConstruct public void init () { } }
3.3.3 实验三:
Bean属性赋值:引用类型自动装配 (DI)
设定场景
1 2 3 4 5 6 7 8 9 10 11 12 import org.springframework.stereotype.Controller;@Controller(value = "tianDog") public class SoldierController { private SoldierService soldierService; public void getMessage () { soldierService.getMessage(); } }
1 2 3 4 5 6 7 8 9 @Service("smallDog") public class SoldierService { private SoldierDao soldierDao; public void getMessage () { soldierDao.getMessage(); } }
1 2 3 4 5 6 7 8 @Repository public class SoldierDao { public void getMessage () { System.out.print("I am a soldier" ); } }
自动装配实现
1.前提
参与自动装配的组件(需要装配、被装配)全部都必须在IoC容器中。
注意:不区分IoC的方式!XML和注解都可以!
2.@Autowired注解
在成员变量上直接标记@Autowired注解即可,不需要提供setXxx()方法。以后我们在项目中的正式用法就是这样。
3.给Controller装配Service
1 2 3 4 5 6 7 8 9 10 11 @Controller(value = "tianDog") public class SoldierController { @Autowired private SoldierService soldierService; public void getMessage () { soldierService.getMessage(); } }
4.给Service装配Dao
1 2 3 4 5 6 7 8 9 10 @Service("smallDog") public class SoldierService { @Autowired private SoldierDao soldierDao; public void getMessage () { soldierDao.getMessage(); } }
@Autowired注解细节
1.标记位置
(1)成员变量
这是最主要的使用方式!
与xml进行bean ref引用不同,他不需要有set方法!
1 2 3 4 5 6 7 8 9 10 @Service("smallDog") public class SoldierService { @Autowired private SoldierDao soldierDao; public void getMessage () { soldierDao.getMessage(); } }
(2)构造器
1 2 3 4 5 6 7 8 9 10 @Controller(value = "tianDog") public class SoldierController { private SoldierService soldierService; @Autowired public SoldierController (SoldierService soldierService) { this .soldierService = soldierService; } ……
(3)setXxx()方法
1 2 3 4 5 6 7 8 9 10 @Controller(value = "tianDog") public class SoldierController { private SoldierService soldierService; @Autowired public void setSoldierService (SoldierService soldierService) { this .soldierService = soldierService; } ……
2.工作流程
首先根据所需要的组件类型到 IOC 容器中查找
能够找到唯一的 bean:直接执行装配
如果完全找不到匹配这个类型的 bean:装配失败
和所需类型匹配的 bean 不止一个
没有 @Qualifier
注解:根据 @Autowired 标记位置成员变量的变量名作为
bean 的 id 进行匹配
使用 @Qualifier
注解:根据 @Qualifier 注解中指定的名称作为 bean
的id进行匹配
1 2 3 4 5 6 7 @Controller(value = "tianDog") public class SoldierController { @Autowired @Qualifier(value = "maomiService222") private ISoldierService soldierService;
佛系装配
给 @Autowired
注解设置 required = false
属性表示:能装就装,装不上就不装。但是实际开发时,基本上所有需要装配组件的地方都是必须装配的,用不上这个属性
1 2 3 4 5 6 @Controller(value = "tianDog") public class SoldierController { @Autowired(required = false) private ISoldierService soldierService;
扩展JSR-250注解@Resource
理解JSR系列注解
JSR(Java Specification
Requests)是Java平台标准化进程中的一种技术规范,而JSR注解是其中一部分重要的内容。按照JSR的分类以及注解语义的不同,可以将JSR注解分为不同的系列,主要有以下几个系列:
1.JSR-175: 这个JSR是Java SE 5引入的,是Java注解最早的规范化版本,Java
SE 5后的版本中都包含该JSR中定义的注解。主要包括以下几种标准注解:
@Deprecated
:
标识一个程序元素(如类、方法或字段)已过时,并且在将来的版本中可能会被删除。
@Override
: 标识一个方法重写了父类中的方法。
@SuppressWarnings
: 抑制编译时产生的警告消息。
@SafeVarargs
: 标识一个有安全性警告的可变参数方法。
@FunctionalInterface
:
标识一个接口只有一个抽象方法,可以作为lambda表达式的目标。
2.JSR-250: 这个JSR主要用于在Java EE
5中定义一些支持注解。该JSR主要定义了一些用于进行对象管理的注解,包括:
@Resource
: 标识一个需要注入的资源,是实现Java
EE组件之间依赖关系的一种方式。
@PostConstruct
: 标识一个方法作为初始化方法。
@PreDestroy
: 标识一个方法作为销毁方法。
@Resource.AuthenticationType
:
标识注入的资源的身份验证类型。
@Resource.AuthenticationType
:
标识注入的资源的默认名称。
3.JSR-269: 这个JSR主要是Java SE
6中引入的一种支持编译时元数据处理的框架,即使用注解来处理Java源文件。该JSR定义了一些可以用注解标记的注解处理器,用于生成一些元数据,常用的注解有:
@SupportedAnnotationTypes
:
标识注解处理器所处理的注解类型。
@SupportedSourceVersion
:
标识注解处理器支持的Java源码版本。
4.JSR-330:
该JSR主要为Java应用程序定义了一个依赖注入的标准,即Java依赖注入标准(javax.inject)。在此规范中定义了多种注解,包括:
@Named
: 标识一个被依赖注入的组件的名称。
@Inject
: 标识一个需要被注入的依赖组件。
@Singleton
:
标识一个组件的生命周期只有一个唯一的实例。
5.JSR-250: 这个JSR主要是Java EE
5中定义一些支持注解。该JSR包含了一些支持注解,可以用于对Java
EE组件进行管理,包括:
@RolesAllowed
: 标识授权角色
@PermitAll
: 标识一个活动无需进行身份验证。
@DenyAll
: 标识不提供针对该方法的访问控制。
@DeclareRoles
: 声明安全角色。
但是你要理解JSR是Java提供的技术规范 ,也就是说,他只是规定了注解和注解的含义,JSR并不是直接提供特定的实现 ,而是提供标准和指导方针,由第三方框架(Spring)和库来实现和提供对应的功能。
JSR-250 @Resource注解
@Resource注解也可以完成属性注入 。那它和@Autowired注解有什么区别?
@Resource注解是JDK扩展包中的 ,也就是说属于JDK的一部分。所以该注解是标准注解,更加具有通用性。(JSR-250标准中制定的注解类型。JSR是Java规范提案。)
@Autowired注解是Spring框架自己的 。
@Resource注解默认根据Bean名称装配 ,未指定name时,使用属性名作为name。通过name找不到的话会自动启动通过类型装配。
@Autowired注解默认根据类型装配 ,如果想根据名称装配,需要配合@Qualifier注解一起用。
@Resource注解用在属性上 、setter方法上。
@Autowired注解用在属性上 、setter方法上、构造方法上、构造方法参数上。
@Resource注解属于JDK扩展包 ,所以不在JDK当中,需要额外引入以下依赖:【高于JDK11或低于JDK8需要引入以下依赖 】
1 2 3 4 5 <dependency > <groupId > jakarta.annotation</groupId > <artifactId > jakarta.annotation-api</artifactId > <version > 2.1.1</version > </dependency >
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @Controller public class XxxController { @Resource private XxxService xxxService; public void show () { System.out.println("XxxController.show" ); xxxService.show(); } }
3.3.4 实验四:
Bean属性赋值:基本类型属性赋值 (DI)
@Value
通常用于注入外部化属性
声明外部配置
application.properties
1 catalog.name=MovieCatalog
xml引入外部配置
1 2 <!-- 引入外部配置文件--> <context:property-placeholder location="application.properties" />
@Value注解读取配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 package com.atguigu.components;import org.springframework.beans.factory.annotation.Value;import org.springframework.stereotype.Component;@Component public class CommonComponent { @Value("${catalog:hahaha}") private String name; public String getName () { return name; } public void setName (String name) { this .name = name; } }
3.4 基于配置类方式管理bean
3.4.1 完全注解开发理解
Spring 完全注解配置(Fully Annotation-based Configuration)是指通过
Java配置类 代码来配置 Spring 应用程序,使用注解来替代原本在 XML
配置文件中的配置。相对于 XML
配置,完全注解配置具有更强的类型安全性和更好的可读性。
两种方式思维转化 :
3.4.2 实验一:配置类和扫描注解
xml+注解方式
配置文件application.xml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 <?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:context ="http://www.springframework.org/schema/context" xsi:schemaLocation ="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd" > <context:component-scan base-package ="com.atguigu.components" /> <context:property-placeholder location ="application.properties" /> </beans >
测试创建IoC容器
1 2 3 ApplicationContext applicationContext = new ClassPathXmlApplicationContext ("application.xml" );
配置类+注解方式(完全注解方式)
配置类
使用 @Configuration
注解将一个普通的类标记为 Spring 的配置类。
1 2 3 4 5 6 7 8 9 10 11 12 13 import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.PropertySource;@Configuration @PropertySource("classpath:application.properties") @ComponentScan(basePackages = {"com.atguigu.components"}) public class MyConfiguration { }
测试创建IoC容器
1 2 3 ApplicationContext iocContainerAnnotation = new AnnotationConfigApplicationContext (MyConfiguration.class);
可以使用 no-arg 构造函数实例化
AnnotationConfigApplicationContext
,然后使用
register()
方法对其进行配置。此方法在以编程方式生成
AnnotationConfigApplicationContext
时特别有用。以下示例演示如何执行此操作:
1 2 3 4 5 6 7 8 ApplicationContext iocContainerAnnotation = new AnnotationConfigApplicationContext ();iocContainerAnnotation.register(MyConfiguration.class); iocContainerAnnotation.refresh();
总结:
@Configuration指定一个类为配置类 ,可以添加配置注解,替代配置xml文件
@ComponentScan (basePackages =
{"包","包"}) 替代<context:component-scan标签实现注解扫描
@PropertySource ("classpath:配置文件地址")
替代 <context:property-placeholder标签
配合IoC/DI注解,可以进行完整注解开发!
3.4.3 实验二:@Bean定义组件
场景需求 :将Druid连接池对象存储到IoC容器
需求分析 :第三方jar包的类,添加到ioc容器,无法使用@Component等相关注解!因为源码jar包内容为只读模式!
xml方式实现 :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 <?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:context ="http://www.springframework.org/schema/context" xsi:schemaLocation ="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd" > <context:property-placeholder location ="classpath:jdbc.properties" /> <bean id ="druidDataSource" class ="com.alibaba.druid.pool.DruidDataSource" > <property name ="url" value ="${jdbc.url}" /> <property name ="driverClassName" value ="${jdbc.driver}" /> <property name ="username" value ="${jdbc.user}" /> <property name ="password" value ="${jdbc.password}" /> </bean > </beans >
配置类方式实现 :
@Bean
注释用于指示方法实例化、配置和初始化要由 Spring
IoC 容器管理的新对象。对于那些熟悉 Spring 的 <beans/>
XML 配置的人来说, @Bean
注释与 <bean/>
元素起着相同的作用。
以下是在形参中添加@Value注解,也可以将形参剥离出来写@Value注解,这样作用就可以全局了。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 @Configuration @PropertySource({"classpath:application.properties","classpath:jdbc.properties"}) @ComponentScan(basePackages = {"com.atguigu.components"}) public class MyConfiguration { @Bean public DataSource createDataSource (@Value("${jdbc.user}") String username, @Value("${jdbc.password}") String password, @Value("${jdbc.url}") String url, @Value("${jdbc.driver}") String driverClassName) { DruidDataSource dataSource = new DruidDataSource (); dataSource.setUsername(username); dataSource.setPassword(password); dataSource.setUrl(url); dataSource.setDriverClassName(driverClassName); return dataSource; } }
3.4.4 实验三:高级特性:@Bean注解细节
问题1:@Bean生成BeanName问题
@Bean注解源码 :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 public @interface Bean { @AliasFor("name") String[] value() default {}; @AliasFor("value") String[] name() default {}; boolean autowireCandidate () default true ; String initMethod () default "" ; String destroyMethod () default "(inferred)" ; }
指定@Bean的名称:
1 2 3 4 5 6 7 8 @Configuration public class AppConfig { @Bean("myThing") public Thing thing () { return new Thing (); } }
@Bean
注释注释方法。使用此方法在指定为方法返回值的类型的
ApplicationContext
中注册 Bean 定义。缺省情况下,Bean
名称与方法名称相同。下面的示例演示 @Bean
方法声明:
1 2 3 4 5 6 7 8 @Configuration public class AppConfig { @Bean public TransferServiceImpl transferService () { return new TransferServiceImpl (); } }
前面的配置完全等同于下面的Spring XML:
1 2 3 <beans> <bean id="transferService" class="com.acme.TransferServiceImpl" /> </beans>
问题2:@Bean
初始化和销毁方法指定
@Bean
注解支持指定任意初始化和销毁回调方法,非常类似于
Spring XML 在 bean
元素上的 init-method
和
destroy-method
属性,如以下示例所示:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 public class BeanOne { public void init () { } } public class BeanTwo { public void cleanup () { } } @Configuration public class AppConfig { @Bean(initMethod = "init") public BeanOne beanOne () { return new BeanOne (); } @Bean(destroyMethod = "cleanup") public BeanTwo beanTwo () { return new BeanTwo (); } }
问题3:@Bean
Scope作用域
可以指定使用 @Bean
注释定义的 bean
应具有特定范围。您可以使用在 Bean 作用域部分中指定的任何标准作用域。
默认作用域为 singleton
,但您可以使用
@Scope
注释覆盖此范围,如以下示例所示:
1 2 3 4 5 6 7 8 9 @Configuration public class MyConfiguration { @Bean @Scope("prototype") public Encryptor encryptor () { } }
问题4:@Bean方法之间依赖
准备组件
1 2 3 4 5 6 7 8 9 10 11 12 public class HappyMachine { private String machineName; public String getMachineName () { return machineName; } public void setMachineName (String machineName) { this .machineName = machineName; } }
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 public class HappyComponent { private HappyMachine happyMachine; public HappyMachine getHappyMachine () { return happyMachine; } public void setHappyMachine (HappyMachine happyMachine) { this .happyMachine = happyMachine; } public void doWork () { System.out.println("HappyComponent.doWork" ); } }
Java配置类实现:
方案1:
直接调用方法返回 Bean 实例:在一个 @Bean
方法中直接调用其他 @Bean
方法来获取 Bean
实例,虽然是方法调用,也是通过IoC容器获取对应的Bean,例如:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 @Configuration public class JavaConfig { @Bean public HappyMachine happyMachine () { return new HappyMachine (); } @Bean public HappyComponent happyComponent () { HappyComponent happyComponent = new HappyComponent (); happyComponent.setHappyMachine(happyMachine()); return happyComponent; } }
方案2:(更推荐这个 )
参数引用法:通过方法参数传递 Bean 实例的引用来解决 Bean
实例之间的依赖关系,例如:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 package com.atguigu.config;import com.atguigu.ioc.HappyComponent;import com.atguigu.ioc.HappyMachine;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configuration public class JavaConfig { @Bean public HappyMachine happyMachine () { return new HappyMachine (); } @Bean public HappyComponent happyComponent (HappyMachine happyMachine) { HappyComponent happyComponent = new HappyComponent (); happyComponent.setHappyMachine(happyMachine); return happyComponent; } }
3.4.5 实验四:高级特性:@Import扩展
@Import
注释允许从另一个配置类加载 @Bean
定义,如以下示例所示:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @Import(ConfigB.class) @Configuration public class ConfigA { @Bean public A a () { return new A (); } } @Configuration public class ConfigB { @Bean public B b () { return new B (); } }
现在,在实例化上下文时不需要同时指定 ConfigA.class
和
ConfigB.class
,只需显式提供 ConfigA
,如以下示例所示:
1 2 3 4 5 6 7 public static void main (String[] args) { ApplicationContext ctx = new AnnotationConfigApplicationContext (ConfigA.class); A a = ctx.getBean(A.class); B b = ctx.getBean(B.class); }
此方法简化了容器实例化,因为只需要处理一个类,而不是要求您在构造期间记住可能大量的
@Configuration
类。
3.4 三种配置方式总结
#### 3.4.1 XML方式配置总结
所有内容写到xml格式配置文件中
声明bean通过<bean标签
<bean标签包含基本信息(id,class)和属性信息<property name value / ref
引入外部的properties文件可以通过<context:property-placeholder
IoC具体容器实现选择ClassPathXmlApplicationContext
对象
3.4.2 XML+注解方式配置总结
注解负责标记IoC的类和进行属性装配
xml文件依然需要,需要通过<context:component-scan
标签指定注解范围
标记IoC注解:@Component,@Service,@Controller,@Repository
标记DI注解:@Autowired @Qualifier @Resource @Value
IoC具体容器实现选择ClassPathXmlApplicationContext
对象
3.4.3 完全注解方式配置总结
完全注解方式指的是去掉xml文件,使用配置类 + 注解实现
xml文件替换成使用@Configuration
注解标记的类
标记IoC注解:@Component,@Service,@Controller,@Repository
标记DI注解:@Autowired @Qualifier @Resource @Value
<context:component-scan
标签指定注解范围使用@ComponentScan(basePackages = {"com.atguigu.components"})
替代
<context:property-placeholder
引入外部配置文件使用@PropertySource({"classpath:application.properties","classpath:jdbc.properties"})
替代
<bean 标签使用@Bean注解和方法实现
IoC具体容器实现选择AnnotationConfigApplicationContext
对象
3.5
整合Spring5-Test5搭建测试环境
整合测试环境作用
好处1:不需要自己创建IOC容器对象了
好处2:任何需要的bean都可以在测试类中直接享受自动装配
步骤:
1.导入相关依赖
1 2 3 4 5 6 7 8 9 10 11 12 <dependency > <groupId > org.junit.jupiter</groupId > <artifactId > junit-jupiter-api</artifactId > <version > 5.3.1</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-test</artifactId > <version > 6.0.6</version > <scope > test</scope > </dependency >
2.整合测试注解使用
1 2 3 4 5 6 7 8 9 10 11 12 @SpringJUnitConfig(value = {BeanConfig.class}) public class Junit5IntegrationTest { @Autowired private User user; @Test public void testJunit5 () { System.out.println(user); } }
四、Spring AOP 面向切面编程
4.1 场景设定和问题复现
1.准备AOP项目
项目名:spring-aop-annotation
pom.xml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 <dependencies > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-context</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.junit.jupiter</groupId > <artifactId > junit-jupiter-api</artifactId > <version > 5.3.1</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-test</artifactId > <version > 6.0.6</version > <scope > test</scope > </dependency > <dependency > <groupId > jakarta.annotation</groupId > <artifactId > jakarta.annotation-api</artifactId > <version > 2.1.1</version > </dependency > </dependencies >
2.声明接口
1 2 3 4 5 6 7 8 9 10 11 12 13 14 public interface Calculator { int add (int i, int j) ; int sub (int i, int j) ; int mul (int i, int j) ; int div (int i, int j) ; }
3.接口实现
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 package com.atguigu.proxy;public class CalculatorPureImpl implements Calculator { @Override public int add (int i, int j) { int result = i + j; return result; } @Override public int sub (int i, int j) { int result = i - j; return result; } @Override public int mul (int i, int j) { int result = i * j; return result; } @Override public int div (int i, int j) { int result = i / j; return result; } }
4.声明带日志接口实现
新需求:
需要在每个方法中,添加控制台输出,输出参数和输出计算后的返回值!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 package com.atguigu.proxy;public class CalculatorLogImpl implements Calculator { @Override public int add (int i, int j) { System.out.println("参数是:" + i + "," + j); int result = i + j; System.out.println("方法内部 result = " + result); return result; } @Override public int sub (int i, int j) { System.out.println("参数是:" + i + "," + j); int result = i - j; System.out.println("方法内部 result = " + result); return result; } @Override public int mul (int i, int j) { System.out.println("参数是:" + i + "," + j); int result = i * j; System.out.println("方法内部 result = " + result); return result; } @Override public int div (int i, int j) { System.out.println("参数是:" + i + "," + j); int result = i / j; System.out.println("方法内部 result = " + result); return result; } }
5.代码问题分析
代码缺陷
解决思路
核心就是:解耦。我们需要把附加功能从业务功能代码中抽取出来。将重复的代码统一提取,并且[[动态插入]]到每个业务方法!
技术困难
解决问题的困难:提取重复附加功能代码到一个类中,可以实现。但是如何将代码插入到各个方法中,我们不会,我们需要引用新技术!!!
4.2 解决技术代理模式
代理模式
二十三种设计模式中的一种,属于结构型模式。它的作用就是通过提供一个代理类,让我们在调用目标方法的时候,不再是直接对目标方法进行调用,而是通过代理类间接调用。让不属于目标方法核心逻辑的代码从目标方法中剥离出来——解耦。调用目标方法时先调用代理对象的方法,减少对目标方法的调用和打扰,同时让附加功能能够集中在一起也有利于统一维护。
无代理场景:
有代理场景:
生活中的代理:
广告商找大明星拍广告需要经过经纪人
合作伙伴找大老板谈合作要约见面时间需要经过秘书
房产中介是买卖双方的代理
太监是大臣和皇上之间的代理
相关术语:
代理:将非核心逻辑剥离出来以后,封装这些非核心逻辑的类、对象、方法。(中介)
动词:指做代理这个动作,或这项工作
名词:扮演代理这个角色的类、对象、方法
目标:被代理 “套用”了核心逻辑代码的类、对象、方法。(房东)
代理在开发中实现的方式具体有两种:静态代理,[动态代理技术]
静态代理
主动创建代理类:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 public class CalculatorStaticProxy implements Calculator { private Calculator target; public CalculatorStaticProxy (Calculator target) { this .target = target; } @Override public int add (int i, int j) { System.out.println("参数是:" + i + "," + j); int addResult = target.add(i, j); System.out.println("方法内部 result = " + result); return addResult; } ……
静态代理确实实现了解耦,但是由于代码都写死了,完全不具备任何的灵活性。就拿日志功能来说,将来其他地方也需要附加日志,那还得再声明更多个静态代理类,那就产生了大量重复的代码,日志功能还是分散的,没有统一管理。
提出进一步的需求:将日志功能集中到一个代理类中,将来有任何日志需求,都通过这一个代理类来实现。这就需要使用动态代理技术了。
动态代理
动态代理技术分类
JDK动态代理:JDK原生的实现方式,需要被代理的目标类必须实现接口 !他会根据目标类的接口动态生成一个代理对象!代理对象和目标对象有相同的接口!(拜把子)
cglib:通过继承被代理的目标类实现代理,所以不需要目标类实现接口!(认干爹)
JDK动态代理技术实现(了解)
代理工程:基于jdk代理技术,生成代理对象
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 public class ProxyFactory { private Object target; public ProxyFactory (Object target) { this .target = target; } public Object getProxy () { ClassLoader classLoader = target.getClass().getClassLoader(); Class<?>[] interfaces = target.getClass().getInterfaces(); InvocationHandler invocationHandler = new InvocationHandler () { @Override public Object invoke (Object proxy, Method method, Object[] args) throws Throwable { Object result = null ; try { System.out.println("[动态代理][日志] " +method.getName()+",参数:" + Arrays.toString(args)); result = method.invoke(target, args); System.out.println("[动态代理][日志] " +method.getName()+",结果:" + result); } catch (Exception e) { e.printStackTrace(); System.out.println("[动态代理][日志] " +method.getName()+",异常:" +e.getMessage()); } finally { System.out.println("[动态代理][日志] " +method.getName()+",方法执行完毕" ); } return result; } }; return Proxy.newProxyInstance(classLoader, interfaces, invocationHandler); } }
测试代码:
1 2 3 4 5 6 7 @Test public void testDynamicProxy () { ProxyFactory factory = new ProxyFactory (new CalculatorLogImpl ()); Calculator proxy = (Calculator) factory.getProxy(); proxy.div(1 ,0 ); }
代理总结
代理方式可以解决附加功能代码干扰核心代码和不方便统一维护的问题!
他主要是将附加功能代码提取到代理中执行,不干扰目标核心代码!
但是我们也发现,无论使用静态代理和动态代理(jdk,cglib),程序员的工作都比较繁琐!
需要自己编写代理工厂等!
但是,提前剧透,我们在实际开发中,不需要编写代理代码,我们可以使用[Spring
AOP]框架,
他会简化动态代理的实现!!!
4.3 面向切面编程思维(AOP)
面向切面编程思想AOP
AOP:Aspect Oriented Programming面向切面编程
AOP可以说是OOP(Object Oriented
Programming,面向对象编程)的补充和完善。OOP引入封装、继承、多态等概念来建立一种对象层次结构,用于模拟公共行为的一个集合。不过OOP允许开发者定义纵向的关系,但并不适合定义横向的关系,例如日志功能。日志代码往往横向地散布在所有对象层次中,而与它对应的对象的核心功能毫无关系对于其他类型的代码,如安全性、异常处理和透明的持续性也都是如此,这种散布在各处的无关的代码被称为横切(cross
cutting),在OOP设计中,它导致了大量代码的重复,而不利于各个模块的重用。
(针对以上的话,个人理解:
AOP技术恰恰相反,它利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装到一个可重用模块,并将其命名为"Aspect",即切面。所谓"切面",简单说就是那些与业务无关,却为业务模块所共同调用的逻辑或责任封装起来,便于减少系统的重复代码,降低模块之间的耦合度,并有利于未来的可操作性和可维护性。
使用AOP,可以在不修改原来代码的基础上添加新功能。
AOP思想主要的应用场景
AOP(面向切面编程)是一种编程范式,它通过将通用的横切关注点(如日志、事务、权限控制等)与业务逻辑分离,使得代码更加清晰、简洁、易于维护。AOP可以应用于各种场景,以下是一些常见的AOP应用场景:
日志记录:在系统中记录日志是非常重要的,可以使用AOP来实现日志记录的功能,可以在方法执行前、执行后或异常抛出时记录日志。
事务处理:在数据库操作中使用事务可以保证数据的一致性,可以使用AOP来实现事务处理的功能,可以在方法开始前开启事务,在方法执行完毕后提交或回滚事务。
安全控制:在系统中包含某些需要安全控制的操作,如登录、修改密码、授权等,可以使用AOP来实现安全控制的功能。可以在方法执行前进行权限判断,如果用户没有权限,则抛出异常或转向到错误页面,以防止未经授权的访问。
性能监控:在系统运行过程中,有时需要对某些方法的性能进行监控,以找到系统的瓶颈并进行优化。可以使用AOP来实现性能监控的功能,可以在方法执行前记录时间戳,在方法执行完毕后计算方法执行时间并输出到日志中。
异常处理:系统中可能出现各种异常情况,如空指针异常、数据库连接异常等,可以使用AOP来实现异常处理的功能,在方法执行过程中,如果出现异常,则进行异常处理(如记录日志、发送邮件等)。
缓存控制:在系统中有些数据可以缓存起来以提高访问速度,可以使用AOP来实现缓存控制的功能,可以在方法执行前查询缓存中是否有数据,如果有则返回,否则执行方法并将方法返回值存入缓存中。
动态代理:AOP的实现方式之一是通过动态代理,可以代理某个类的所有方法,用于实现各种功能。
综上所述,AOP可以应用于各种场景,它的作用是将通用的横切关注点与业务逻辑分离,使得代码更加清晰、简洁、易于维护。
、AOP术语名词介绍
1-横切关注点
从每个方法中抽取出来的同一类非核心业务。在同一个项目中,我们可以使用多个横切关注点对相关方法进行多个不同方面的增强。
这个概念不是语法层面天然存在的,而是根据附加功能的逻辑上的需要:有十个附加功能,就有十个横切关注点。
AOP把软件系统分为两个部分:核心关注点和横切关注点。业务处理的主要流程是核心关注点,与之关系不大的部分是横切关注点。横切关注点的一个特点是,他们经常发生在核心关注点的多处,而各处基本相似,比如权限认证、日志、事务、异常等。AOP的作用在于分离系统中的各种关注点,将核心关注点和横切关注点分离开来。
2-通知(增强)
每一个横切关注点上要做的事情都需要写一个方法来实现,这样的方法就叫通知方法。
前置通知:在被代理的目标方法前执行
返回通知:在被代理的目标方法成功结束后执行(寿终正寝 )
异常通知:在被代理的目标方法异常结束后执行(死于非命 )
后置通知:在被代理的目标方法最终结束后执行(盖棺定论 )
环绕通知:使用try...catch...finally结构围绕整个被代理的目标方法,包括上面四种通知对应的所有位置
3-连接点 joinpoint
这也是一个纯逻辑概念,不是语法定义的。
指那些被拦截到的点。在 Spring 中,可以被动态代理拦截目标类的方法
4-切入点 pointcut
定位连接点的方式,或者可以理解成被选中的连接点!
是一个表达式,比如execution(*
com.spring.service.impl.. (..))。符合条件的每个方法都是一个具体的连接点。
5-切面 aspect
切入点和通知的结合。是一个类。
6-目标 target
被代理的目标对象。
7-代理 proxy
向目标对象应用通知之后创建的代理对象。
8-织入 weave
指把通知应用到目标上,生成代理对象的过程。可以在编译期织入,也可以在运行期织入,Spring采用后者。
以下图可以帮助理解aop的名词
4.4 Spring
AOP基于注解方式实现和细节
4.4.1 Spring AOP底层技术组成
动态代理(InvocationHandler):JDK原生的实现方式,需要被代理的目标类必须实现接口。因为这个技术要求代理对象和目标对象实现同样的接口(兄弟两个拜把子模式)。
cglib:通过继承被代理的目标类(认干爹模式)实现代理,所以不需要目标类实现接口。
AspectJ:早期的AOP实现的框架,SpringAOP借用了AspectJ中的AOP注解。
4.4.2 初步实现
1.加入依赖
1 2 3 4 5 6 7 8 9 10 11 12 <dependency > <groupId > org.springframework</groupId > <artifactId > spring-aop</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-aspects</artifactId > <version > 6.0.6</version > </dependency >
2.准备接口
1 2 3 4 5 6 7 8 9 10 11 public interface Calculator { int add (int i, int j) ; int sub (int i, int j) ; int mul (int i, int j) ; int div (int i, int j) ; }
3.纯净实现类
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 package com.atguigu.proxy;@Component public class CalculatorPureImpl implements Calculator { @Override public int add (int i, int j) { int result = i + j; return result; } @Override public int sub (int i, int j) { int result = i - j; return result; } @Override public int mul (int i, int j) { int result = i * j; return result; } @Override public int div (int i, int j) { int result = i / j; return result; } }
4.声明切面类
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 package com.atguigu.advice;import org.aspectj.lang.annotation.*;import org.springframework.stereotype.Component;@Aspect @Component public class LogAspect { @Before(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogBeforeCore () { System.out.println("[AOP前置通知] 方法开始了" ); } @AfterReturning(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogAfterSuccess () { System.out.println("[AOP返回通知] 方法成功返回了" ); } @AfterThrowing(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogAfterException () { System.out.println("[AOP异常通知] 方法抛异常了" ); } @After(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogFinallyEnd () { System.out.println("[AOP后置通知] 方法最终结束了" ); } }
5.开启aspectj注解支持
(1)xml方式
1 2 3 4 5 6 7 8 9 10 11 12 <?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: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 https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd" > <context:component-scan base-package ="com.atguigu" /> <aop:aspectj-autoproxy /> </beans >
(2)配置类方式
1 2 3 4 5 6 7 @Configuration @ComponentScan(basePackages = "com.atguigu") @EnableAspectJAutoProxy public class MyConfig {}
6.测试效果
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @SpringJUnitConfig(value = {MyConfig.class}) public class AopTest { @Autowired private Calculator calculator; @Test public void testCalculator () { calculator.add(1 ,1 ); } }
输出结果:
1 2 3 [AOP前置通知] 方法开始了 [AOP返回通知] 方法成功返回了 [AOP后置通知] 方法最终结束了
4.4.3 获取通知细节信息
1.JointPoint接口
需要获取方法签名、传入的实参等信息时,可以在通知方法声明JoinPoint类型的形参。
要点1:JoinPoint 接口通过 getSignature()
方法获取目标方法的签名(方法声明时的完整信息)
要点2:通过目标方法签名对象获取方法名
要点3:通过 JoinPoint
对象获取外界调用目标方法时传入的实参列表组成的数组
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 @Before(value = "execution(public int com.atguigu.aop.api.Calculator.add(int,int))") public void printLogBeforeCore (JoinPoint joinPoint) { Signature signature = joinPoint.getSignature(); String methodName = signature.getName(); System.out.println("methodName = " + methodName); int modifiers = signature.getModifiers(); System.out.println("modifiers = " + modifiers); String declaringTypeName = signature.getDeclaringTypeName(); System.out.println("declaringTypeName = " + declaringTypeName); Object[] args = joinPoint.getArgs(); List<Object> argList = Arrays.asList(args); System.out.println("[AOP前置通知] " + methodName + "方法开始了,参数列表:" + argList); }
2.方法返回值
在返回通知中,通过@AfterReturning 注解的returning属性获取目标方法的返回值!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 @AfterReturning( value = "execution(public int com.atguigu.aop.api.Calculator.add(int,int))", returning = "targetMethodReturnValue" ) public void printLogAfterCoreSuccess (JoinPoint joinPoint, Object targetMethodReturnValue) { String methodName = joinPoint.getSignature().getName(); System.out.println("[AOP返回通知] " +methodName+"方法成功结束了,返回值是:" + targetMethodReturnValue); }
3.异常对象捕捉
在异常通知中,通过@AfterThrowing注解的throwing属性获取目标方法抛出的异常对象
1 2 3 4 5 6 7 8 9 10 11 12 13 14 @AfterThrowing( value = "execution(public int com.atguigu.aop.api.Calculator.add(int,int))", throwing = "targetMethodException" ) public void printLogAfterCoreException (JoinPoint joinPoint, Throwable targetMethodException) { String methodName = joinPoint.getSignature().getName(); System.out.println("[AOP异常通知] " +methodName+"方法抛异常了,异常类型是:" + targetMethodException.getClass().getName()); }
4.4.4 切点表达式语法
1.切点表达式作用
AOP切点表达式(Pointcut
Expression)是一种用于指定切点的语言,它可以通过定义匹配规则,来选择需要被切入的目标对象。
2.切点表达式语法
切点表达式总结
语法细节
第一位:execution( ) 固定开头
第二位:方法访问修饰符
1 public private 直接描述对应修饰符即可
1 int String void 直接描述返回值类型
注意:
特殊情况 不考虑 访问修饰符和返回值
execution(* * ) 这是错误语法
execution(*) == 你只要考虑返回值 或者 不考虑访问修饰符
相当于全部不考虑了
1 2 3 4 5 固定的包: com.atguigu.api | service | dao 单层的任意命名: com.atguigu.* = com.atguigu.api com.atguigu.dao * = 任意一层的任意命名 任意层任意命名: com.. = com.atguigu.api.erdaye com.a.a.a.a.a.a.a ..任意层,任意命名 用在包上! 注意: ..不能用作包开头 public int .. 错误语法 com.. 找到任何包下: *..
1 2 3 4 5 固定名称: UserService 任意类名: * 部分任意: com..service.impl.*Impl 任意包任意类: *..*
1 2 语法和类名一致 任意访问修饰符,任意类的任意方法: * *..*.*
1 2 3 4 5 6 7 8 方法的参数描述 具体值: (String,int ) != (int ,String) 没有参数 () 模糊值: 任意参数 有 或者 没有 (..) ..任意参数的意识 部分具体和模糊: 第一个参数是字符串的方法 (String..) 最后一个参数是字符串 (..String) 字符串开头,int 结尾 (String..int ) 包含int 类型(..int ..)
总结:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
3.切点表达式案例
4.4.5 重用(提取)切点表达式
1.重用切点表达式优点
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 @Before(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogBeforeCore () { System.out.println("[AOP前置通知] 方法开始了" ); } @AfterReturning(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogAfterSuccess () { System.out.println("[AOP返回通知] 方法成功返回了" ); } @AfterThrowing(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogAfterException () { System.out.println("[AOP异常通知] 方法抛异常了" ); } @After(value = "execution(public int com.atguigu.proxy.CalculatorPureImpl.add(int,int))") public void printLogFinallyEnd () { System.out.println("[AOP后置通知] 方法最终结束了" ); }
上面案例,是我们之前编写切点表达式的方式,发现,
所有增强方法的切点表达式相同!
出现了冗余,如果需要切换也不方便统一维护!
我们可以将切点提取,在增强上进行引用即可!
2.同一类内部引用
提取
1 2 3 @Pointcut("execution(public int com.atguigu.aop.api.Calculator.add(int,int))) ") public void declarPointCut() {}
注意:提取切点注解使用@Pointcut(切点表达式) ,
需要添加到一个无参数无返回值方法上即可!
引用
1 2 @Before(value = "declarPointCut()") public void printLogBeforeCoreOperation (JoinPoint joinPoint) {
3.不同类中引用
不同类在引用切点,只需要添加类的全限定符+方法名即可!
1 2 @Before(value = "com.atguigu.spring.aop.aspect.LogAspect.declarPointCut()") public Object roundAdvice (ProceedingJoinPoint joinPoint) {
4.切点统一管理
建议:将切点表达式统一存储到一个类中进行集中管理和维护!
1 2 3 4 5 6 7 8 9 10 11 12 @Component public class AtguiguPointCut { @Pointcut(value = "execution(public int *..Calculator.sub(int,int))") public void atguiguGlobalPointCut () {} @Pointcut(value = "execution(public int *..Calculator.add(int,int))") public void atguiguSecondPointCut () {} @Pointcut(value = "execution(* *..*Service.*(..))") public void transactionPointCut () {} }
4.4.6 环绕通知
环绕通知对应整个 try...catch...finally
结构,包括前面四种通知的所有功能。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 @Around(value = "com.atguigu.aop.aspect.AtguiguPointCut.transactionPointCut()") public Object manageTransaction ( // 通过在通知方法形参位置声明ProceedingJoinPoint类型的形参, // Spring会将这个类型的对象传给我们 ProceedingJoinPoint joinPoint) { Object[] args = joinPoint.getArgs(); Signature signature = joinPoint.getSignature(); String methodName = signature.getName(); Object targetMethodReturnValue = null ; try { log.debug("[AOP 环绕通知] 开启事务,方法名:" + methodName + ",参数列表:" + Arrays.asList(args)); targetMethodReturnValue = joinPoint.proceed(args); log.debug("[AOP 环绕通知] 提交事务,方法名:" + methodName + ",方法返回值:" + targetMethodReturnValue); }catch (Throwable e){ log.debug("[AOP 环绕通知] 回滚事务,方法名:" + methodName + ",异常:" + e.getClass().getName()); }finally { log.debug("[AOP 环绕通知] 释放数据库连接,方法名:" + methodName); } return targetMethodReturnValue; }
4.4.7 切面优先级设置
相同目标方法上同时存在多个切面时,切面的优先级控制切面的内外嵌套顺序。
使用 @Order
注解可以控制切面的优先级:
@Order (较小的数):优先级高
@Order (较大的数):优先级低
实际意义
实际开发时,如果有多个切面嵌套的情况,要慎重考虑。例如:如果事务切面优先级高,那么在缓存中命中数据的情况下,事务切面的操作都浪费了。
此时应该将缓存切面的优先级提高,在事务操作之前先检查缓存中是否存在目标数据。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 @Order(10) ... System.out.println("开启事务" ); System.out.println("事务回滚" ); ... ... @Order(20) ... System.out.println("方法开始了" ); System.out.println("方法结束了" );
4.4.8 CGLib动态代理生效
在目标类没有实现任何接口的情况下,Spring会自动使用cglib技术实现代理。为了证明这一点,我们做下面的测试:
1 2 3 4 5 6 7 @Service public class EmployeeService { public void getEmpList () { System.out.print("方法内部 com.atguigu.aop.imp.EmployeeService.getEmpList" ); } }
测试:
1 2 3 4 5 6 7 @Autowired private EmployeeService employeeService;@Test public void testNoInterfaceProxy () { employeeService.getEmpList(); }
没有接口:
有接口:
使用总结:
如果目标类有接口,选择使用jdk动态代理
如果目标类没有接口,选择cglib动态代理
如果有接口,接口接值
如果没有接口,类进行接值
4.4.9 注解实现小结
4.5 Spring
AOP基于XML方式实现(了解)
1.准备工作
加入依赖
和基于注解的 AOP 时一样。
准备代码
把测试基于注解功能时的Java类复制到新module中,去除所有注解。
2.配置Spring配置文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 <bean id ="calculatorPure" class ="com.atguigu.aop.imp.CalculatorPureImpl" /> <bean id ="logAspect" class ="com.atguigu.aop.aspect.LogAspect" /> <aop:config > <aop:pointcut id ="logPointCut" expression ="execution(* *..*.*(..))" /> <aop:aspect ref ="logAspect" > <aop:before method ="printLogBeforeCore" pointcut-ref ="logPointCut" /> <aop:after-returning method ="printLogAfterCoreSuccess" pointcut-ref ="logPointCut" returning ="targetMethodReturnValue" /> <aop:after-throwing method ="printLogAfterCoreException" pointcut-ref ="logPointCut" throwing ="targetMethodException" /> <aop:after method ="printLogCoreFinallyEnd" pointcut-ref ="logPointCut" /> </aop:aspect > </aop:config >
3.测试
1 2 3 4 5 6 7 8 9 10 11 12 @SpringJUnitConfig(locations = "classpath:spring-aop.xml") public class AopTest { @Autowired private Calculator calculator; @Test public void testCalculator () { System.out.println(calculator); calculator.add(1 ,1 ); } }
4.6 Spring
AOP对获取Bean的影响理解
#### 4.6.1 根据类型装配 bean
1.情景一
bean 对应的类没有实现任何接口
根据 bean 本身的类型获取 bean
2.情景二
bean 对应的类实现了接口,这个接口也只有这一个实现类
测试:根据接口类型获取 bean
测试:根据类获取 bean
结论:上面两种情况其实都能够正常获取到 bean,而且是同一个对象
3.情景三
声明一个接口
接口有多个实现类
接口所有实现类都放入 IOC 容器
4.情景四
声明一个接口
接口有一个实现类
创建一个切面类,对上面接口的实现类应用通知
测试:根据接口类型获取bean
正常
测试:根据类获取bean
无法获取
原因分析:
5.情景五
声明一个类
创建一个切面类,对上面的类应用通知
debug查看实际类型:
4.6.2 使用总结
对实现了接口的类应用切面
对没实现接口的类应用切面new
如果使用AOP技术,目标类有接口,必须使用接口类型接收IoC容器中代理组件!
五、Spring声明式事务
5.1 声明式事务概念
#### 5.1.1 编程式事务
编程式事务是指手动编写程序来管理事务,即通过编写代码的方式直接控制事务的提交和回滚。在
Java 中,通常使用事务管理器(如 Spring 中的
PlatformTransactionManager
)来实现编程式事务。
编程式事务的主要优点是灵活性高,可以按照自己的需求来控制事务的粒度、模式等等。但是,编写大量的事务控制代码容易出现问题,对代码的可读性和可维护性有一定影响。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 Connection conn = ...; try { conn.setAutoCommit(false ); conn.commit(); }catch (Exception e){ conn.rollBack(); }finally { conn.close(); }
编程式的实现方式存在缺陷:
细节没有被屏蔽:具体操作过程中,所有细节都需要程序员自己来完成,比较繁琐。
代码复用性不高:如果没有有效抽取出来,每次实现功能都需要自己编写代码,代码就没有得到复用。
5.1.2 声明式事务
声明式事务是指使用注解或 XML 配置的方式来控制事务的提交和回滚。
开发者只需要添加配置即可,
具体事务的实现由第三方框架实现,避免我们直接进行事务操作!
使用声明式事务可以将事务的控制和业务逻辑分离开来,提高代码的可读性和可维护性。
区别:
编程式事务需要手动编写代码来管理事务
而声明式事务可以通过配置文件或注解来控制事务。
5.1.3 Spring事务管理器
1.Spring声明式事务对应依赖
spring-tx:
包含声明式事务实现的基本规范(事务管理器规范接口和事务增强等等)
spring-jdbc:
包含DataSource方式事务管理器实现类DataSourceTransactionManager
spring-orm:
包含其他持久层框架的事务管理器实现类例如:Hibernate/Jpa等
2.Spring声明式事务对应事务管理器接口
我们现在要使用的事务管理器是org.springframework.jdbc.datasource.DataSourceTransactionManager,将来整合
JDBC方式、JdbcTemplate方式、Mybatis方式的事务实现!
DataSourceTransactionManager类中的主要方法:
doBegin():开启事务
doSuspend():挂起事务
doResume():恢复挂起的事务
doCommit():提交事务
doRollback():回滚事务
5.2 基于注解的声明式事务
5.2.1 准备工作
1.准备项目
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 <dependencies > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-context</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.junit.jupiter</groupId > <artifactId > junit-jupiter-api</artifactId > <version > 5.3.1</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-test</artifactId > <version > 6.0.6</version > <scope > test</scope > </dependency > <dependency > <groupId > jakarta.annotation</groupId > <artifactId > jakarta.annotation-api</artifactId > <version > 2.1.1</version > </dependency > <dependency > <groupId > mysql</groupId > <artifactId > mysql-connector-java</artifactId > <version > 8.0.25</version > </dependency > <dependency > <groupId > com.alibaba</groupId > <artifactId > druid</artifactId > <version > 1.2.8</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-jdbc</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-tx</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-aop</artifactId > <version > 6.0.6</version > </dependency > <dependency > <groupId > org.springframework</groupId > <artifactId > spring-aspects</artifactId > <version > 6.0.6</version > </dependency > </dependencies >
2.外部配置文件
jdbc.properties
1 2 3 4 atguigu.url=jdbc:mysql://localhost:3306/studb atguigu.driver=com.mysql.cj.jdbc.Driver atguigu.username=root atguigu.password=root
3.spring配置文件
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 @Configuration @ComponentScan("com.atguigu") @PropertySource("classpath:jdbc.properties") public class JavaConfig { @Value("${atguigu.driver}") private String driver; @Value("${atguigu.url}") private String url; @Value("${atguigu.username}") private String username; @Value("${atguigu.password}") private String password; @Bean public DataSource dataSource () { DruidDataSource dataSource = new DruidDataSource (); dataSource.setDriverClassName(driver); dataSource.setUrl(url); dataSource.setUsername(username); dataSource.setPassword(password); return dataSource; } @Bean public JdbcTemplate jdbcTemplate (DataSource dataSource) { JdbcTemplate jdbcTemplate = new JdbcTemplate (); jdbcTemplate.setDataSource(dataSource); return jdbcTemplate; } }
4.准备dao/service层
dao
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 @Repository public class StudentDao { @Autowired private JdbcTemplate jdbcTemplate; public void updateNameById (String name,Integer id) { String sql = "update students set name = ? where id = ? ;" ; int rows = jdbcTemplate.update(sql, name, id); } public void updateAgeById (Integer age,Integer id) { String sql = "update students set age = ? where id = ? ;" ; jdbcTemplate.update(sql,age,id); } }
service
1 2 3 4 5 6 7 8 9 10 11 12 13 @Service public class StudentService { @Autowired private StudentDao studentDao; public void changeInfo () { studentDao.updateAgeById(100 ,1 ); System.out.println("-----------" ); studentDao.updateNameById("test1" ,1 ); } }
5.测试环境搭建
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 @SpringJUnitConfig(JavaConfig.class) public class TxTest { @Autowired private StudentService studentService; @Test public void testTx () { studentService.changeInfo(); } }
5.2.2 基本事务控制
1.配置事务管理器
数据库相关的配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 @Configuration @ComponenScan("com.atguigu") @PropertySource(value = "classpath:jdbc.properties") @EnableTransactionManagement public class DataSourceConfig { @Bean public DataSource dataSource (@Value("${atguigu.url}") String url, @Value("${atguigu.driver}") String driver, @Value("${atguigu.username}") String username, @Value("${atguigu.password}") String password) { DruidDataSource dataSource = new DruidDataSource (); dataSource.setDriverClassName(driver); dataSource.setUrl(url); dataSource.setUsername(username); dataSource.setPassword(password); return dataSource; } @Bean public JdbcTemplate jdbcTemplate (DataSource dataSource) { JdbcTemplate jdbcTemplate = new JdbcTemplate (); jdbcTemplate.setDataSource(dataSource); return jdbcTemplate; } @Bean public TransactionManager transactionManager (DataSource dataSource) { return new DataSourceTransactionManager (dataSource); } }
2.使用声明事务注解@Transactional
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 @Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional public void changeInfo () { studentDao.updateAgeById(100 ,1 ); System.out.println("-----------" ); int i = 1 /0 ; studentDao.updateNameById("test1" ,1 ); } }
3.测试事务效果
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 @SpringJUnitConfig(classes = DataSourceConfig.class) public class TxTest { @Autowired private StudentService studentService; @Test public void testTx () { studentService.changeInfo(); } }
5.2.3 事务属性:只读
1.只读介绍
对一个查询操作来说,如果我们把它设置成只读,就能够明确告诉数据库,这个操作不涉及写操作。这样数据库就能够针对查询操作来进行优化。
2.设置方式
1 2 @Transactional(readOnly = true)
3.针对DML动作设置只读模式
会抛出下面异常:
Caused by: java.sql.SQLException: Connection is read-only. Queries
leading to data modification are not allowed
4.@Transactional注解放在类上
生效原则
如果一个类中每一个方法上都使用了 @Transactional 注解,那么就可以将
@Transactional
注解提取到类上。反过来说:@Transactional
注解在类级别标记,会影响到类中的每一个方法。同时,类级别标记的 @Transactional
注解中设置的事务属性也会延续影响到方法执行时的事务属性。除非在方法上又设置了
@Transactional
注解。
对一个方法来说,离它最近的 @Transactional
注解中的事务属性设置生效。
用法举例
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 @Service @Transactional(readOnly = true) public class EmpService { @Transactional(readOnly = false) public void updateTwice (……) { …… } public String getEmpName (Integer empId) { …… } }
5.2.4 事务属性:超时时间
1.需求
事务在执行过程中,有可能因为遇到某些问题,导致程序卡住,从而长时间占用数据库资源。而长时间占用资源,大概率是因为程序运行出现了问题(可能是Java程序或MySQL数据库或网络连接等等)。
此时这个很可能出问题的程序应该被回滚,撤销它已做的操作,事务结束,把资源让出来,让其他正常程序可以执行。
概括来说就是一句话:超时回滚,释放资源。
2.设置超时时间
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 @Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional(readOnly = false,timeout = 3) public void changeInfo () { studentDao.updateAgeById(100 ,1 ); try { Thread.sleep(4000 ); } catch (InterruptedException e) { throw new RuntimeException (e); } studentDao.updateNameById("test1" ,1 ); } }
3.测试超时效果
执行抛出事务超时异常
1 2 3 4 5 6 7 8 org.springframework.transaction.TransactionTimedOutException: Transaction timed out: deadline was Wed May 24 09:10 :43 IRKT 2023 at org.springframework.transaction.support.ResourceHolderSupport.checkTransactionTimeout(ResourceHolderSupport.java:155 ) at org.springframework.transaction.support.ResourceHolderSupport.getTimeToLiveInMillis(ResourceHolderSupport.java:144 ) at org.springframework.transaction.support.ResourceHolderSupport.getTimeToLiveInSeconds(ResourceHolderSupport.java:128 ) at org.springframework.jdbc.datasource.DataSourceUtils.applyTimeout(DataSourceUtils.java:341 ) at org.springframework.jdbc.core.JdbcTemplate.applyStatementSettings(JdbcTemplate.java:1467 )
5.2.5 事务属性:事务异常
Java中异常类的组织结构
由以上结构可知,rollbackfor=Exception.class即可把所有异常都包括进来
1.默认情况
默认只针对运行时异常回滚,编译时异常不回滚。情景模拟代码如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 @Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional(readOnly = false,timeout = 3) public void changeInfo () throws FileNotFoundException { studentDao.updateAgeById(100 ,1 ); new FileInputStream ("xxxx" ); studentDao.updateNameById("test1" ,1 ); } }
2.设置回滚异常
rollbackFor属性:指定哪些异常类才会回滚,默认是 RuntimeException and
Error 异常方可回滚!
1 2 3 4 5 6 7 8 9 10 11 12 @Transactional(readOnly = false,timeout = 3,rollbackFor = Exception.class) public void changeInfo () throws FileNotFoundException { studentDao.updateAgeById(100 ,1 ); new FileInputStream ("xxxx" ); studentDao.updateNameById("test1" ,1 ); }
3.设置不回滚的异常
在默认设置和已有设置的基础上,再指定一个异常类型,碰到它不回滚。
noRollbackFor属性:指定哪些异常不会回滚,
默认没有指定,如果指定,应该在rollbackFor的范围内!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 @Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional(readOnly = false,timeout = 3,rollbackFor = Exception.class,noRollbackFor = FileNotFoundException.class) public void changeInfo () throws FileNotFoundException { studentDao.updateAgeById(100 ,1 ); new FileInputStream ("xxxx" ); studentDao.updateNameById("test1" ,1 ); } }
5.2.6 事务属性:事务隔离级别
1.事务隔离级别
问题:
脏读:A事务正在修改数据但未提交,此时B事务去读取此条数据,B事务读取的是未提交的数据,A事务回滚。
不可重复读:A事务中两次查询同一数据的内容不同,B事务间在A事务两次读取之间更改了此条数据。
幻读:事务 A 根据条件查询得到了 N 条数据,但此时事务 B
删除或者增加了 M 条符合事务 A 查询条件的数据,这样当事务 A
再次进行查询的时候真实的数据集已经发生了变化,但是A却查询不出来这种变化,因此产生了幻读。
数据库事务的隔离级别是指在多个事务并发执行时,数据库系统为了保证数据一致性所遵循的规定。常见的隔离级别包括:
读未提交(Read
Uncommitted):事务可以读取未被提交的数据,容易产生脏读、不可重复读和幻读等问题。实现简单但不太安全,一般不用。
读已提交(Read
Committed):事务只能读取已经提交的数据,可以避免脏读问题,但可能引发不可重复读和幻读。
可重复读(Repeatable
Read):在一个事务中,相同的查询将返回相同的结果集,不管其他事务对数据做了什么修改。可以避免脏读和不可重复读,但仍有幻读的问题。
串行化(Serializable):最高的隔离级别,完全禁止了并发,只允许一个事务执行完毕之后才能执行另一个事务。可以避免以上所有问题,但效率较低,不适用于高并发场景。
不同的隔离级别适用于不同的场景,需要根据实际业务需求进行选择和调整。
2.事务隔离级别设置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 package com.atguigu.service;import com.atguigu.dao.StudentDao;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;import org.springframework.transaction.annotation.Isolation;import org.springframework.transaction.annotation.Transactional;import java.io.FileInputStream;import java.io.FileNotFoundException;@Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional(readOnly = false, timeout = 3, rollbackFor = Exception.class, noRollbackFor = FileNotFoundException.class, isolation = Isolation.REPEATABLE_READ) public void changeInfo () throws FileNotFoundException { studentDao.updateAgeById(100 ,1 ); new FileInputStream ("xxxx" ); studentDao.updateNameById("test1" ,1 ); } }
5.2.7 事务属性:事务传播行为
1.事务传播行为要研究的问题
举例代码:
1 2 3 4 5 6 7 8 9 10 11 12 13 @Transactional public void MethodA () { MethodB(); } @Transactional(propagation = Propagation.REQUIRES_NEW) public void MethodB () { }
2.propagation属性
@Transactional 注解通过 propagation
属性设置事务的传播行为。它的默认值是:
1 Propagation propagation () default Propagation.REQUIRED;
propagation 属性的可选值由
org.springframework.transaction.annotation.Propagation 枚举类提供:
REQUIRED 默认值
如果父方法有事务,就加入,如果没有就新建自己独立!
REQUIRES_NEW
不管父方法是否有事务,我都新建事务,都是独立的!
3.测试
a.声明两个业务方法
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 @Transactional(timeout = 3) @Service public class StudentService { @Autowired private StudentDao studentDao; @Transactional(readOnly = false, rollbackFor = Exception.class, noRollbackFor = FileNotFoundException.class, isolation = Isolation.READ_COMMITTED) public void changeInfo () throws FileNotFoundException { studentDao.updateAgeById(98 ,1 ); new FileInputStream ("xxxx" ); studentDao.updateNameById("test3" ,1 ); } @Transactional(readOnly = true) public void getStudentInfo () { } @Transactional(propagation = Propagation.REQUIRES_NEW) public void changeAge () { studentDao.updateAgeById(998 , 1 ); } @Transactional(propagation = Propagation.REQUIRES_NEW) public void changeName () { studentDao.updateNameById("张三" , 1 ); int i = 1 /0 ; } }
b.声明一个整合业务方法
1 2 3 4 5 6 7 8 9 10 11 12 @Service public class TopService { @Autowired private StudentService studentService; @Transactional public void topService () { studentService.changeAge(); studentService.changeName(); } }
c.添加传播行为测试
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 @SpringJUnitConfig(classes = AppConfig.class) public class TxTest { @Autowired private StudentService studentService; @Autowired private TopService topService; @Test public void testTx () throws FileNotFoundException { topService.topService(); } }
注意:
在同一个类中,对于@Transactional注解的方法调用,事务传播行为不会生效。这是因为Spring框架中使用代理模式实现了事务机制,在同一个类中的方法调用并不经过代理,而是通过对象的方法调用,因此@Transactional注解的设置不会被代理捕获,也就不会产生任何事务传播行为的效果。
4.其他传播行为值(了解)
Propagation.REQUIRED:如果当前存在事务,则加入当前事务,否则创建一个新事务。
Propagation.REQUIRES_NEW:创建一个新事务,并在新事务中执行。如果当前存在事务,则挂起当前事务,即使新事务抛出异常,也不会影响当前事务。
Propagation.NESTED:如果当前存在事务,则在该事务中嵌套一个新事务,如果没有事务,则与Propagation.REQUIRED一样。
Propagation.SUPPORTS:如果当前存在事务,则加入该事务,否则以非事务方式执行。
Propagation.NOT_SUPPORTED:以非事务方式执行,如果当前存在事务,挂起该事务。
Propagation.MANDATORY:必须在一个已有的事务中执行,否则抛出异常。
Propagation.NEVER:必须在没有事务的情况下执行,否则抛出异常。
六、Spring核心掌握总结
核心点
掌握目标
spring框架理解
spring家族和spring framework框架
spring核心功能
ioc/di , aop , tx
spring ioc / di
组件管理、ioc容器、ioc/di , 三种配置方式
spring aop
aop和aop框架和代理技术、基于注解的aop配置
spring tx
声明式和编程式事务、动态事务管理器、事务注解、属性