使用DDD和內(nèi)部/隔離有限上下文的業(yè)務域結構包裝。 2。定義使用附近的接口，以實現(xiàn)松動的耦合和依賴性反轉。 3。使用上下文。始終如一，將錯誤與％w包裝，以進行可追蹤的，可觀察到的錯誤處理。 4。通過依賴注入，避免全球范圍并與接口進行嘲笑。 5。遵循一致的項目布局，并使用GOFMT，REVIVE和CI檢查執(zhí)行代碼標準。 6。通過結構化記錄，分布式跟蹤，指標和健康檢查來實現(xiàn)可觀察性。 7.文檔帶有GO DOC的導出API，并配有OpenAPI，ADRS和模塊的補充。在企業(yè)環(huán)境中可維護的GO代碼清晰，一致，可觀察和可觀察到，使團隊能夠隨著時間的推移安全發(fā)展軟件。

在企業(yè)環(huán)境中編寫可維護的GO代碼不僅僅是遵循語法規(guī)則或編寫快速程序，而且是關于創(chuàng)建易于閱讀，測試，擴展和調(diào)試的軟件，通常是由開發(fā)人員團隊組成的幾個月或幾年。 GO的簡單性鼓勵了良好的實踐，但是如果沒有紀律，即使GO代碼庫也會大規(guī)模變得凌亂。

這是在企業(yè)設置中編寫可維護的GO代碼的方法：

1。使用清晰的軟件包結構和域驅(qū)動的設計

在企業(yè)應用程序中，通過技術層（例如， controllers ， services ， models ）組織代碼會導致糾結依賴性和凝聚力不佳。相反，在業(yè)務領域結構包裝。

例如：

 /cmd/api
/內(nèi)部/用戶
/內(nèi)部/訂單
/內(nèi)部/付款
/pkg/logger
/PKG/指標

每個internal/...軟件包應代表有界的上下文（例如用戶管理或訂單處理），其類型，邏輯和持久性。這使得更容易推理變化并減少連鎖反應。

?做：

• 將相關功能保持在一起。
• 限制交叉包依賴性。
• 使用internal/防止外部濫用。

?避免：

• 上帝的包裹像utils或common 。
• 循環(huán)導入（使用接口破壞它們）。

2。擁抱依賴關系管理的接口

GO的界面可實現(xiàn)松動的耦合。定義接近使用的接口，而不是實現(xiàn)的位置。

例如，在您的user包中，定義：

鍵入usernotifier界面{
    sendwelcomeemail（到字符串）錯誤
}

然后在您的服務中接受它：

 func newuserservice（notifier usernotifier） *userervice {...}

這使您可以：

• 交換實現(xiàn)（例如，實際電子郵件與測試中的模擬）
• 避免在您的域深處進口重型外部包裝（例如AWS SDK）
• 強制依賴性反轉（取決于抽象，而不是具體）

提示：使用最小接口（例如io.Reader ， io.Closer ） - 它們更容易滿足和測試。

3。使用上下文處理錯誤和包裝

企業(yè)系統(tǒng)需要可觀察性。不要忽略錯誤，也不要使用裸露if err != nil 。使用errors.Join ， fmt.Errorf帶有%w ，以及errors.Is / errors.As 。

如果err：= db.ping（）; err！= nil {
    返回fmt.errorf（“無法連接到數(shù)據(jù)庫：％W”，err）
}

使用context.Context始終如一地跨層，尤其是在HTTP處理程序或后臺作業(yè)中的超時，跟蹤和取消。

使用結構化日志記錄（例如，使用zap或log/slog ）的日志錯誤，并包括相關的元數(shù)據(jù)：

 logger.error（“無法處理順序”，
    “ order_id”，order.id，
    “ user_id”，order.userid，
    “錯誤”，err，
）

避免多次記錄相同的誤差（在邊界處足夠）。

4。從一開始寫可測試的代碼

可維護的代碼是可測試的代碼。遵循以下模式：

• 依賴注入：通過構造函數(shù)通過合作者（DB，客戶，通知器）。
• 避免全局狀態(tài)：包裝級別的無var DB *sql.DB 。
• 使用接口模擬外部系統(tǒng)。

例子：

鍵入訂購過程struct {
    DB Orderstore
    付款付款人員
    Notifier Notifier
}

func（op *orderProcessor）進程（ctx context.context，訂購）錯誤{...}

現(xiàn)在您可以輕松測試：

 func testorderprocessor_process（t *testing.t）{
    MOCKDB：= new（模擬巨星）
    模型：= new（MockpaymentClient）

    處理器：= OrderProcessor {DB：MockDB，付款：Mockpayment}
    // ...
}

寫：

• 業(yè)務邏輯的單元測試
• DB/外部呼叫的集成測試
• testify/assert t.Cleanup

5。遵循一致的項目布局和標準

采用標準布局，例如http://ipnx.cn/link/cd4b78a5026aaff9159f31e5c5997089或它的簡化版本。

例子：

 / api/＃OpenAPI規(guī)格
/cmd/myapp＃主要應用程序
/內(nèi)部/＃私人業(yè)務邏輯
/ pkg/＃共享庫代碼
/ test/＃測試助手，固定裝置
/ config/＃配置文件
/腳本/＃開發(fā)/部署腳本

使用以下方式執(zhí)行代碼樣式：

• gofmt / goimports
• golint或revive
• CI檢查（沒有未檢查的錯誤，覆蓋范圍閾值）

使用有意義的名稱：

• GetUserByID(ctx, id)未Get(uID)
• ErrValidationFailed而不是Err1002

6。監(jiān)視，跟蹤和正確記錄

企業(yè)應用必須可觀察到。整合：

• 結構化記錄（在產(chǎn)品中使用JSON的log/slog ）
• 分布式跟蹤（OpenTelemetry）
• 指標（Prometheus柜臺/儀表）
• 健康檢查（ /health終點）

將中間件用于HTTP：

 func loggingmiddleware（下一個http.handler）http.handler {
    返回http.handlerfunc（func（w http.ResponseWriter，r *http.request）{
        //日志請求開始/結束持續(xù)時間
    }））
}

儀器密鑰操作：

計時器：= prometheus.newtimer（opprocessingduration）
defer Timer.Observeration（）

7.文檔公共API和關鍵邏輯

使用GO DOC進行導出類型和功能：

 // Processorder處理訂單驗證，付款和確認。
//如果余額太低，則返回ErrinSuffIfficFunds。
func（s *orderService）processOrder（ctx context.context，訂單訂購）錯誤{...}

補充：

• API文檔（Swagger/OpenAPI）
• 建筑決策記錄（ADR）
• 模塊中解釋目的和用法的重新記錄

最后的想法

可維護的企業(yè)歸結為：

• 簡單性：不要過度設計。
• 清晰度：代碼應該是顯而易見的，不是聰明。
• 一致性：到處都是相同的模式。
• 可測試性和可觀察性：您以后會感謝自己。

GO為您提供工具 - 對它們進行策略，執(zhí)行標準，并牢記可維護性。

基本上，立即編寫代碼，即您的未來自我（或新隊友）可以從現(xiàn)在開始六個月后自信地理解和改變。這就是企業(yè)規(guī)模的可維護性真正的含義。

以上是為企業(yè)編寫可維護的GO代碼的詳細內(nèi)容。更多信息請關注PHP中文網(wǎng)其他相關文章！