自定義Spring Boot starter

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

我們用spring boot 快速開發應用程式時，經常會引入很多這樣以spring-boot-starter開頭的的庫， 我就演示下自定義一個這樣的庫，功能是日誌輸出到什麼地方（控制台、文件還是資料庫） 前提是maven已經配置好了，參考 https://my.oschina.net/u/15486 ...


 

我們用spring boot 快速開發應用程式時，經常會引入很多這樣以spring-boot-starter開頭的的庫，

我就演示下自定義一個這樣的庫，功能是日誌輸出到什麼地方（控制台、文件還是資料庫）

前提是maven已經配置好了，參考 https://my.oschina.net/u/154866/blog/3223749

1  新建maven項目，參考spring官網  https://start.spring.io/，按實際情況填寫基本信息和選擇要依賴的庫

然後點擊“GENERATE”按鈕,  註意生成前可以點擊EXPLORE預覽下項目結構

然後把下載後的文件解壓後導入到開發工具（比如eclipse）中，很簡單，打開eclipse，找到import按鈕

出現以下提示

點擊next：

找到路徑後點擊"確定"按鈕，出現

最後點擊“finish”完成，即可完成maven項目的導入。

2.  正式進入編碼階段

新建主包名, 比如com.dongguangming,  然後分別建子包：

com.dongguangming.service， com.dongguangming.service.impl，
com.dongguangming.annotation，com.dongguangming.condition，com.dongguangming.autoconfigure

2.1 建日誌服務介面

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

    void print(String message);
}

2.2  實現日誌服務介面，分三種實現，控制台、文件、資料庫mysql

import com.dongguangming.service.LogService;

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

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

/**
 * 
 * @author dgm
 * @describe "日誌到文件"
 */
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資料庫"
 */
public class MysqlLogServiceImpl implements LogService {

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

2.3  建日誌類型註解

import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;

import org.springframework.context.annotation.Conditional;

import com.dongguangming.condition.LogServiceTypeCondition;

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Conditional(LogServiceTypeCondition.class)
public @interface LogServiceType
{
	//日誌輸出到什麼地方去（控制台，file還是寫到資料庫mysql）
    String value() default "stdout";
}

2.4  通過Condition條件判斷寫日誌

import java.util.Map;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

import com.dongguangming.annotation.LogServiceType;

public class LogServiceTypeCondition implements Condition {

	    @Override
	    public boolean matches(ConditionContext conditionContext,
	    AnnotatedTypeMetadata metadata)
	    {
	        Map<String, Object> attributes = metadata.getAnnotationAttributes(LogServiceType.class.getName());
	        String type = (String) attributes.get("value");
	        System.out.println("value:"+type);
	        String enabledLogType = conditionContext.getEnvironment().getProperty("logType","StdOut");
	        System.out.println("enabledLogType:"+enabledLogType);

	        return (enabledLogType != null && type != null && enabledLogType.equalsIgnoreCase(type));
	    }
}

2.5  創建自動配置類

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

import com.dongguangming.annotation.LogServiceType;
import com.dongguangming.service.LogService;
import com.dongguangming.service.impl.FileLogServiceImpl;
import com.dongguangming.service.impl.MysqlLogServiceImpl;
import com.dongguangming.service.impl.StdOutLogServiceImpl;

@Configuration
@ComponentScan
public class LogServiceAutoConfiguration
{
	@Bean
	@LogServiceType("STDOUT")
	@ConditionalOnMissingBean
    public LogService stdOutLogServiceImpl(){
        return new StdOutLogServiceImpl();
    }

    @Bean
    @LogServiceType("FILE")
    @ConditionalOnMissingBean
    public LogService fileLogServiceImpl(){
        return new FileLogServiceImpl();
    }
    
    @Bean
    @LogServiceType("MYSQL")
    @ConditionalOnMissingBean
    public LogService mysqlLogServiceImpl(){
        return new MysqlLogServiceImpl();
    }
}

2.6 創建配置性文件

在目錄 src/main/resources/下創建約定的配置文件，先建目錄 META-INF ，然後在其目錄下創建很重要的配置文件 spring.factories ，填入以下內容

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.dongguangming.autoconfigure.CustomAutoConfiguration,\
com.dongguangming.autoconfigure.LogServiceAutoConfiguration

特別註意，該目錄結構是約定好的，目錄名必須這樣命名，屬性配置文件名也必須這樣命名

沒辦法了，spring太強大了，直接給你定好約束了，不讓你瞎起名。

 

2.7   設置日誌類型

在項目啟動配置文件application.properties中設置日誌輸出類型，logType=File

然後運行主程式，效果如圖示

2.8  打包成jar

用maven構建工具生成jar，

然後把這個jar 安裝到maven倉庫中

2.9   引用自定義的starter

回到自定義項目的pom文件中，查看以下信息

然後新的項目配置依賴就可以引用了，像引用其他第三方starter一樣

 <!--官網自帶的start，很多-->
 <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

<!--記得嗎，這是我剛纔自定義的starter-->
<dependency>
	<groupId>com.dongguangming</groupId>
	<artifactId>custom-logservice-spring-boot-starter</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</dependency>

然後通過配置文件設置日誌類型

#註意日誌輸出類型logtype有三種選擇：stdout, file, mysql，任選其一
logType=File

代碼中這樣使用

@Autowired
LogService logService;

logService.print("自定義日誌輸出"));

至此一個自定義starter的庫就結束了，如果可以，你可以把自定義的starter放置到各大maven公/私服倉庫中，這樣開發者就能引用你的依賴，不過官網已經寫了很多，我只是舉個例子，因為發現很多群裡人都不清楚starter是做什麼的。

附全部代碼已上傳  https://github.com/dongguangming/springboot-custom-starter

 

參考:

0.    Creating Your Own Auto-configuration

https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-developing-auto-configuration


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • COLA的擴展性使用和源碼研究
    cola擴展點使用和設計初探 封裝變化，可靈活應對程式的需求變化。 擴展點使用 步驟: 定義擴展點介面，類型可以是校驗器，轉換器，實體； 必須以ExtPt結尾，表示一個擴展點。 比如，我定義一個雲樞的組織結構的擴展點介面，消息發送擴展點，二開擴展點，webapi的rest介面擴展點點。 定義擴展點接 ...
  • Python基礎-06字典
    6.字典 字典的主要特性如下所示： 1.字典是使用大括弧進行定義 2.字典中的元素是鍵值對的形式出現，每個鍵值對之間使用冒號進行分隔，每個元素間使用逗號進行分隔 3.字典中鍵必須為不可更改的數據類型，如整型數據、浮點數據、布爾型、字元型、元組等，但不能列表和變數 6.1 基本使用 1.添加 直接給對 ...
  • Python基礎-05列表
    5.列表 列表是實際應用非常多的一種數據類型，需要好好掌握。列表的主要特性如下所示： 1.支持增加、修改和刪除元素操作 2.列表的長度是可變的 3.列表支持排序 5.1 索引與切片 列表中索引是從0開始，且支持正向和反向兩種索引方式。如下所示： a=[1,2,"abc",[4,5,6],{"a":7 ...
  • 設計模式之禪讀書筆記-22個設計模式
    最近在讀秦小波的《設計模式之禪》。本文又是一篇長達2000行的又水又長的筆記，記錄書中所講23個設計模式中的22個，基本上是將書中講的各個設計模式的定義、優點、缺點、適用場景、demo抄下來了。推薦去閱讀原書，這是一位學識豐富且有一個有趣的靈魂的作者所寫，原書中每個設計模式的講解都有一個十分有趣的例 ...
  • Python基礎知識：序列之集合
    python序列之集合 1.概念 集合是一組無序不可重覆元素組成，用{}表示，在集合中元素是唯一的並且集合中只能包括數字，字元串和元組等不可變元素。 2.創建 創建集合可有set()或者{}創建。 3.集合中增加元素的方法為add()方法 4.集合刪除 pop()方法刪除集合中某一個元素。 remo ...
  • Python一鍵獲取日漫Top100榜單電影信息
    最近看到一個 UP 主做的視頻，使用可視化動態圖，把目前播放量最多的 UP 主一一列出來，結果第一名是嗶哩嗶哩番劇，第一名的播放量是第二名近 10 倍。 B站的番劇數量，也是相對其他平臺比較多的，而且質量都還不錯。說實話，剛開始用嗶哩嗶哩的時候，就是為了看番劇。作為一個喜歡看番劇的 pk 哥，我決定 ...
  • 力扣中國100題相同的樹
    # Definition for a binary tree node.# 用遞歸的思想來做題。# 首先比較自身節點是否相同，然後比較節點左兒子，最後比較右兒子class TreeNode: def __init__(self, x): self.val = x self.left = None s ...
  • 力扣中國70題爬樓梯
    # 這道題是遞歸的思想，想要爬上第n臺階，# 1，可以通過n-1層上去，2，通過第n-2層上去# 因此f(n) = f(n-1) + f(n-2)class Solution: def climbStairs(self, n: int) -> int: # 前兩層比較特殊，需要自行定義。 if n ...
一周排行
    -Advertisement-
    Play Games
  • UOS 開啟 VisualStudio 遠程調試 .NET 應用之旅
    前言 在我們開發過程中基本上不可或缺的用到一些敏感機密數據，比如SQL伺服器的連接串或者是OAuth2的Secret等，這些敏感數據在代碼中是不太安全的，我們不應該在源代碼中存儲密碼和其他的敏感數據，一種推薦的方式是通過Asp.Net Core的機密管理器。 機密管理器 在 ASP.NET Core ...
  • C# - 能否讓 SortedSet.RemoveWhere 內傳入的委托非同步執行
    新改進提供的Taurus Rpc 功能，可以簡化微服務間的調用，同時可以不用再手動輸出模塊名稱，或調用路徑，包括負載均衡，這一切，由框架實現並提供了。新的Taurus Rpc 功能，將使得服務間的調用，更加輕鬆、簡約、高效。 ...
  • 順序棧的介面程式
    順序棧的介面程式 目錄順序棧的介面程式頭文件創建順序棧入棧出棧利用棧將10進位轉16進位數驗證 頭文件 #include <stdio.h> #include <stdbool.h> #include <stdlib.h> 創建順序棧 // 指的是順序棧中的元素的數據類型，用戶可以根據需要進行修改 ...
  • mORMot2 獲取數據集1
    前言 整理這個官方翻譯的系列，原因是網上大部分的 tomcat 版本比較舊，此版本為 v11 最新的版本。 開源項目 從零手寫實現 tomcat minicat 別稱【嗅虎】心有猛虎，輕嗅薔薇。 系列文章 web server apache tomcat11-01-官方文檔入門介紹 web serv ...
  • 萬字長文總結與剖析C語言關鍵字 -- <<C語言深度解剖>>
    C總結與剖析:關鍵字篇 -- <<C語言深度解剖>> 目錄C總結與剖析:關鍵字篇 -- <<C語言深度解剖>>程式的本質:二進位文件變數1.變數:記憶體上的某個位置開闢的空間2.變數的初始化3.為什麼要有變數4.局部變數與全局變數5.變數的大小由類型決定6.任何一個變數,記憶體賦值都是從低地址開始往高地 ...
  • 【Flink入門修煉】2-3 Flink Checkpoint 原理機制
    如果讓你來做一個有狀態流式應用的故障恢復，你會如何來做呢？ 單機和多機會遇到什麼不同的問題？ Flink Checkpoint 是做什麼用的？原理是什麼？ ...
  • C++ 多級繼承與多重繼承：代碼組織與靈活性的平衡
    C++ 多級繼承 多級繼承是一種面向對象編程（OOP）特性，允許一個類從多個基類繼承屬性和方法。它使代碼更易於組織和維護，並促進代碼重用。 多級繼承的語法 在 C++ 中，使用 : 符號來指定繼承關係。多級繼承的語法如下： class DerivedClass : public BaseClass1 ...
  • 圖文結合手把手教你創建SpringCloud項目
    前言 什麼是SpringCloud？ Spring Cloud 是一系列框架的有序集合，它利用 Spring Boot 的開發便利性簡化了分散式系統的開發，比如服務註冊、服務發現、網關、路由、鏈路追蹤等。Spring Cloud 並不是重覆造輪子，而是將市面上開發得比較好的模塊集成進去，進行封裝，從 ...
  • 類模板的常見用法
    class_template 類模板和函數模板的定義和使用類似，我們已經進行了介紹。有時，有兩個或多個類，其功能是相同的，僅僅是數據類型不同。類模板用於實現類所需數據的類型參數化 template<class NameType, class AgeType> class Person { publi ...
  • system-v IPC共用記憶體通信
    目錄system v IPC簡介共用記憶體需要用到的函數介面shmget函數--獲取對象IDshmat函數--獲得映射空間shmctl函數--釋放資源共用記憶體實現思路註意 system v IPC簡介 消息隊列、共用記憶體和信號量統稱為system v IPC(進程間通信機制)，V是羅馬數字5，是UNI ...
所有分類