前奏
創(chuàng)業(yè)半年多,中間做過一個app若河。各種各樣的原因能岩,最后雖然上線了,但是沒有推廣萧福,每天百十來個用戶拉鹃,也不打算迭代了。我們后臺使用的是基于spring-boot鲫忍、spring-cloud的微服務(wù)框架膏燕。框架包含了spring-cloud全家桶的大部分組件悟民,我自己花時間坝辫,重新把這些框架類的內(nèi)容整理了一遍,構(gòu)建了一個簡單的場景射亏,開源出來近忙,希望對那些想學(xué)習(xí) 或者 快速搭建自己的微服務(wù)框架的同學(xué)能提供幫助。
代碼地址(附上原文地址):https://github.com/chxfantasy/spring-cloud-demo
截圖:
代碼目錄
如果對微服務(wù)本身不太太了解的話鸦泳,或者不知道為什么需要微服務(wù)的話,請參考原來的一篇文章:我也想寫篇微服務(wù)的文章永品,以及微服務(wù)的優(yōu)缺點
如果對微服務(wù)里面的各個組件不太熟悉的話做鹰,可以參考這一篇文章:spring cloud從看不懂到放棄
項目介紹
- 這僅僅是spring-cloud微服務(wù)框架的一個demo,可以完整運行鼎姐〖佤铮可能你初看到這里,會覺得這個項目目錄太tm復(fù)雜了炕桨,確實饭尝,微服務(wù)要做的就是解耦、輕量化献宫。這里面包含的組件和內(nèi)容有:
- spring cloud eureka钥平,服務(wù)注冊和服務(wù)發(fā)現(xiàn)
- spring cloud config,動態(tài)配置項
- ribbon姊途,客戶端負載均衡
- feign涉瘾,
- hystrix知态,熔斷
- turbine
- Spring Cloud Starters
- 同一個服務(wù)中的多數(shù)據(jù)庫支持(AOP)
- 全鏈路traceId追蹤
- velocity 前端模板
- mybatis, pageHelper (分頁), druid (連接池)
- redis(序列化采用的是jdk默認序列化方案)
- slf4j & logback(及其配置)
- 國際化配置
- 全局錯誤信息catch
- 線程池
- 服務(wù)健康檢查, 服務(wù)全鏈路健康檢查
- 等
- 代碼的業(yè)務(wù)是:首先有一個登錄頁面,用戶登錄以后立叛,能看到一個微博(moment)列表负敏,同時也可以添加微博。在每個微博的最右邊秘蛇,可以看到每個微博的評論列表其做,也能添加評論。前端代碼寫的非常粗糙赁还。妖泄。。 如果你真的運行了秽浇,求不吐槽浮庐。
- 這里不談根據(jù)業(yè)務(wù)的需求去選擇是否微服務(wù)化,也不爭辯什么時候該用什么樣的框架柬焕,我這里只是把我們app后端的代碼审残,抽象成一個代碼庫,希望能為你提供幫助斑举。我們產(chǎn)品上線2個多月搅轿,后端基本沒有出過問題(也跟量小有關(guān)系)。
運行
- 首先富玷,你在本地需要有一個redis和mysql璧坟,redis默認啟動就可以。數(shù)據(jù)庫表的創(chuàng)建語句見下:
create database test;
CREATE TABLE `account` (
`user_id` varchar(127) NOT NULL DEFAULT '',
`user_name` varchar(127) NOT NULL DEFAULT '',
`password` varchar(127) NOT NULL DEFAULT '',
`gmt_created` datetime NOT NULL,
`gmt_modified` datetime DEFAULT NULL,
`is_deleted` tinyint(1) NOT NULL DEFAULT '0',
PRIMARY KEY (`user_id`),
KEY `index_user_id` (`user_id`) KEY_BLOCK_SIZE=10
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
CREATE TABLE `moment` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`user_id` varchar(127) COLLATE utf8mb4_unicode_ci NOT NULL,
`content` text COLLATE utf8mb4_unicode_ci,
`gmt_created` datetime NOT NULL,
`gmt_modified` datetime DEFAULT NULL,
`is_deleted` tinyint(1) DEFAULT '0',
PRIMARY KEY (`id`),
KEY `index_user_id` (`user_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
create database test2;
CREATE TABLE `comment` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`moment_id` bigint(20) unsigned NOT NULL,
`content` text COLLATE utf8mb4_unicode_ci,
`gmt_created` datetime NOT NULL,
`gmt_modified` datetime DEFAULT NULL,
`is_deleted` tinyint(1) DEFAULT '0',
PRIMARY KEY (`id`),
KEY `index_moment_id` (`moment_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
- 系統(tǒng)環(huán)境需要Java 8 和 maven 3及以上
- 運行命令如下 (需要按順序運行每個模塊):
cd spring-cloud-parent
mvn clean install -DskipTests
cd ../spring-cloud-client
mvn clean install -DskipTests
cd ../spring-cloud-starter
mvn clean install -DskipTests
cd spring-cloud-eureka
mvn clean spring-boot:run
cd spring-cloud-account
mvn clean spring-boot:run
cd spring-cloud-biz
mvn clean spring-boot:run
cd spring-cloud-gateway
mvn clean spring-boot:run
- 瀏覽器中打開
http://127.0.0.1:7001/index
代碼解釋
-
代碼中的依賴關(guān)系見下圖:
代碼依賴關(guān)系 -
spring-cloud-parent
- 是一個空的mvn project, 包含了一些被其他項目所需要的公共的依賴赎懦。我這里創(chuàng)建parent雀鹃,僅僅是因為我不想把很多相同的依賴在spring-cloud-eureka、spring-cloud-biz励两、spring-cloud-account和spring-cloud-gateway這幾個項目中重復(fù)寫一遍黎茎,所以,一般微服務(wù)project都集成spring-cloud-parent当悔。嗯傅瞻,懶惰是人類的第一生產(chǎn)力。
-
spring-cloud-starter
- 是一個我創(chuàng)建的spring starter, 里面包含的是一些公共的bean盲憎,和一些公共的bean配置嗅骄,比如國際化locle配置、緩存CacheService配置饼疙,messageConvertor配置等溺森,spring-cloud-biz、spring-cloud-account和spring-cloud-gateway等微服務(wù)都需要依賴和共用這些基礎(chǔ)配置。
-
spring-cloud-client
- 是一個公共依賴儿惫,這里包含的是一個util類澡罚,以及多個模塊需要共同使用的、和數(shù)據(jù)庫表對應(yīng)的Java model.
-
spring-cloud-eureka
- 是一個服務(wù)注冊和服務(wù)發(fā)現(xiàn)中心肾请,需要集群化留搔。代碼里,我把spring-cloud-config動態(tài)配置項也集成在這里面了铛铁。服務(wù)發(fā)現(xiàn)的心跳檢測時間隔显,也從15s改到了5s,這對于快速發(fā)現(xiàn)節(jié)點故障很有作用饵逐。
-
spring-cloud-account
- 是整個工程的賬號服務(wù)模塊括眠。對于一個大型的系統(tǒng)來講,單獨的賬號服務(wù)系統(tǒng)是很有必要解耦出來的倍权。
-
spring-cloud-biz
- 是實際的業(yè)務(wù)模塊掷豺,包括發(fā)微博模塊和評論模塊。整個代碼中動態(tài)使用了兩個數(shù)據(jù)庫薄声,我這里對數(shù)據(jù)庫的切分只是簡單從業(yè)務(wù)上切分当船,既:微博在一個庫中,評論在另外一個庫中默辨,同時寫了一個@TargetDataSource注解德频,方便動態(tài)切換數(shù)據(jù)庫。其實對于分庫缩幸、分表壹置、讀寫分離,代碼都是類似的表谊。
-
spring-cloud-gateway
- 是整個系統(tǒng)的網(wǎng)關(guān)服務(wù)钞护,所有來自端上的請求,包括app或者web頁面爆办,都需要先到網(wǎng)關(guān)难咕,由網(wǎng)關(guān)做過處理之后再轉(zhuǎn)發(fā)給其他服務(wù)。比如押逼,網(wǎng)關(guān)需要處理登錄狀態(tài)問題步藕,需要處理上傳文件問題惦界,需要做一些過濾挑格,以及其他多種切面上的事情。
- 如果需要停止某個微服務(wù)沾歪,如spring-cloud-account漂彤、spring-cloud-biz或者spring-cloud-gateway, 運行命令:
curl -H 'Accept:application/json' -X POST 'http://127.0.0.1:${management.port}/shutdown'
, 這條命令會先讓這個微服務(wù)在注冊中心下掉自己,然后再停掉自己。
部署
-
服務(wù)的部署如下圖:
部署 - 需要注意的就是挫望,整個系統(tǒng)只有g(shù)ateway是可以被端訪問到的立润,其他服務(wù)的所有接口,都應(yīng)該只能在內(nèi)網(wǎng)訪問媳板,這也可以讓其他服務(wù)不做很強的權(quán)限驗證桑腮。
- 代碼里面細節(jié)很多,比如cache如何使用蛉幸, GlobalCacheHelper破讨,hystrix的自定義設(shè)置,全鏈路traceId的設(shè)置奕纫,信息的國際化提陶、健康檢查(去檢查了cache、db等其他項匹层,還檢查了每一項的返回時間)隙笆,這里沒辦法展開一一講解。有問題請直接github上開issue升筏,或者公眾號聯(lián)系我:不如假如撑柔。