自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

玩轉(zhuǎn)SpringBoot—Starter組件

作者：eclipse2019
開發(fā) 架構(gòu)
Starter組件使開發(fā)者不需要關(guān)注各種依賴庫(kù)的處理，不需要具體的配置信息，由SpringBoot自動(dòng)完成class類發(fā)現(xiàn)并加載需要的Bean。

學(xué)習(xí)目標(biāo)

  • 明確starter組件到底是什么？是做什么的？
  • 自己實(shí)現(xiàn)一個(gè)starter組件
  • Spring Boot提供的Starter組件和第三方Starter組件
  • Spring -Boot-Web-Starter如何自動(dòng)讓應(yīng)用部署到Tomcat容器的

第1章 starter組件簡(jiǎn)介

starter組件是SpringBoot的一個(gè)核心特性，Starter組件的出現(xiàn)極大簡(jiǎn)化了項(xiàng)目開發(fā)，例如在項(xiàng)目中使用的pom.xm文件下配置：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

SpringBoot就會(huì)自動(dòng)關(guān)聯(lián)web開發(fā)相關(guān)的依賴，如tomcat以及spring-webmvc等，進(jìn)而對(duì)web開發(fā)進(jìn)行支持，同時(shí)相關(guān)技術(shù)也將實(shí)現(xiàn)自動(dòng)配置，避免了繁瑣的配置文件。

Starter組件使開發(fā)者不需要關(guān)注各種依賴庫(kù)的處理，不需要具體的配置信息，由SpringBoot自動(dòng)完成class類發(fā)現(xiàn)并加載需要的Bean。

利用starter實(shí)現(xiàn)自動(dòng)化配置需要兩個(gè)條件：Maven依賴、配置文件，Maven依賴實(shí)質(zhì)上就是導(dǎo)入jar包，SpringBoot啟動(dòng)的時(shí)候會(huì)找到Starter組件jar包中的
resources/META-INF/spring.factories文件，根據(jù)spring.factories文件中的配置，找到需要自動(dòng)配置的類。

starter組件理解總結(jié)：

  • 每個(gè)不同的starter組件實(shí)際上完成自身的功能邏輯，然后對(duì)外提供一個(gè)bean對(duì)象讓別人調(diào)用
  • 對(duì)外提供的bean通過自動(dòng)裝配原理注入到提供方的IoC容器中

第2章 手寫starter組件

要實(shí)現(xiàn)一個(gè)自己的starter組件其實(shí)也很簡(jiǎn)單，要完成一個(gè)starter組件的編寫，首先要明確，我們要做的事有哪些：

  • 通過配置類提供對(duì)外服務(wù)的bean對(duì)象
  • 按照自動(dòng)裝配原理完成spring.factories的編寫
  • starter自動(dòng)屬性配置

接下來(lái)我們就來(lái)手寫一個(gè)starter組件，流程如下：

創(chuàng)建一個(gè)springboot項(xiàng)目redisson-spring-boot-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>

創(chuàng)建要注入的bean類和接口

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+"喜歡跳舞";
    }
}

創(chuàng)建屬性類

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;
    }
}

創(chuàng)建配置類

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)
@Configuration
public class GirlAutoConfiguration {

    @Bean
    Humen humen(GirlProperties girlProperties){
        return Girl.create(girlProperties.getName());
    }
}

實(shí)現(xiàn)自動(dòng)裝配流程，在META-INF目錄下創(chuàng)建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.gupao.redisson.RedissonAutoConfiguration,\
  com.gupao.redisson.GirlAutoConfiguration

在META-INF創(chuàng)建屬性默認(rèn)規(guī)范文件additional-spring-configuration-metadata.json

{
  "properties": [
    {
      "name": "gp.redisson.host",
      "type": "java.lang.String",
      "description": "Redis的服務(wù)器地址",
      "defaultValue": "localhost"
    },
    {
      "name": "gp.redisson.port",
      "type": "java.lang.Integer",
      "description": "Redis的服務(wù)器端口",
      "defaultValue": 6379
    },
    {
      "name": "gp.redisson.pwd",
      "type": "java.lang.String",
      "description": "Redis的服務(wù)器密碼",
      "defaultValue": "jingtian"
    },
    {
      "name": "gp.redisson.datasource",
      "type": "java.lang.Integer",
      "description": "Redis的服務(wù)器庫(kù)",
      "defaultValue": 0
    },
    {
      "name": "gp.girl.name",
      "type": "java.lang.String",
      "description": "默認(rèn)女孩名",
      "defaultValue": "wentai"
    }
  ]
}

打包發(fā)布

測(cè)試

通過上面我們實(shí)現(xiàn)自己的starter組件案例來(lái)看，starter組件的實(shí)現(xiàn)其實(shí)邏輯并不復(fù)雜，核心思想就是在META-INF目錄下創(chuàng)建spring.factories文件，然后配置自定義的配置類。只要按照這個(gè)邏輯配置，都可以做到自動(dòng)注入到IoC容器中去，OK，那我們現(xiàn)在來(lái)看看我們的spring-boot-starter-data-redis這個(gè)starter組件，你會(huì)發(fā)現(xiàn)，這個(gè)組件里面居然沒有spring.factories文件，為什么呢？沒有這個(gè)文件，它是怎么自動(dòng)裝配的呢？

第3章 自身與第三方維護(hù)

其實(shí)針對(duì)springboot的starter組件分為兩類。

springboot自身維護(hù)的starter組件

@ConditionalOnBean（僅僅在當(dāng)前上下文中存在某個(gè)對(duì)象時(shí)，才會(huì)實(shí)例化一個(gè)Bean）
@ConditionalOnClass（某個(gè)class位于類路徑上，才會(huì)實(shí)例化一個(gè)Bean）
@ConditionalOnExpression（當(dāng)表達(dá)式為true的時(shí)候，才會(huì)實(shí)例化一個(gè)Bean）
@ConditionalOnMissingBean（僅僅在當(dāng)前上下文中不存在某個(gè)對(duì)象時(shí)，才會(huì)實(shí)例化一個(gè)Bean）
@ConditionalOnMissingClass（某個(gè)class類路徑上不存在的時(shí)候，才會(huì)實(shí)例化一個(gè)Bean）
@
ConditionalOnNotWebApplication（不是web應(yīng)用）

所有的starter組件自身不帶spring.factories文件，集中在spring都是-boot-autoconfigure包下的EnableAutoConfiguration

springboot裝配這些配置類是需要條件的，不可能所有的configuration都注入，假設(shè)我沒用到redis的話就不會(huì)引包，這樣就根據(jù)@ConditionalOnClass(RedisOperations.class)在class path下找不到RedisOperation類，這樣就不會(huì)加載該配置類

自身維護(hù)的starter組件的命名：spring-boot-starter-XXX

第三方維護(hù)的starter組件

  • 自己維護(hù)spring.factories文件
  • 命名方式：XXX-spring-boot-starter

這里有個(gè)小知識(shí)：@ConditionalOnClass(XXX.class)在我們本地用的時(shí)候，如果XXX.class不存在的話壓根編譯不能通過，但是為什么springboot自身維護(hù)的能編譯通過呢？

  • 其實(shí)原因也簡(jiǎn)單，因?yàn)樵趕tarter組件編譯的時(shí)候是引入了@ConditionnalOnClass里面的那個(gè)類了的，然后在pom文件引入的這個(gè)XXX類所在的jar包時(shí)加了true，等starter組件編譯打包之后不會(huì)將XXX類所在的jar包傳遞依賴給別的項(xiàng)目。
  • 這里就可以將spring-boot-autoconfigure包理解成一個(gè)starter組件，它在編譯的過程中引入了很多jar包，比如說引入Redis的相關(guān)jar包，然后加入了true,當(dāng)autoconfigure編譯打成jar包之后是沒問題的，但是別的項(xiàng)目依賴autoconfigure之后，必須要引入redis的jar包才能通過@ConditionalOnClass注解。

現(xiàn)在我們會(huì)手寫自己的starter組件了，也明白了不同組件的區(qū)別，那么接下來(lái)讓我們一起來(lái)看看springboot中的一個(gè)比較重要的組件——spring-boot-starter-web組件，為什么要看它呢？因?yàn)樗鼛臀覀兺瓿闪巳萜鞯膬?nèi)置以及啟動(dòng)。

第4章 內(nèi)置容器

starter-web

Springboot整合Spring MVC只需要在pom.xml文件中引入。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

配置文件。

server:
  port: 8080 # web服務(wù)端口號(hào)
  servlet:
    multipart:
      enabled: true # 啟用文件上傳
      location: # 上傳文件臨時(shí)保存位置
      max-file-size: 50MB # 單個(gè)文件上傳最大大小限制
      max-request-size: 100MB # 單次請(qǐng)求主體最大大小限制
  mvc:
    format:
      date: yyyy-MM-dd # 日期格式
      date-time: yyyy-MM-dd HH:mm:ss # 日期時(shí)間格式
      time: HH:mm:ss # 時(shí)間格式
    servlet:
      path: / # servlet路徑
      static-path-pattern: # 匹配靜態(tài)資源路徑
    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。

我們只配置最簡(jiǎn)單的。

spring.mvc.view.suffix=.jsp
spring.mvc.view.prefix=/WEB-INF/jsp/

3.為項(xiàng)目添加WEB-INF目錄和web.xml文件。

service：

package com.example.springbootvipjtdemo.mvcdemo;

import org.springframework.stereotype.Service;

/**
 * @author Eclipse_2019
 * @create 2022/6/11 16:03
 */
@Service
public 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
 */
@RestController
public 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>

上面的案例實(shí)現(xiàn)了Springboot集成springmvc，但是現(xiàn)在還沒有哪里用到了容器，那容器是怎么啟動(dòng)的呢？

先來(lái)看看spring-boot-starter-web包里面有啥：

  • ServletWebServerFactoryAutoConfiguration配置類中Import了ServletWebServerFactoryConfiguration.EmbeddedTomcat.class。
  • 當(dāng)容器啟動(dòng)的時(shí)候也會(huì)自動(dòng)裝配該類，在該配置類中創(chuàng)建了TomcatServletWebServerFactory()。
  • WebMvcAutoConfiguration類完成了InternalResourceViewResolver解析器的注入。

然后再來(lái)看看springboot啟動(dòng)的時(shí)候是怎么去創(chuàng)建內(nèi)置容器的

onRefresh

spring容器啟動(dòng)代碼就不說了，這里主要看一下onRefresh() 這個(gè)方法。轉(zhuǎn)到定義發(fā)現(xiàn)這個(gè)方法里面啥都沒有，這明顯是一個(gè)鉤子方法，它會(huì)鉤到它子類重寫onRefresh()方法。所以去看子類里面的onRefresh()

protected void onRefresh() throws BeansException {
    //這是一個(gè)空方法，AbstractApplicationContext 這個(gè)類是一個(gè)抽象類，
    //所以我們要找到集成AbstractApplicationContext的子類，去看子類里面的onRefresh()
	// For subclasses: do nothing by default.
}

我們這里是一個(gè)Web項(xiàng)目，所以我們就去看ServletWebServerApplicationContext 這個(gè)類 ，我還是把類的關(guān)系圖貼一下。

我們就去看ServletWebServerApplicationContext 這個(gè)類下面的 onRefresh() 方法。

protected void onRefresh() {
		super.onRefresh();
		try {
            //看到內(nèi)置容器的影子了，進(jìn)去看看
			createWebServer();
		}
		catch (Throwable ex) {
			throw new ApplicationContextException("Unable to start web server", ex);
		}

}

createWebServer

private void createWebServer() {
		WebServer webServer = this.webServer;
		ServletContext servletContext = getServletContext();
		if (webServer == null && servletContext == null) {
            //1、這個(gè)獲取webServerFactory還是要進(jìn)去看看
			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();

}

我們繼續(xù)看下getWebServletFactory() 這個(gè)方法，這個(gè)里面其實(shí)就是選擇出哪種類型的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);
	}

getWebServer

我們?cè)倩仡^去看factory.getWebServer(getSelfInitializer()) ，轉(zhuǎn)到定義就會(huì)看到很熟悉的名字tomcat。

public WebServer getWebServer(ServletContextInitializer... initializers) {
        //tomcat這位大哥出現(xiàn)了
		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);

}

內(nèi)置的Servlet容器就是在onRefresh() 方法里面啟動(dòng)的，至此一個(gè)Servlet容器就啟動(dòng)OK了。

責(zé)任編輯：姜華 來(lái)源： 今日頭條
SpringBootStarter組件
相關(guān)推薦

2024-09-06 17:55:27

Springboot開發(fā)

2023-09-08 09:10:33

SpringBoot微服務(wù)架構(gòu)

2022-10-08 00:00:00

Spring數(shù)據(jù)庫(kù)項(xiàng)目

2023-08-27 22:13:59

Redisson分布式緩存

2019-08-08 16:30:23

技術(shù)編程SpringBoot

2023-10-07 09:16:55

SpringBoot啟動(dòng)流程

2023-09-28 09:17:18

SpringBootBean

2021-08-31 09:57:36

云原生消息隊(duì)列

2023-02-27 09:38:36

Springbootstarter

2023-01-03 09:35:34

SpringbootStarter

2022-09-13 09:02:19

SpringBootStarter機(jī)制

2019-11-12 10:50:13

Spring BootstarterJava

2023-02-26 00:00:01

Spring數(shù)據(jù)庫(kù)組件

2021-03-26 08:20:51

SpringBoot讀寫分離開發(fā)

2023-07-07 08:36:45

配置注解jar

2021-05-14 09:15:32

SpringCloud微服務(wù)日志

2009-07-01 08:34:31

微軟Windows 7Starter

2024-04-26 08:46:42

Spring自動(dòng)裝配核心內(nèi)容

2021-02-03 09:04:11

解密Spring配置

2021-04-27 07:52:19

StarterSpring Boot配置
點(diǎn)贊
收藏

51CTO技術(shù)棧公眾號(hào)