一款不錯的SpringCloud 腳手架項目
之前接個私活,在網(wǎng)上找了好久沒有找到合適的框架,不是版本低沒人維護了,在不就是組件相互依賴較高。所以我自己搭建一個全新spingCloud框架,里面所有組件可插拔的,集成多個組件供大家選擇,喜歡哪個用哪個
一、系統(tǒng)架構圖
二、快速啟動
1.本地啟動nacos: http://127.0.0.1:8848
- sh startup.sh -m standalone
2.本地啟動sentinel: http://127.0.0.1:9000
- nohup java -Dauth.enabled=false -Dserver.port=9000 -jar sentinel-dashboard-1.8.1.jar &
3.本地啟動zipkin: http://127.0.0.1:9411/
- nohup java -jar zipkin-server-2.23.2-exec.jar &
三、項目概述
- springboot+springcloud
- 注冊中心:nacos
- 網(wǎng)關:gateway
- RPC:feign
以下是可插拔功能組件
- 熔斷降級:sentinel
- 全鏈路跟蹤:sleth+zipkin
- 分布式事務:seata
- 封裝功能模塊:全局異常處理、日志輸出打印持久化、多數(shù)據(jù)源、鑒權授權模塊、zk(分布式鎖和訂閱者模式)
- maven:實現(xiàn)多環(huán)境打包、直推鏡像到docker私服。
這個項目整合了springcloud體系中的各種組件。以及集成配置說明。同時將自己平時使用的功能性的封裝以及工具包都最為模塊整合進來??梢员苊饽承┘夹g點長時間不使用后的遺忘。
另一方面現(xiàn)在springboot springcloud 已經(jīng)springcloud-alibaba的版本迭代速度越來越快。
為了保證我們的封裝和集成方式在新版本中依然正常運行,需要用該項目進行最新版本的適配實驗。這樣可以更快的在項目中集合工程中的功能模塊。
四、項目預覽
五、新建業(yè)務工程模塊說明
由于springboot遵循 約定大于配置的原則。所以本工程中所有的額類都在的包路徑都在com.cloud.base下。
如果新建的業(yè)務項目有規(guī)定使用指定的基礎包路徑則需要在啟動類增加包掃描注解將com.cloud.base下的所有類加入到掃描范圍下。
- @ComponentScan(basePackages = "com.cloud.base")
如果可以繼續(xù)使用com.cloud.base 則約定將啟動類放在該路徑下即可。
六、模塊劃分
- 父工程:
- cloud-base - 版本依賴管理 <groupId>com.cloud</groupId>
- |
- |--common - 通用工具類和包 <groupId>com.cloud.common</groupId>
- | |
- | |--core-common 通用包 該包包含了SpringMVC的依賴,會與WebFlux的服務有沖突
- | |
- | |--core-exception 自定義異常和請求統(tǒng)一返回類
- |
- |--dependency - 三方功能依賴集合 無任何實現(xiàn) <groupId>com.cloud.dependency</groupId>
- | |
- | |--dependency-alibaba-cloud 關于alibaba-cloud的依賴集合
- | |
- | |--dependency-mybatis-tk 關于ORM mybatis+tk.mybatis+pagehelper的依賴集合
- | |
- | |--dependency-mybatis-plus 關于ORM mybatis+mybatis—plus+pagehelper的依賴集合
- | |
- | |--dependency-seata 關于分布式事務seata的依賴集合
- | |
- | |--dependency-sentinel 關于流控組件sentinel的依賴集合
- | |
- | |--dependency-sentinel-gateway 關于網(wǎng)關集成流控組件sentinel的依賴集合(僅僅gateway網(wǎng)關使用該依賴)
- | |
- | |--dependency-sleuth-zipkin 關于鏈路跟蹤sleuth-zipkin的依賴集合
- |
- |--modules - 自定義自實現(xiàn)的功能組件模塊 <groupId>com.cloud.modules</groupId>
- | |
- | |--modules-logger 日志功能封裝
- | |
- | |--modules-multi-datasource 多數(shù)據(jù)功能封裝
- | |
- | |--modules-lh-security 分布式安全授權鑒權框架封裝
- | |
- | |--modules-youji-task 酉雞-分布式定時任務管理模塊
- | |
- |
- |
- |
- | 以下是獨立部署的應用 以下服務啟動后配合前端工程使用 (cloud-base-angular-admin)
- |
- |--cloud-gateway 應用網(wǎng)關
- |
- |--authorize-center 集成了modules-lh-security 的授權中心,提供統(tǒng)一授權和鑒權
- |
- |--code-generator 代碼生成工具
- |
- |--user-center 用戶中心 提供用戶管理和權限管理的相關服務
- |
- |--youji-manage-server 集成了modules-youji-task 的定時任務管理服務端
七、版本使用說明
- <springboot.version>2.4.2</springboot.version>
- <springcloud.version>2020.0.3</springcloud.version>
- <springcloud-alibaba.version>2021.1</springcloud-alibaba.version>
八、多環(huán)境打包說明
在需要獨立打包的模塊resources資源目錄下增加不同環(huán)境的配置文件
- application-dev.yml
- application-test.yml
- application-prod.yml
修改application.yml
- spring:
- profiles:
- active: @profileActive@
在需要獨立打包的模塊下的pom文件中添加一下打包配置。
- <build>
- <plugins>
- <plugin>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-maven-plugin</artifactId>
- <version>${springboot.version}</version>
- <configuration>
- <fork>true</fork>
- <addResources>true</addResources>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>repackage</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-resources-plugin</artifactId>
- <configuration>
- <delimiters>
- <delimiter>@</delimiter>
- </delimiters>
- <useDefaultDelimiters>false</useDefaultDelimiters>
- </configuration>
- </plugin>
- </plugins>
- <resources>
- <resource>
- <directory>src/main/resources</directory>
- <filtering>true</filtering>
- </resource>
- </resources>
- </build>
- <profiles>
- <profile>
- <id>dev</id>
- <activation>
- <activeByDefault>true</activeByDefault>
- </activation>
- <properties>
- <profileActive>dev</profileActive>
- </properties>
- </profile>
- <profile>
- <id>test</id>
- <properties>
- <profileActive>test</profileActive>
- </properties>
- </profile>
- <profile>
- <id>prod</id>
- <properties>
- <profileActive>prod</profileActive>
- </properties>
- </profile>
- </profiles>
mvn打包命令
- # 打開發(fā)環(huán)境
- mvn clean package -P dev -Dmaven.test.skip=ture
- # 打測試環(huán)境
- mvn clean package -P test -Dmaven.test.skip=ture
- # 打生產(chǎn)環(huán)境
- mvn clean package -P prod -Dmaven.test.skip=ture
九、構建Docker鏡像
整合dockerfile插件,可直接將jar包構建為docker image 并推送到遠程倉庫
增加插件依賴
- <!-- docker image build -->
- <plugin>
- <groupId>com.spotify</groupId>
- <artifactId>dockerfile-maven-plugin</artifactId>
- <version>1.4.10</version>
- <executions>
- <execution>
- <id>default</id>
- <goals>
- <!--如果package時不想用docker打包,就注釋掉這個goal-->
- <!-- <goal>build</goal>-->
- <goal>push</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <repository>49.232.166.94:8099/example/${project.artifactId}</repository>
- <tag>${profileActive}-${project.version}</tag>
- <username>admin</username>
- <password>Harbor12345</password>
- <buildArgs>
- <JAR_FILE>target/${project.build.finalName}.jar</JAR_FILE>
- </buildArgs>
- </configuration>
- </plugin>
在pom.xml同級目錄下增加Dockerfile
- FROM registry.cn-hangzhou.aliyuncs.com/lh0811/lh0811-docer:lh-jdk1.8-0.0.1
- MAINTAINER lh0811
- ADD ./target/${JAR_FILE} /opt/app.jar
- RUN chmod +x /opt/app.jar
- CMD java -jar /opt/app.jar
十、源碼獲取 鏈接: https://pan.baidu.com/s/1mOOcIun7hrOsC_vp0w5aeA 提取碼: mel3