SpringCloud 微服務最佳開發(fā)實踐

更新時間：2021年07月08日 16:40:32 作者：飄渺Jam的博客

本文結(jié)合我們實際的開發(fā)中遇到的一些問題整理出了一份微服務開發(fā)的實踐規(guī)范，對SpringCloud 微服務開發(fā)實踐相關(guān)知識感興趣的朋友一起看看吧

現(xiàn)在基于SpringCloud的微服務開發(fā)日益流行，網(wǎng)上各種開源項目層出不窮。我們在實際工作中可以參考開源項目實現(xiàn)很多開箱即用的功能，但是必須要遵守一定的約定和規(guī)范。

本文結(jié)合我們實際的開發(fā)中遇到的一些問題整理出了一份微服務開發(fā)的實踐規(guī)范，歡迎各位大佬拍磚指點。

Maven規(guī)范

1.所有項目必須要有一個統(tǒng)一的parent模塊

所有微服務工程都依賴這個parent，parent用于管理依賴版本，maven倉庫，jar版本的統(tǒng)一升級維護

在parent下層可以有 core，starter，rate-limit 等自定義模塊

2.core 核心包的作用：

以POJO形式約定各種開發(fā)規(guī)范；如BaseEntity，統(tǒng)一入?yún)ⅲ祬?/li>
各種二方、三方組件開箱即用AutoConfig；
各種提高開發(fā)效率的幫助類等 XXXUtil

注意：core包所有依賴的scope必須是provided，避免傳遞依賴，同時配合Condition注解按條件加載Bean 如 @ConditionalOnClass(Ribbon.class)，@ConditionalOnBean(StringRedisTemplete.class)

3.starter模塊

如果你每個服務都需要依賴10幾個starter，可以建一個統(tǒng)一的starter模塊幫他們統(tǒng)一依賴進來，管理依賴集，簡化依賴

4.rate-limit模塊

用于放置非通用的自開發(fā)組件

5.正確區(qū)分Release版本和 Snapshot版本

說明：如果是Snapshot版本，那么在mvn deploy時會自動發(fā)布到快照版本庫中，而使用快照版本的模塊，在不更改版本號的情況下，直接編譯打包時，Maven會自動從鏡像服務器上下載最新的快照版本。

如果是Release版本，那么在mvn deploy時會自動發(fā)布到正式版本庫中，而使用正式版本的模塊，在不更改版本號的情況下，編譯打包時如果本地已經(jīng)存在該版本的模塊則不會主動去鏡像服務器上下載。

簡而言之：

Release : 正式版，有bug不能再繼續(xù)使用這個版本號

Snapshot：快照版，有bug可以繼續(xù)使用同一版本號，可以自動升級，推薦使用

服務調(diào)用

規(guī)范服務間通過引入sdk調(diào)用，服務消費者需要依賴生產(chǎn)者提供的api，配合snapshot方便升級

account
	account-api
	account-service

account-api 模塊中放消費方需要用到的東西，api接口，vo，入?yún)⒌?..

public interface AccountApi {
    ...
}

account-service實現(xiàn)account-api提供的接口

@RestController
@Log4j2
@Api(tags = "用戶接口")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class AccountController implements AccountApi {
    ...
}

消費者通過feign調(diào)用生產(chǎn)者，直接集成生產(chǎn)者提供的接口并處理熔斷

@Component
@FeignClient(name = "account-service",fallbackFactory = AccountClientFallbackFactory.class)
public interface AccountClient extends AccountApi {
    ...
}

@Component
public class AccountClientFallbackFactory implements FallbackFactory<AccountClient> {

    @Override
    public AccountClient create(Throwable throwable) {
        AccountClientFallback accountClientFallback = new AccountClientFallback();
        accountClientFallback.setCause(throwable);
        return accountClientFallback;
    }

}

@Slf4j
public class AccountClientFallback implements AccountClient {
    @Setter
    private Throwable cause;

    @Override
    public ResultData<AccountDTO> getByCode(String accountCode) {
        log.error("查詢失敗,接口異常" ,cause);
        AccountDTO account = new AccountDTO();
        account.setAccountCode("000");
        account.setAccountName("測試Feign");
        return ResultData.success(account);
    }

}