运行环境
JDK :17
IntelliJ IDEA : 2022.3
Tomcat:9.0.60(内嵌)
手写目标
- 手写模拟SpringBoot启动过程
- 手写模拟SpringBoot条件注解功能
- 手写模拟SpringBoot自动配置功能
项目结构
项目类继承关系
springboot模块:
com.juechen.springboot
:表示springboot框架的源码实现。
META-INF.services
:SPI机制。
user模块:
com.juechen.user.controller
:Controller层业务逻辑代码
com.juechen.user.service
:Service层业务逻辑代码
项目流程
整体SpringBoot启动逻辑是这样的:
- 创建一个
AnnotationConfigWebApplicationContext
容器 - 解析
MyApplication
类,然后进行扫描 - 通过
getWebServer
方法从Spring容器中获取WebServer
类型的Bean - 调用
WebServer
对象的start方法 - 实现SPI机制
pom.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>Handwriting-SpringBoot</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>springboot</module>
<module>user</module>
</modules>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
</project>
springboot的pom.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.example</groupId>
<artifactId>Handwriting-SpringBoot</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>springboot</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.3.18</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>5.3.18</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.3.18</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
</dependency>
<dependency>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-core</artifactId>
<version>9.0.60</version>
</dependency>
</dependencies>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
</project>
user的pom.xml文件
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.example</groupId>
<artifactId>Handwriting-SpringBoot</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>user</artifactId>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.example</groupId>
<artifactId>springboot</artifactId>
<version>1.0-SNAPSHOT</version>
<exclusions>
<exclusion>
<groupId>org.apache.tomcat.embed</groupId>
<artifactId>tomcat-embed-core</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.eclipse.jetty</groupId>
<artifactId>jetty-server</artifactId>
<version>9.4.43.v20210629</version>
</dependency>
</dependencies>
</project>
springboot模块
com.juechen.springboot包:
JuechenSpringApplication
类:实现启动逻辑
package com.juechen.springboot;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import java.util.Map;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: 实现启动逻辑
* @Version: 1.0
**/
public class JuechenSpringApplication {
//在run方法中,我们要实现的逻辑如下:
//1. 创建一个Spring容器
//2. 创建Tomcat对象
//3. 生成DispatcherServlet对象,并且和前面创建出来的Spring容器进行绑定
//4. 将DispatcherServlet添加到Tomcat中
//5. 启动Tomcat
public static void run(Class clazz) {
// 创建一个Spring容器
// Spring容器创建完之后,容器内部就拥有了UserController这个Bean
AnnotationConfigWebApplicationContext applicationContext = new AnnotationConfigWebApplicationContext();
applicationContext.register(clazz);
applicationContext.refresh();
WebServer webServer = getWebServer(applicationContext);
webServer.start();
}
private static WebServer getWebServer(WebApplicationContext applicationContext) {
// 判断到底该返回TomcatWebServer还是JettyWebServer
Map<String, WebServer> beansOfType = applicationContext.getBeansOfType(WebServer.class);
if (beansOfType.isEmpty()) {
throw new NullPointerException();
}
if (beansOfType.size() > 1) {
throw new IllegalStateException();
}
// 返回唯一的一个
return beansOfType.values().stream().findFirst().get();
}
}
我们创建的是一个AnnotationConfigWebApplicationContext
容器,并且把run方法传入进来的class作为容器的配置类,比如在MyApplication
的run方法中,我们就是把MyApplication.class
传入到了run方法中,最终MyApplication
就是所创建出来的Spring容器的配置类,并且由于MyApplication
类上有@JuechenSpringBootApplication
注解,而@JuechenSpringBootApplication
注解的定义上又存在@ComponentScan
注解,所以AnnotationConfigWebApplicationContext
容器在执行refresh时,就会解析MyApplication
这个配置类,从而发现定义了@ComponentScan
注解,也就知道了要进行扫描,只不过扫描路径为空,而AnnotationConfigWebApplicationContext
容器会处理这种情况,如果扫描路径会空,则会将MyApplication
所在的包路径做为扫描路径,从而就会扫描到UserService
和UserController
(user模块)。
JuechenSpringBootApplication
注解:自定义@XxxSpringBootApplication,这个注解是加在应用启动类上的,也就是main方法所在的类
package com.juechen.springboot;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Configuration
@ComponentScan // 扫描路径为:com.juechen.user 不是com.juechen.springboot
@Import(AutoConfigurationImportSelector.class)
public @interface JuechenSpringBootApplication {
}
WebServer接口:实现Tomcat和Jetty切换的接口
package com.juechen.springboot;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: TODO
* @Version: 1.0
**/
public interface WebServer {
public void start();
}
TomcatWebServer类:用的是Embed-Tomcat,也就是内嵌的Tomcat,真正的SpringBoot中也用的是内嵌的Tomcat
package com.juechen.springboot;
import org.apache.catalina.*;
import org.apache.catalina.connector.Connector;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.core.StandardEngine;
import org.apache.catalina.core.StandardHost;
import org.apache.catalina.startup.Tomcat;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: Tomcat
* @Version: 1.0
**/
public class TomcatWebServer implements WebServer{
@Override
public void start() {
System.out.println("启动Tomcat~~~");
}
public static void startTomcat(WebApplicationContext applicationContext){
Tomcat tomcat = new Tomcat();
Server server = tomcat.getServer();
Service service = server.findService("Tomcat");
Connector connector = new Connector();
// 配置了Tomcat绑定的端口为8081
connector.setPort(8081);
Engine engine = new StandardEngine();
engine.setDefaultHost("localhost");
Host host = new StandardHost();
host.setName("localhost");
String contextPath = "";
Context context = new StandardContext();
context.setPath(contextPath);
context.addLifecycleListener(new Tomcat.FixContextListener());
host.addChild(context);
engine.addChild(host);
service.setContainer(engine);
service.addConnector(connector);
// 在构造DispatcherServlet对象时,
// 传入了一个ApplicationContext对象,也就是一个Spring容器
tomcat.addServlet(contextPath, "dispatcher", new DispatcherServlet(applicationContext));
context.addServletMappingDecoded("/*", "dispatcher");
try {
tomcat.start();
} catch (LifecycleException e) {
e.printStackTrace();
}
}
}
JettyWebServer类:
package com.juechen.springboot;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: Jetty
* @Version: 1.0
**/
public class JettyWebServer implements WebServer{
@Override
public void start() {
System.out.println("启动Jetty~~~");
}
}
JuechenConditionalOnClass注解:模拟实现条件注解
package com.juechen.springboot;
import org.springframework.context.annotation.Conditional;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Conditional(JuechenCondition.class)
public @interface JuechenConditionalOnClass {
String value();
}
JuechenCondition
类:条件注解的实现类
package com.juechen.springboot;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;
import java.util.Map;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: 条件注解的实现类
* @Version: 1.0
**/
public class JuechenCondition implements Condition {
/**
* 具体逻辑为,拿到@JuechenConditionalOnClass中的value属性,
* 然后用类加载器进行加载,如果加载到了所指定的这个类,那就表示符合条件,
* 如果加载不到,则表示不符合条件。
* @param context
* @param metadata
* @return
*/
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 从注解元数据中获取JuechenConditionalOnClass注解的属性值
Map<String, Object> annotationAttributes = metadata.getAnnotationAttributes(JuechenConditionalOnClass.class.getName());
// 获取注解中指定的类名
String className = (String) annotationAttributes.get("value");
try {
// 尝试加载指定的类,如果成功则表明类路径上存在该类
context.getClassLoader().loadClass(className);
return true;
} catch (ClassNotFoundException e) {
// 如果类加载失败,则返回false
return false;
}
}
}
有了条件注解,我们就可以来使用它了。
WebServiceAutoConfiguration
类:自动配置类
package com.juechen.springboot;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: 自动配置类
* @Version: 1.0
**/
@Configuration
public class WebServiceAutoConfiguration implements AutoConfiguration{
@Bean
@JuechenConditionalOnClass("org.apache.catalina.startup.Tomcat")
public TomcatWebServer tomcatWebServer(){
return new TomcatWebServer();
}
@Bean
@JuechenConditionalOnClass("org.eclipse.jetty.server.Server")
public JettyWebServer jettyWebServer(){
return new JettyWebServer();
}
}
- 这样,我们就只需要在
getWebServer
方法中去判断到底该返回TomcatWebServer还是JettyWebServer。(JuechenSpringBootApplication中的getWebServer方法)
AutoConfigurationImportSelector类:批量导入
package com.juechen.springboot;
import org.springframework.context.annotation.DeferredImportSelector;
import org.springframework.core.type.AnnotationMetadata;
import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: 批量导入
* @Version: 1.0
**/
public class AutoConfigurationImportSelector implements DeferredImportSelector {
/**
* 从服务加载器中选择并导入所有自动配置类的名称。
*
* @param importingClassMetadata 引入类的元数据,此处未使用但必须存在以符合接口要求。
* @return String[] 包含所有自动配置类名称的数组。
*/
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
// 加载所有AutoConfiguration类型的实现
ServiceLoader<AutoConfiguration> serviceLoader = ServiceLoader.load(AutoConfiguration.class);
List<String> list = new ArrayList<>();
// 遍历加载到的自动配置类,将它们的类名添加到列表中
for (AutoConfiguration autoConfiguration : serviceLoader) {
list.add(autoConfiguration.getClass().getName());
}
// 将类名列表转换为字符串数组并返回
return list.toArray(new String[0]);
}
}
AutoConfiguration类
package com.juechen.springboot;
public interface AutoConfiguration {
}
META-INF
spring.factories文件:
com.juechen.springboot.WebServiceAutoConfiguration
user模块
com.juechen.user包:
MyApplication类:SpringBoot启动类
package com.juechen.user;
import com.juechen.springboot.JuechenSpringApplication;
import com.juechen.springboot.JuechenSpringBootApplication;
import com.juechen.springboot.WebServiceAutoConfiguration;
import org.springframework.context.annotation.Import;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: 启动类
* @Version: 1.0
**/
@JuechenSpringBootApplication
@Import(WebServiceAutoConfiguration.class)
public class MyApplication {
public static void main(String[] args) {
JuechenSpringApplication.run(MyApplication.class);
}
}
com.juechen.user.controller包:
UserController类:
package com.juechen.user.controller;
import com.juechen.user.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: TODO
* @Version: 1.0
**/
@RestController
public class UserController {
@Autowired
private UserService userService;
@GetMapping("test")
public String test(){
return userService.test();
}
}
com.juechen.user.service包:
UserService类:
package com.juechen.user.service;
import org.springframework.stereotype.Component;
/**
* @Author: Juechen
* @Date: 2024/4/28
* @Description: TODO
* @Version: 1.0
**/
@Component
public class UserService {
public String test(){
return "juechen";
}
}
总结
到此,我们实现了一个简单版本的SpringBoot,因为SpringBoot首先是基于Spring的,而且提供的功能也更加强大,希望大家都自己去动手实现一遍,加油!!!