1.5　微服務開發原則

在實際工作中進行微服務開發時，除了遵循1.4節介紹的設計原則和拆分原則，還要遵循以下開發原則和開發規范。

1.5.1　微服務命名

微服務名稱（Service Name）采用三段式的命名規則，中間使用短橫線（-）分隔，即xxxx-xxxx-xxxx形式。一級服務名為組織名稱，如baidu；二級服務名為應用或項目的名稱，如tieba；三級服務名為功能模塊的名稱，如auth。整體使用英文拼寫，單詞間不要使用空格和下畫線（_），全部使用小寫字母。如果微服務僅供組織內部使用，可以將應用或項目名稱作為一級服務名。

正確的示例如下：

baidu-tieba-auth（僅舉例說明）

eos-order-cancel

org-open-platform-proxy

錯誤的示例如下：

org-open-platform proxy [錯誤說明：空格]

org_open_platform-proxy [錯誤說明：下畫線]

org-open-PLATFORM-proxy [錯誤說明：大寫]

1.5.2　項目依賴配置

使用Maven進行項目管理，在項目的pom.xml文件中添加以下父依賴，用于實現微服務基礎框架構建、健康檢查、路由追蹤等。在pom.xml文件中，按照以下規則命名groupId和artifactId。

1．groupId

定義當前Maven項目隸屬的實際項目或應用，與包命名規范類似，按照“組織.項目/應用”的格式進行命名，如<groupId>com.unicom.eos</groupId>。

2．artifactId

使用service-name定義artifactId，如<artifactId>eos-open-platform-proxy</artifactId>。

1.5.3　配置文件

配置文件一般使用*.yml或*.properties格式。

1．本地配置

bootstrap.yml配置文件用來配置服務本身的屬性，如微服務名稱、端口，以及需要連接的配置服務器等。

2．遠程配置

命名如{service-name}.yml的配置文件放在微服務平臺的Git倉庫（公共GitHub或私有GitLab）中，用來配置業務邏輯中用到的配置信息。

3．版本配置

微服務開發會配置多個環境版本，一般包括開發（dev）、測試（test）、灰度（grey）和生產（prod）4個環境，運行環境配置文件如表1-1所示。

不同運行環境的配置文件，在微服務啟動時可以動態傳入，參數為“--spring.profiles.active=test”，其中，test表示使用測試環境的配置文件。

1.5.4　代碼命名

變量采用駝峰式命名法，接口統一使用RESTful通信風格，URL統一使用小寫字母，方法命名采用小駝峰格式。