Spring中@Import的三種情況

来源:https://www.cnblogs.com/dongguangming/archive/2020/05/26/12963060.html
-Advertisement-
Play Games

我們在使用Spring框架中，特別是框架級的功能，經常看到有@Import導入功能， ​ 我就介紹下它能導入什麼，首先聲明下@Import是註解，導入類型可分為三類： 1. 導入配置 @Configuration，類似於spring早期版本2.5的import xml文件一樣， <?xml vers ...


 

 

我們在使用Spring框架中，特別是框架級的功能，經常看到有@Import導入功能，

​

我就介紹下它能導入什麼，首先聲明下@Import是註解，導入類型可分為三類：

1.   導入配置 @Configuration，類似於spring早期版本2.5的import xml文件一樣，

<?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-2.5.xsd  
       ">  
      
    <import resource="cms-validator-service.xml"/>  
    <import resource="cms-validator-dao.xml"/>  
       
</beans>

 只是現在註解搶了風頭，但目的一樣，用於使用所有標有@configuration註解的配置。

下麵我就寫個小例子，怎麼建java項目就略了

先建java主包com.spring, 然後分別建子包

com.spring.service,  com.spring.service.impl, com.spring.config, com.spring.test

1.1  建立服務介面

package com.spring.service;

/**
 * 
 * @author dgm
 * @describe "日誌服務介面"
 */
public interface LogService {

    void print(String message);
}

1.2  建立服務實現類，分三種情況，控制台、文件和資料庫mysql

package com.spring.service.impl;

import org.springframework.stereotype.Component;
import com.spring.service.LogService;

/**
 * @author dgm
 * @describe "日誌到控制台"
 */
@Component
public class StdOutLogServiceImpl implements LogService {

	@Override
	public void print(String message) {
        System.out.println(message);
        System.out.println("寫日誌到控制台！");
	}
}


import java.io.File;
import java.io.FileWriter;
import java.io.IOException;

import org.springframework.stereotype.Component;
import com.spring.service.LogService;

/**
 * 
 * @author dgm
 * @describe "日誌到文件"
 */
@Component
public class FileLogServiceImpl implements LogService {

	private static final String FILE_NAME="d://LogService.txt";
	@Override
	public void print(String message) {
		try {
			File file = new File(FILE_NAME);
			FileWriter fw = null;
			// true:表示是追加的標誌
			fw = new FileWriter(file, true);
			fw.write(message+"\n");
			fw.close();

	        System.out.println(message);
			System.out.println("寫日誌入文件！");
		} catch (IOException e) {
		}
	}
}


/**
 * @author dgm
 * @describe "寫日誌入mysql資料庫"
 */
@Component
public class MysqlLogServiceImpl implements LogService {

	@Override
	public void print(String message) {
        System.out.println(message);
        System.out.println("寫日誌入資料庫");
	}
}

1.3  寫配置類，三個服務實現類對應三個@Configuration

package com.spring.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.spring.service.LogService;
import com.spring.service.impl.StdOutLogServiceImpl;

@Configuration
public class StdOutConfig {

	@Bean(name="stdOutLogServiceImpl")
	public LogService stdOutLogServiceImpl(){
		return new StdOutLogServiceImpl();
	}
}


import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.spring.service.LogService;
import com.spring.service.impl.FileLogServiceImpl;

@Configuration
public class FileLogConfig {

	@Bean(name="fileLogServiceImpl")
	public LogService fileLogServiceImpl(){
		return new FileLogServiceImpl();
	}
}

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.spring.service.LogService;
import com.spring.service.impl.MysqlLogServiceImpl;

@Configuration
public class MysqlLogConfig {

	@Bean(name="mysqlLogServiceImpl")
	public LogService mysqlLogServiceImpl(){
		return new MysqlLogServiceImpl();
	}
}

然後@Import註解登場了

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

@Configuration
@Import({StdOutConfig.class, FileLogConfig.class, MysqlLogConfig.class})
public class LogParentConfig {

}

1.4  建立測試類看效果

import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import com.spring.config.LogParentConfig;
import com.spring.service.*;

/**
 * @author dgm
 * @describe "java configuration bean"
 */
public class LogConfigurationAppTest {
	public static void main(String[] args) {
		AnnotationConfigApplicationContext  context = new AnnotationConfigApplicationContext(
				LogParentConfig.class);
		//控制台
		LogService obj = (LogService) context.getBean("stdOutLogServiceImpl");
		System.out.println(obj);
		obj.print("控制台輸出");
		//file
		obj = (LogService) context.getBean("fileLogServiceImpl");
		System.out.println(obj);
		obj.print("文件輸出");
		//mysql
		obj = (LogService) context.getBean("mysqlLogServiceImpl");
		System.out.println(obj);
		obj.print("資料庫mysql");
		
		context.close();
	}
}

輸出效果​

 

2.  導入實現ImportSelector介面或子介面DeferredImportSelector的類

@Import annotation can also be configured with an ImportSelector implementation to select @Configuration classes programmatically, based on some selection criteria.

下麵我也演示下，這個很重要，框架里和spring擴展開發用的多，先建立備用子包com.spring.bean和com.spring.importSelector，然後建立配置文件目錄conf

2.1  實現了ImportSelector

2.1.1    建立輔助類ApplicationProperties.java和外置配置文件myapp.properties

package com.spring.bean;

public class ApplicationProperties {
	private String connectionUrl;
	private String connectionName;

	public String getConnectionUrl() {
		return connectionUrl;
	}

	public void setConnectionUrl(String connectionUrl) {
		this.connectionUrl = connectionUrl;
	}

	public String getConnectionName() {
		return connectionName;
	}

	public void setConnectionName(String connectionName) {
		this.connectionName = connectionName;
	}

	@Override
	public String toString() {
		return "ApplicationProperties [connectionUrl=" + connectionUrl
				+ ", connectionName=" + connectionName + "]";
	}
}

然後在conf目錄下建立配置文件myapp.properties，內容如下：

app.url=https://github.com/dongguangming
app.name=dongguangming

2.1.2   建立@Configuration配置類

@Configuration
@PropertySource("classpath:conf/myapp.properties")
public class AppConfig {
	@Autowired
	ConfigurableEnvironment environment;

	@Bean
	ApplicationProperties appProperties() {
		ApplicationProperties bean = new ApplicationProperties();
		bean.setConnectionUrl(environment.getProperty("app.url"));
		bean.setConnectionName(environment.getProperty("app.name"));
		return bean;
	}
}

2.1.3  建立實現了ImportSelector介面的導入類，返回列表裡的值是有標誌@Configuration

public class LogImportSelector implements  ImportSelector{

	@Override
	public String[] selectImports(AnnotationMetadata importingClassMetadata) {
		
		    return new String[]{"com.spring.config.AppConfig","com.spring.config.LogParentConfig"};
	}

}

 2.1.4  建立有@import功能的配置類，導入2.1.3的實現類

package com.spring.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;

import com.spring.importSelector.LogImportSelector;

@Configuration
@Import(LogImportSelector.class)
public class LogImportSelectorConfig {

}

2.1.5  編寫測試類

 

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import com.spring.bean.ApplicationProperties;
import com.spring.config.LogImportSelectorConfig;
import com.spring.service.*;

/**
 * @author dgm
 * @describe "java configuration bean"
 */
public class LogImportSelectorConfigurationAppTest {
	public static void main(String[] args) {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
				LogImportSelectorConfig.class);
		// 控制台
		LogService obj = (LogService) context.getBean("stdOutLogServiceImpl");
		System.out.println(obj);
		obj.print("控制台輸出");
		// file
		obj = (LogService) context.getBean("fileLogServiceImpl");
		System.out.println(obj);
		obj.print("文件輸出");
		// mysql
		obj = (LogService) context.getBean("mysqlLogServiceImpl");
		System.out.println(obj);
		obj.print("資料庫mysql");

		//
		ApplicationProperties ap = context.getBean(ApplicationProperties.class);
		System.out.println(ap);

		context.close();
	}
}

 輸出效果：​

效果不錯，也能完成bean的註冊

還有一種基於註解的變體，我也示例下，先建個子包com.spring.annotation

建立自定義註解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(LogImportSelector.class)
/**
 * @author dgm
 * @describe "自定義Enable功能"
 */
public @interface EnableLogService {
	//預設日誌輸出到控制台
	String logType() default "stdout";

	@AliasFor("value")
	String[] basePackages() default {};

	@AliasFor("basePackages")
	String[] value() default {}; 
}

然後修改導入選擇器實現類，根據啟用日誌功能時傳的參數絕對載入哪個bean

AnnotationAttributes attributes = AnnotationAttributes
				.fromMap(importingClassMetadata.getAnnotationAttributes(
						EnableLogService.class.getName(), false));
		System.out.println(attributes);

		//根據日誌類型確定載入bean
		String logType = attributes.getString("logType");

		if (logType.equalsIgnoreCase("StdOut")) {
			return new String[] { "com.spring.config.AppConfig",
					"com.spring.config.StdOutConfig" };
		} else if (logType.equalsIgnoreCase("File")) {
			return new String[] { "com.spring.config.AppConfig",
					"com.spring.config.FileLogConfig" };
		} else if (logType.equalsIgnoreCase("Mysql")) {
			return new String[] { "com.spring.config.AppConfig",
					"com.spring.config.MysqlLogConfig" };
		} else {
			return new String[] { "com.spring.config.AppConfig",
					"com.spring.config.LogParentConfig" };
		}

 修改配置類，追加自定義註解@EnableLogService，並設置參數為file（可選stdout，file，mysql）

@Configuration
//@Import(LogImportSelector.class)
@EnableLogService(logType="file")
public class LogImportSelectorConfig {

}

修改測試類，此時不再是三種日誌實現的bean都載入，按配置參數載入

LogService obj = (LogService) context.getBean("fileLogServiceImpl");
		System.out.println(obj);
		obj.print("文件輸出");

 ​

就因為配置了@EnableLogService(logType="file")，只載入了一個日誌實現bean

 2.2  實現了 DeferredImportSelector

public interface DeferredImportSelector extends ImportSelector {
}

 可是看出它是2.1的子介面

The configuration class directly registered with the application context given preference over imported one. That means a bean of type T, configured in the main configuration will be used instead of a bean of the same type T from imported configuration. That applies to ImportSelector as well. On the other hand, DeferredImportSelector applies after all other configuration beans have been processed.

我們可以比較下實現兩種介面的區別

在主選擇器的配置類LogImportSelectorConfig.java中增加

@Bean
	LogBean logBean() {
		return new LogBean();
	}

	@Bean(name = "fileLogServiceImpl")
	public LogService fileLogServiceImpl() {
		return new FileLogServiceImpl(" 來自LogImportSelectorConfig  ");
	}

 

在文件配置類FileLogConfig.java中修改為

@Bean(name="fileLogServiceImpl")
	public LogService fileLogServiceImpl(){
		return new FileLogServiceImpl("來自  FileLogConfig");
	}

選擇器實現類還是

public class LogImportSelector implements ImportSelector  {。。。}

 執行測試代碼

LogBean bean = context.getBean(LogBean.class);
	    bean.printMessage();

 ​

此時修改選擇器實現的介面改為DeferredImportSelector，其它不改

public class LogImportSelector implements DeferredImportSelector  {。。。}

 再次執行測試

​

 

2.3   導入實現了ImportBeanDefinitionRegistrar介面的類

可以先瞄下介面的如何定義和定義了什麼

public interface ImportBeanDefinitionRegistrar {
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 軟體設計模式學習（二十）迭代器模式
    迭代器模式是一種使用頻率非常高的設計模式，迭代器用於對一個聚合對象進行遍歷。通過引入迭代器可以將數據的遍歷功能從聚合對象中分離出來，聚合對象只負責存儲數據，聚合對象只負責存儲數據，而遍曆數據由迭代器來完成。 模式動機 一個聚合對象，如一個列表（List）或者一個集合（Set）,應該提供一種方法來讓別 ...
  • 【設計模式】牛掰格拉斯的代理模式
    代理的本質無論任何時候，只要談到設計模式，大腦中一定要蹦出這四個字“活學活用”。要想對某個事物做到活學活用，必須要對它足夠瞭解，甚至要剖析到本質才行。總是會有些人說，我幹嘛要知道原理，幹嘛要去看源碼？會用就行了。對於這種情況，我只有五個字相送，“你開心就好”。不可否認，認識一個陌生事物，大部分情況還 ...
  • BUAA_OO_第三單元
    一、JML初探 ​ 作為一種形式化語言，可以約束 代碼中類和方法的狀態和行為形成規格，通過將一系列具體代碼實現抽象成明確的行為介面，可以形成一種契約式編程模式， 設計者無需考慮實際的數據結構與演算法，可以聚焦於程式的整體邏輯， 形式化語言的無二義性能讓實現者準確理解介面功能，根據問題需要選擇合適的實現 ...
  • 每天學習一個設計模式（五）：結構型之門面模式
    一、基本概念 門面模式（外觀模式）是對象的結構模式，外部與一個子系統的通信必須通過一個統一的門面對象進行。門面模式提供一個高層次的介面，使得子系統更易於使用。 二、通俗解釋 FACADE門面模式：我有一個專業的Nikon相機，我就喜歡自己手動調光圈、快門，這樣照出來的照片才專業，但MM可不懂這些，教 ...
  • 每天學習一個設計模式（四）：結構型之裝飾模式
    一、基本概念 裝飾模式又名包裝(Wrapper)模式。裝飾模式以對客戶端透明的方式擴展對象的功能，是繼承關係的一個替代方案。 二、通俗解釋 DECORATOR裝飾模式：Mary過完輪到Sarly過生日，還是不要叫她自己挑了，不然這個月伙食費肯定玩完，拿出我去年在華山頂上照的照片，在背面寫上“最好的的 ...
  • 每天學習一個設計模式（三）：結構型之合成模式
    一、基本概念 合成模式屬於對象的結構模式，有時又叫做“部分——整體”模式。合成模式將對象組織到樹結構中，可以用來描述整體與部分的關係。合成模式可以使客戶端將單純元素與複合元素同等看待。 二、通俗解釋 COMPOSITE合成模式：Mary今天過生日。“我過生日，你要送我一件禮物。”“嗯，好吧，去商店， ...
  • 每天學習一個設計模式（二）：結構型之橋梁模式
    一、基本概念 橋梁模式（Bridge）是對象的結構模式。又稱為柄體(Handle and Body)模式或介面(Interface)模式。橋梁模式的用意是“將抽象化(Abstraction)與實現化(Implementation)脫耦，使得二者可以獨立地變化”。 這句話有三個關鍵詞，也就是抽象化、實 ...
  • 每天學習一個設計模式（一）：結構型之適配器模式
    一、基本概念 適配器模式是將某個類的介面轉換成客戶端期望的另一個介面表示，目的是消除由於介面不匹配所造成的的類的相容性問題。 二、通俗解釋 ADAPTER 適配器模式：在朋友聚會上碰到了一個美女Sarah，從香港來的，可我不會說粵語，她不會說普通話，只好求助於我的朋友kent了，他作為我和Sarah ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類