Spring6 - 入门
# 1. 环境要求
JDK:Java17+(Spring6 要求 JDK 最低版本是 Java17)
Maven:3.6+
Spring:6.0.2
# 2. 程序开发
# 2.1 引入依赖
https://Spring.io/projects/Spring-framework#learn (opens new window)
添加依赖:
<dependencies>
<!--Spring context依赖-->
<!--当引入 Spring Context 依赖之后,表示将 Spring 的基础依赖引入了-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>6.1.5</version>
</dependency>
<!--junit5 测试-->
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.3.1</version>
</dependency>
</dependencies>
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
查看依赖:
# 2.2 创建 Java 类
public class HelloWorld {
public void sayHello(){
System.out.println("helloworld");
}
}
2
3
4
5
6
# 2.3 创建Spring配置文件
首先,在项目的resources
目录下创建一个名为Beans.xml
的Spring配置文件。这个文件将包含Spring容器需要管理的所有Bean的声明。配置文件的命名不是固定的,可以根据项目的需求来命名。
<?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
http://www.springframework.org/schema/beans/spring-beans.xsd">
<!-- 配置HelloWorld对应的Bean -->
<bean id="helloWorld" class="com.scholar.spring6.HelloWorld">
<!-- 在此处可以配置Bean的属性 -->
</bean>
</beans>
2
3
4
5
6
7
8
9
10
xmlns
和xsi:schemaLocation
属性指定了Spring Bean配置文件的XML命名空间以及对应的XML Schema定义位置,确保配置文件的语法正确。<bean>
元素用于定义一个Bean,id
属性为Bean指定一个唯一的名称,class
属性指定Bean的全类名。
# 2.4 创建测试类测试
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class HelloWorldTest {
@Test
public void testHelloWorld() {
// 加载Spring配置文件
ApplicationContext ac = new ClassPathXmlApplicationContext("Beans.xml");
// 从容器中获取名为helloWorld的Bean
HelloWorld helloWorld = (HelloWorld) ac.getBean("helloWorld");
// 调用Bean的方法
helloWorld.sayHello();
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
ApplicationContext
是Spring中表示IoC容器的接口,用于管理Bean的生命周期。ClassPathXmlApplicationContext
是ApplicationContext
的一个实现,它从类路径下加载配置文件。getBean("helloWorld")
方法用于从Spring容器中获取指定名称的Bean实例。
# 2.5 运行测试程序
# 3. 程序分析
在Spring框架中,对象的创建是通过反射机制完成的。Spring容器在解析XML配置文件时,会根据配置中指定的类的全类名来创建对象。
# 3.1 底层对象创建分析
首先,通过修改HelloWorld
类,并添加一个自定义的无参构造方法,我们可以验证Spring创建对象时是否调用了无参构造方法。
public class HelloWorld {
public HelloWorld() {
System.out.println("无参数构造方法执行");
}
public void sayHello(){
System.out.println("helloworld");
}
}
2
3
4
5
6
7
8
9
10
执行结果:当Spring框架加载并解析Beans.xml
配置文件,创建HelloWorld
类的对象时,如果输出"无参数构造方法执行",说明确实通过反射机制调用了无参构造方法来创建了对象。
# 3.2 Spring对象创建原理
- 解析XML配置文件:使用如
dom4j
这样的XML解析库来解析Beans.xml
文件,获取到每个<bean>
元素的class
属性值,即类的全类名。 - 通过反射创建对象:根据获取到的类的全类名,使用Java的反射机制来创建对象。这一过程涉及到
Class.forName()
方法来加载类,并通过类的无参构造器创建实例。
public class ObjectCreationExample {
public static void main(String[] args) throws Exception {
// 模拟解析Beans.xml文件获取到的类全名
String className = "com.scholar.spring6.HelloWorld";
// 通过反射机制调用无参数构造方法创建对象
Class<?> clazz = Class.forName(className);
// JDK 9+ 推荐使用getDeclaredConstructor().newInstance()来创建实例
Object object = clazz.getDeclaredConstructor().newInstance();
// 验证对象是否成功创建
if (object instanceof HelloWorld) {
((HelloWorld) object).sayHello();
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
Class.forName(className)
:通过类的全名来加载类,返回Class
对象。getDeclaredConstructor().newInstance()
:获取类的无参构造器并创建实例。这种方式比clazz.newInstance()
更推荐,因为它能显式地调用无参或带参构造器。
# 3.3 Bean对象的存储结构
当Spring容器启动时,它会读取配置信息(无论是XML配置文件还是注解),并将每个Bean的配置信息封装成一个BeanDefinition
对象。BeanDefinition
是一个接口,代表了一个Bean的定义信息,它包含了Bean的类类型、生命周期回调方法、依赖信息等,几乎包含了创建一个Bean所需的所有信息。
这些BeanDefinition
对象被存储在Spring容器的内部数据结构中。在Spring的核心容器实现DefaultListableBeanFactory
中,Bean定义信息存储在一个名为beanDefinitionMap
的Map集合中:
private final Map<String, BeanDefinition> BeanDefinitionMap = new ConcurrentHashMap<>(256);
Spring 容器加载到 Bean 类时 , 会把这个类的描述信息, 以包名加类名的方式存到 BeanDefinitionMap 中。
Map<String, BeanDefinition> BeanDefinitionMap
, 其中 String 是Key,默认是类名首字母小写,BeanDefinition 存的是类的定义(描述信息) , 我们通常叫 BeanDefinition 接口为 Bean 的定义对象
。
BeanDefinition
:是一个接口,代表了Bean的定义,它包含了创建Bean所需的全部信息,让Spring知道如何创建和管理这个Bean。BeanDefinitionMap
:这个Map集合是Spring用来存储所有Bean定义的内部数据结构,确保了Spring容器可以快速访问和管理这些Bean。
Bean对象的管理
当从容器中请求一个Bean时,Spring容器会使用这些BeanDefinition
信息来创建和配置Bean对象。具体步骤:
- 查找
BeanDefinition
:根据请求的Bean名称,在beanDefinitionMap
中查找对应的BeanDefinition
对象。 - Bean实例化:使用
BeanDefinition
中的信息,通过反射等机制创建Bean的实例。 - 依赖注入:根据
BeanDefinition
中的依赖信息,将其他Bean或值注入到创建好的Bean实例中。 - 初始化:如果Bean实现了初始化接口或通过配置指定了初始化方法,容器会调用这些方法来完成Bean的初始化。
- 存储Bean实例:最后,创建和初始化完成的Bean实例会被存储在容器的另一个Map中,以便后续使用。
# 4. 启用 Log4j2 日志框架
# 4.1 Log4j2 日志概述
在项目开发中,日志十分的重要,不管是记录运行情况还是定位线上问题,都离不开对日志的分析。日志记录了系统行为的时间、地点、状态等相关信息,能够帮助我们了解并监控系统状态,在发生错误或者接近某种危险状态时能够及时提醒我们处理,同时在系统产生问题时,能够帮助我们快速的定位、诊断并解决问题。
Apache Log4j2 是一个开源的日志记录组件,使用非常的广泛。在工程中以易用方便代替了 System.out
等打印语句,它是 Java 下最流行的日志输入工具。
Log4j2 主要由几个重要的组件构成:
(1)日志信息的优先级
日志信息的优先级从高到低有 TRACE < DEBUG < INFO < WARN < ERROR < FATAL。
TRACE
:追踪,是最低的日志级别,相当于追踪程序的执行DEBUG
:调试,一般在开发中,都将其设置为最低的日志级别INFO
:信息,输出重要的信息,使用较多WARN
:警告,输出警告的信息ERROR
:错误,输出错误信息FATAL
:严重错误
这些级别分别用来指定这条日志信息的重要程度;级别高的会自动屏蔽级别低的日志,也就是说,设置了 WARN 的日志,则 INFO、DEBUG 的日志级别的日志不会显示
(2)日志信息的输出目的地,日志信息的输出目的地指定了日志将打印到 控制台 还是 文件中;
(3)日志信息的输出格式,而输出格式则控制了日志信息的显示内容。
# 4.2 引入 Log4j2 依赖
<!--log4j2 的依赖-->
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.19.0</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j2-impl</artifactId>
<version>2.19.0</version>
</dependency>
2
3
4
5
6
7
8
9
10
11
# 4.3 加入日志配置文件
在类的根路径(resources
)下提供 log4j2.xml
配置文件(文件名固定为:log4j2.xml,文件必须放到类根路径下)
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<loggers>
<!--
level 指定日志级别,从低到高的优先级:
TRACE < DEBUG < INFO < WARN < ERROR < FATAL
trace:追踪,是最低的日志级别,相当于追踪程序的执行
debug:调试,一般在开发中,都将其设置为最低的日志级别
info:信息,输出重要的信息,使用较多
warn:警告,输出警告的信息
error:错误,输出错误信息
fatal:严重错误
-->
<root level="DEBUG">
<appender-ref ref="Spring6log"/>
<appender-ref ref="RollingFile"/>
<appender-ref ref="log"/>
</root>
</loggers>
<appenders>
<!--输出日志信息到控制台-->
<console name="Spring6log" target="SYSTEM_OUT">
<!--控制日志输出的格式-->
<PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss SSS} [%t] %-3level %logger{1024} - %msg%n"/>
</console>
<!--文件会打印出所有信息,这个 log 每次运行程序会自动清空,由 append 属性决定,适合临时测试用-->
<File name="log" fileName="d:/Spring6_log/test.log" append="false">
<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
</File>
<!-- 这个会打印出所有的信息,
每次大小超过 size,
则这 size 大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,
作为存档-->
<RollingFile name="RollingFile" fileName="d:/Spring6_log/app.log"
filePattern="log/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz">
<PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>
<SizeBasedTriggeringPolicy size="50MB"/>
<!-- DefaultRolloverStrategy 属性如不设置,
则默认为最多同一文件夹下7个文件,这里设置了20 -->
<DefaultRolloverStrategy max="20"/>
</RollingFile>
</appenders>
</configuration>
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
# 4.4 测试
运行原测试程序
运行原测试程序,多了 Spring 打印日志
# 4.5 使用日志
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.junit.jupiter.api.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class HelloWorldTest {
// 创建Logger对象,这里使用SLF4J的LoggerFactory来获取日志记录器,传入当前类,以便于日志中可以输出当前类的信息。
private Logger logger = LoggerFactory.getLogger(HelloWorldTest.class);
@Test
public void testHelloWorld() {
// 加载Spring配置文件,并启动Spring容器
ApplicationContext ac = new ClassPathXmlApplicationContext("Beans.xml");
// 从Spring容器中获取名为"helloWorld"的Bean
HelloWorld helloworld = (HelloWorld) ac.getBean("helloWorld");
// 调用Bean的方法
helloworld.sayHello();
// 使用logger记录信息,这里的日志级别是INFO,意味着这条信息会在配置了INFO及以上级别的日志输出中显示
logger.info("执行成功");
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
我们使用了SLF4J作为日志门面(Facade),这样可以轻松地在项目中切换不同的日志实现(比如从Log4j切换到Logback)而不需要修改源代码。LoggerFactory.getLogger(HelloWorldTest.class)
方法用于获取与HelloWorldTest
类相关联的Logger
实例。
控制台: