starter组件是SpringBoot的一个核心特性,Starter组件的出现极大简化了项目开发,例如在项目中使用的pom.xm文件下配置:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>
SpringBoot就会自动关联web开发相关的依赖,如tomcat以及spring-webmvc等,进而对web开发进行支持,同时相关技术也将实现自动配置,避免了繁琐的配置文件。
Starter组件使开发者不需要关注各种依赖库的处理,不需要具体的配置信息,由SpringBoot自动完成class类发现并加载需要的Bean。
利用starter实现自动化配置需要两个条件:Maven依赖、配置文件,Maven依赖实质上就是导入jar包,SpringBoot启动的时候会找到Starter组件jar包中的
resources/META-INF/spring.factories文件,根据spring.factories文件中的配置,找到需要自动配置的类。
starter组件理解总结:
要实现一个自己的starter组件其实也很简单,要完成一个starter组件的编写,首先要明确,我们要做的事有哪些:
接下来我们就来手写一个starter组件,流程如下:
引入依赖:
<?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>com.gupao.redisson</groupId> <artifactId>redisson-spring-boot-starter</artifactId> <version>1.0-SNAPSHOT</version> <name>redisson-spring-boot-starter</name> <!-- FIXME change it to the project's website --> <url>http://www.example.com</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.11</version> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.3.2.RELEASE</version> <optional>true</optional> </dependency> <dependency> <groupId>org.redisson</groupId> <artifactId>redisson</artifactId> <version>3.16.1</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <version>2.3.2.RELEASE</version> </dependency> </dependencies> <build> <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) --> <plugins> <!-- clean lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#clean_Lifecycle --> <plugin> <artifactId>maven-clean-plugin</artifactId> <version>3.1.0</version> </plugin> <!-- default lifecycle, jar packaging: see https://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging --> <plugin> <artifactId>maven-resources-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-compiler-plugin</artifactId> <version>3.8.0</version> </plugin> <plugin> <artifactId>maven-surefire-plugin</artifactId> <version>2.22.1</version> </plugin> <plugin> <artifactId>maven-jar-plugin</artifactId> <version>3.0.2</version> </plugin> <plugin> <artifactId>maven-install-plugin</artifactId> <version>2.5.2</version> </plugin> <plugin> <artifactId>maven-deploy-plugin</artifactId> <version>2.8.2</version> </plugin> <!-- site lifecycle, see https://maven.apache.org/ref/current/maven-core/lifecycles.html#site_Lifecycle --> <plugin> <artifactId>maven-site-plugin</artifactId> <version>3.7.1</version> </plugin> <plugin> <artifactId>maven-project-info-reports-plugin</artifactId> <version>3.0.0</version> </plugin> </plugins> </pluginManagement> </build></project>
package com.gupao.redisson;/** * @author Eclipse_2019 * @create 2022/6/11 9:58 */public interface Humen { String dancing();}package com.gupao.redisson;import org.redisson.Redisson;import org.redisson.api.RedissonClient;import org.redisson.config.Config;import org.springframework.util.StringUtils;import java.util.Properties;/** * @author Eclipse_2019 * @create 2022/1/14 22:55 */public class Girl implements Humen{ public static Girl create(String name){ return new Girl(name); } private String name; public Girl(String name) { this.name = name; } public String getName() { return name; } public void setName(String name) { this.name = name; } @Override public String dancing() { return name+"喜欢跳舞"; }}
package com.gupao.redisson;import org.springframework.boot.context.properties.ConfigurationProperties;/** * @author Eclipse_2019 * @create 2021/8/11 11:28 */@ConfigurationProperties(prefix = "gp.girl")public class GirlProperties { private String name = "wentai"; public String getName() { return name; } public void setName(String name) { this.name = name; }}
package com.gupao.redisson;import org.redisson.Redisson;import org.redisson.api.RedissonClient;import org.redisson.config.Config;import org.redisson.config.SingleServerConfig;import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;/** * @author Eclipse_2019 * @create 2021/8/11 11:05 */@ConditionalOnClass(Girl.class)//条件装配@EnableConfigurationProperties(GirlProperties.class)@Configurationpublic class GirlAutoConfiguration { @Bean Humen humen(GirlProperties girlProperties){ return Girl.create(girlProperties.getName()); }}
org.springframework.boot.autoconfigure.EnableAutoConfiguration=/ com.gupao.redisson.RedissonAutoConfiguration,/ com.gupao.redisson.GirlAutoConfiguration
{ "properties": [ { "name": "gp.redisson.host", "type": "java.lang.String", "description": "Redis的服务器地址", "defaultValue": "localhost" }, { "name": "gp.redisson.port", "type": "java.lang.Integer", "description": "Redis的服务器端口", "defaultValue": 6379 }, { "name": "gp.redisson.pwd", "type": "java.lang.String", "description": "Redis的服务器密码", "defaultValue": "jingtian" }, { "name": "gp.redisson.datasource", "type": "java.lang.Integer", "description": "Redis的服务器库", "defaultValue": 0 }, { "name": "gp.girl.name", "type": "java.lang.String", "description": "默认女孩名", "defaultValue": "wentai" } ]}
通过上面我们实现自己的starter组件案例来看,starter组件的实现其实逻辑并不复杂,核心思想就是在META-INF目录下创建spring.factories文件,然后配置自定义的配置类。只要按照这个逻辑配置,都可以做到自动注入到IoC容器中去,OK,那我们现在来看看我们的spring-boot-starter-data-redis这个starter组件,你会发现,这个组件里面居然没有spring.factories文件,为什么呢?没有这个文件,它是怎么自动装配的呢?
其实针对springboot的starter组件分为两类。
@ConditionalOnBean(仅仅在当前上下文中存在某个对象时,才会实例化一个Bean)
@ConditionalOnClass(某个class位于类路径上,才会实例化一个Bean)
@ConditionalOnExpression(当表达式为true的时候,才会实例化一个Bean)
@ConditionalOnMissingBean(仅仅在当前上下文中不存在某个对象时,才会实例化一个Bean)
@ConditionalOnMissingClass(某个class类路径上不存在的时候,才会实例化一个Bean)
@
ConditionalOnNotWebApplication(不是web应用)
所有的starter组件自身不带spring.factories文件,集中在spring都是-boot-autoconfigure包下的EnableAutoConfiguration
springboot装配这些配置类是需要条件的,不可能所有的configuration都注入,假设我没用到redis的话就不会引包,这样就根据@ConditionalOnClass(RedisOperations.class)在class path下找不到RedisOperation类,这样就不会加载该配置类
自身维护的starter组件的命名:spring-boot-starter-XXX
这里有个小知识:@ConditionalOnClass(XXX.class)在我们本地用的时候,如果XXX.class不存在的话压根编译不能通过,但是为什么springboot自身维护的能编译通过呢?
现在我们会手写自己的starter组件了,也明白了不同组件的区别,那么接下来让我们一起来看看springboot中的一个比较重要的组件——spring-boot-starter-web组件,为什么要看它呢?因为它帮我们完成了容器的内置以及启动。
Springboot整合Spring MVC只需要在pom.xml文件中引入。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency>
配置文件。
server: port: 8080 # web服务端口号 servlet: multipart: enabled: true # 启用文件上传 location: # 上传文件临时保存位置 max-file-size: 50MB # 单个文件上传最大大小限制 max-request-size: 100MB # 单次请求主体最大大小限制 mvc: format: date: yyyy-MM-dd # 日期格式 date-time: yyyy-MM-dd HH:mm:ss # 日期时间格式 time: HH:mm:ss # 时间格式 servlet: path: / # servlet路径 static-path-pattern: # 匹配静态资源路径 view: prefix: # view前缀 suffix: # view后缀,如:.jsp
以上是Spring MVC常用配置,更多配置可参见https://docs.spring.io/spring-boot/docs/2.3.7.RELEASE/reference/html/appendix-application-properties.html#common-application-properties-web。
我们只配置最简单的。
spring.mvc.view.suffix=.jspspring.mvc.view.prefix=/WEB-INF/jsp/
3.为项目添加WEB-INF目录和web.xml文件。
service:
package com.example.springbootvipjtdemo.mvcdemo;import org.springframework.stereotype.Service;/** * @author Eclipse_2019 * @create 2022/6/11 16:03 */@Servicepublic class JspService { public String sayHello(String name){ return "你真棒!"+name; }}
controller:
package com.example.springbootvipjtdemo.mvcdemo;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestParam;import org.springframework.web.bind.annotation.RestController;import org.springframework.web.servlet.ModelAndView;/** * @author Eclipse_2019 * @create 2022/6/11 16:03 */@RestControllerpublic class JspController { @Autowired private JspService jspService; @RequestMapping("/jsp") public ModelAndView hello(@RequestParam String name){ ModelAndView modelAndView = new ModelAndView(); modelAndView.addObject("version","2.X版本"); modelAndView.addObject("name",name); modelAndView.addObject("msg",jspService.sayHello(name)); modelAndView.setViewName("a"); return modelAndView; }}
jsp:
<%@page contentType="text/html; charset=UTF-8" language="java" %><!DOCTYPE html><html lang="en"><body><h2>${version}</h2><h2>${name}:${msg}</h2></body></html>
上面的案例实现了Springboot集成springmvc,但是现在还没有哪里用到了容器,那容器是怎么启动的呢?
先来看看spring-boot-starter-web包里面有啥:
然后再来看看springboot启动的时候是怎么去创建内置容器的
spring容器启动代码就不说了,这里主要看一下onRefresh() 这个方法。转到定义发现这个方法里面啥都没有,这明显是一个钩子方法,它会钩到它子类重写onRefresh()方法。所以去看子类里面的onRefresh()
protected void onRefresh() throws BeansException { //这是一个空方法,AbstractApplicationContext 这个类是一个抽象类, //所以我们要找到集成AbstractApplicationContext的子类,去看子类里面的onRefresh() // For subclasses: do nothing by default.}
我们这里是一个Web项目,所以我们就去看ServletWebServerApplicationContext 这个类 ,我还是把类的关系图贴一下。
我们就去看ServletWebServerApplicationContext 这个类下面的 onRefresh() 方法。
protected void onRefresh() { super.onRefresh(); try { //看到内置容器的影子了,进去看看 createWebServer(); } catch (Throwable ex) { throw new ApplicationContextException("Unable to start web server", ex); }}
private void createWebServer() { WebServer webServer = this.webServer; ServletContext servletContext = getServletContext(); if (webServer == null && servletContext == null) { //1、这个获取webServerFactory还是要进去看看 ServletWebServerFactory factory = getWebServerFactory(); this.webServer = factory.getWebServer(getSelfInitializer()); } else if (servletContext != null) { try { getSelfInitializer().onStartup(servletContext); } catch (ServletException ex) { throw new ApplicationContextException("Cannot initialize servlet context", ex); } } initPropertySources();}
我们继续看下getWebServletFactory() 这个方法,这个里面其实就是选择出哪种类型的web容器了。
protected ServletWebServerFactory getWebServerFactory() { // Use bean names so that we don't consider the hierarchy String[] beanNames = getBeanFactory() .getBeanNamesForType(ServletWebServerFactory.class); if (beanNames.length == 0) { throw new ApplicationContextException( "Unable to start ServletWebServerApplicationContext due to missing " + "ServletWebServerFactory bean."); } if (beanNames.length > 1) { throw new ApplicationContextException( "Unable to start ServletWebServerApplicationContext due to multiple " + "ServletWebServerFactory beans : " + StringUtils.arrayToCommaDelimitedString(beanNames)); } return getBeanFactory().getBean(beanNames[0], ServletWebServerFactory.class); }
我们再回头去看factory.getWebServer(getSelfInitializer()) ,转到定义就会看到很熟悉的名字tomcat。
public WebServer getWebServer(ServletContextInitializer... initializers) { //tomcat这位大哥出现了 Tomcat tomcat = new Tomcat(); File baseDir = (this.baseDirectory != null ? this.baseDirectory : createTempDir("tomcat")); tomcat.setBaseDir(baseDir.getAbsolutePath()); Connector connector = new Connector(this.protocol); tomcat.getService().addConnector(connector); customizeConnector(connector); tomcat.setConnector(connector); tomcat.getHost().setAutoDeploy(false); configureEngine(tomcat.getEngine()); for (Connector additionalConnector : this.additionalTomcatConnectors) { tomcat.getService().addConnector(additionalConnector); } prepareContext(tomcat.getHost(), initializers); return getTomcatWebServer(tomcat);}
内置的Servlet容器就是在onRefresh() 方法里面启动的,至此一个Servlet容器就启动OK了。
本文链接:http://www.28at.com/showinfo-26-12699-0.html玩转SpringBoot—Starter组件
声明:本网页内容旨在传播知识,若有侵权等问题请及时与本网联系,我们将在第一时间删除处理。邮件:2376512515@qq.com
上一篇: 使用Python对数据进行操作转换