為保障車間業(yè)務(wù)系統(tǒng)的穩(wěn)定性、可維護(hù)性與團(tuán)隊(duì)協(xié)作效率,特制定此基礎(chǔ)軟件服務(wù)命名規(guī)范。本規(guī)范適用于所有服務(wù)于車間制造執(zhí)行、設(shè)備管理、質(zhì)量管理、物料追溯等核心業(yè)務(wù)場景的基礎(chǔ)軟件服務(wù)(如微服務(wù)、后臺服務(wù)、數(shù)據(jù)庫、消息隊(duì)列等)。
一、 核心原則
- 清晰性:名稱應(yīng)能準(zhǔn)確反映服務(wù)的核心功能與業(yè)務(wù)領(lǐng)域。
- 一致性:遵循統(tǒng)一的命名模式,便于識別和管理。
- 簡潔性:在表達(dá)清晰的前提下,力求簡短,避免過長或過于復(fù)雜的詞匯。
- 可讀性:采用有意義的英文單詞或公認(rèn)縮寫,便于開發(fā)與運(yùn)維人員理解。
二、 命名結(jié)構(gòu)
基礎(chǔ)軟件服務(wù)的完整名稱建議采用多段式結(jié)構(gòu),以清晰界定其所屬范圍與職責(zé)。通用格式如下:
[系統(tǒng)/領(lǐng)域前綴]-[業(yè)務(wù)模塊]-[功能描述]-[服務(wù)類型]
- 系統(tǒng)/領(lǐng)域前綴 (System/Domain Prefix):標(biāo)識服務(wù)所屬的頂層系統(tǒng)或領(lǐng)域。對于車間業(yè)務(wù)系統(tǒng),固定使用
shopfloor作為前綴。 - 業(yè)務(wù)模塊 (Business Module):指明服務(wù)對應(yīng)的具體業(yè)務(wù)模塊。例如:
mes(制造執(zhí)行系統(tǒng))
equip或device(設(shè)備管理)
quality(質(zhì)量管理)
material或wip(物料/在制品管理)
trace(追溯管理)
report(報(bào)表服務(wù))
auth(認(rèn)證授權(quán))
- 功能描述 (Function Description):用1-2個關(guān)鍵詞簡要描述服務(wù)的核心功能。例如:
order(工單),status(狀態(tài)),collect(采集),alert(告警),query(查詢),calc(計(jì)算)。 - 服務(wù)類型 (Service Type):標(biāo)識服務(wù)的具體技術(shù)類型。例如:
svc或service(應(yīng)用服務(wù)/微服務(wù))
api(API網(wǎng)關(guān)或核心接口服務(wù))
job或task(定時任務(wù)/作業(yè)服務(wù))
mq(消息隊(duì)列服務(wù),可結(jié)合具體中間件如rabbitmq,kafka)
db(數(shù)據(jù)庫服務(wù),可結(jié)合具體數(shù)據(jù)庫如mysql,pg)
cache(緩存服務(wù),如redis)
三、 命名示例
- 制造執(zhí)行-工單服務(wù):
shopfloor-mes-order-svc - 設(shè)備管理-狀態(tài)采集服務(wù):
shopfloor-equip-status-collect-svc - 質(zhì)量管理-缺陷告警任務(wù):
shopfloor-quality-defect-alert-job - 物料追溯-查詢API服務(wù):
shopfloor-trace-query-api - 公共認(rèn)證服務(wù):
shopfloor-auth-svc(業(yè)務(wù)模塊為auth時,功能描述可省略) - 車間報(bào)表數(shù)據(jù)庫:
shopfloor-report-db - 設(shè)備事件消息隊(duì)列:
shopfloor-equip-event-kafka
四、 部署與配置關(guān)聯(lián)命名
在容器化或虛擬機(jī)部署環(huán)境中,建議服務(wù)的主機(jī)名、容器名、配置文件名稱與上述服務(wù)核心名稱保持一致或高度關(guān)聯(lián),以降低運(yùn)維復(fù)雜度。例如,服務(wù) shopfloor-mes-order-svc 對應(yīng)的Docker容器可命名為 shopfloor-mes-order-svc-container,其配置文件可為 application-shopfloor-mes-order-svc.yml。
五、 版本管理
服務(wù)本身的版本號建議通過標(biāo)簽(Tag)或在其配置中心進(jìn)行管理,不直接體現(xiàn)在服務(wù)的基礎(chǔ)命名中,以保持名稱的穩(wěn)定性。
六、 例外與評審
對于特殊情況或新引入的技術(shù)組件,若無法完全適用本規(guī)范,需提交至系統(tǒng)架構(gòu)委員會或技術(shù)負(fù)責(zé)人進(jìn)行評審,確定命名方案并酌情更新本規(guī)范。
遵循此規(guī)范,將有助于構(gòu)建一個條理清晰、易于理解和運(yùn)維的車間數(shù)字化軟件服務(wù)生態(tài),為智能制造的高效運(yùn)行奠定堅(jiān)實(shí)的技術(shù)管理基礎(chǔ)。