【Spring源码分析】搭建最基本Spring项目及源码入口

前言

最近想阅读下Spring源码。作为预备篇，先搭建一个最简单的Spring项目样例对Spring的使用进行基本梳理。

以后就用博客记录下学习过程。如有问题欢迎指出 不胜感谢。

构建一个最简单的spring项目

Spring中最核心的Jar包有四个：spring-beans、spring-context、spring-core、spring-expression。

以前做spring项目有个误区，什么包都一个个导入进来，其实一个最最简单的Spring项目，理论上就需要引入一个jar包spring-context就够了，靠它的依赖关系，其他核心包都会自动导入进来（只是核心包，实际真实项目需要其他功能再额外导入）。

1、在一个空项目里 添加Spring项目模块       Maven->jdk1.8>webapp 模板

2、这里在pom中只额外添加 spring-context依赖（它依赖其他几个核心jar包 会自动导入依赖）

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>

    <spring.version>5.1.3.RELEASE</spring.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
    </dependency>

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>${spring.version}</version>
    </dependency>

    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>LATEST</version>
    </dependency>

  </dependencies>

 实际引入的包及依赖关系：

 

package cn.eport.jason.bean;
 
@Component
public class Student {
 
    private String username = "WPC";
 
    private String password;
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public String getPassword() {
        return password;
    }
 
    public void setPassword(String password) {
        this.password = password;
    }
}

这样，一个最简单的spring demo就完成了。

写一个测试方法，(因为本例中是在源代码下编写的单元测试，所以需要先在pom中去掉Junit 作用域为test的限制,不然在业务代码区使用@Test注解时会提示找不到)

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <!--<scope>test</scope>-->
</dependency>

 MyTest.java 测试类

package cn.eport.jason.test;

import cn.eport.jason.bean.Student;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class MyTest {

    @Test
    public void Test1(){
        //基于注解的方式加载Spring容器
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext("cn.eport");

        Student student =(Student) applicationContext.getBean("student");
        System.out.println(student.getUsername());
    }
}

 运行单元测试方法Test1 控制台输出结果：

D:\DevTool\Java\jdk1.8.0_101\bin\java.exe ... cn.eport.jason.test.MyTest,Test1
WPC

Process finished with exit code 0

 说明Spring ioc容器功能已生效，已属于spring项目。

程序入口

Spring容器启动的入口即可以看做Spring源码的入口，我们先看下Spring容器的几种启动方式。

Spring容器启动的4种方式

上例中使用的是使用注解的方式加载的Spring容器，其实spring还有其他几种加载容器的方式：

• 1、类路径获取配置文件加载容器

　　ApplicationContext applicationContext= new ClassPathXmlApplicationContext("spring.xml"); 

• 2、文件系统路径获取配置文件【绝对路径】不常用 

　　ApplicationContext applicationContext = new FileSystemXmlApplicationContext("E:\\idea\\public\\springdemo\\src\\main\\resources\\spring.xml");  

• 3、无配置文件加载容器（注解方式） 单元测试中常用

　　ApplicationContext applicationContext = new AnnotationConfigApplicationContext("cn.eport"); 

• 4、springboot加载容器方式

　　ApplicationContext applicationContext = new EmbeddedWebApplicationContext();

Spring容器启动的入口可以作为Spring的源码分析的入口，上述四种方式中，除了基于注解的方式外，之前比较常用的就是读取类路径下配置文件加载容器了（SpringBoot出现之后，这种方式慢慢过时），我们来使用这种方式做下测试：

 1、新建配置文件：idea下 在resources目录下右击new->XML Configuration File->springconfig 创建Spring.xml 配置文件,并添加注册bean配置（两种方式 包扫描或者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"
       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 
　　　　　　　　　　http://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 方式1、批量注册  包扫描+注解  -->
    <context:component-scan base-package="cn.eport"/>

    <!-- 方式2、手动注册bean 。 id不写 默认为类全限定名--> 
    <bean class="cn.eport.jason.bean.Student"> 
    </bean> 
</beans>

这里通过两种方式注册了Student实例：

• 一个ComonentScan扫描+注解的方式（BeanName默认类名小写）
• 一个配置注册bean的方式（默认BeanName为类全限定名）

ps:<context:component-scan>这种带有前缀的标签 为自定义标签,spring原始组件只有 spring-core和spring-bean ，常用的context、aop、tx组件其实都是扩展组件，Spring靠的就是自定义标签在核心组件上扩展使得spring更加强大，在配置文件中使用扩展标签需要引入相应的xsd；在标签对应的jar包下面找到对应的spring.schemas，在这个文件中就会有对应的XSD路径和命名空间xmlns（xml namespaceUri） （类似于java中的Import）

2、编写对应的测试方法 使用 ClassPathXmlApplicationContext 读取配置文件加载容器获取bean对象 进行测试：

@Test
public void Test2(){
     //读取类路径下xml配置文件的方式加载spring容器
     ApplicationContext applicationContext = new ClassPathXmlApplicationContext("Spring.xml");

     Student student1 =(Student) applicationContext.getBean("student");//取得为包扫描+注解 方式注册的 beanId是类名小写
     Student student2 =(Student) applicationContext.getBean("cn.eport.jason.bean.Student");//取得为配置文件中缺省id 的那个bean
     System.out.println(student1.getUsername());//WPC
     System.out.println(student2.getUsername());//WPC

     System.out.println(student1==student2);//false   不同的注册方式注册的两个不同的实例对象
}

 结果：

WPC
WPC
false

Process finished with exit code 0

Spring容器一样也加载成功了，由此可以看出项目中只添加Spring-context 的依赖，一个最基础的Spring的项目即可搭建好（这里说的不是SpringMVC工程）

 根据测试打印结果可以发现个问题，程序并没有打印出Spring的日志，原因为pom中未添加spring日志依赖logback：

<!--一个空的spring工程是不能打印日志的，要导入spring依赖的日志jar-->
<dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>LATEST</version>
</dependency>

 再次执行下测试方法，控制台打印出Spring的日志：

 由此，构建一个带日志的最基础Spring项目，只需要在pom中添加context、logback两个依赖即可

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>${spring.version}</version>
</dependency>
<dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>LATEST</version>
</dependency>

但是实际上由于jar包相互依赖，项目中maven会自动导入其他依赖，实际导入的包远远不止这两个：

实际导入的包及依赖关系如下：

结语

本篇经过演示我们看到pom中只添加context、logback两个依赖就可以搭建一个最基本的spring项目，以及找到了Spring源码的入口，后续进行源码分析~