在 Spring 專案中,XML 配置檔扮演著至關重要的角色。本文整理了十二個實用的配置最佳實踐,其中有些不只是「好習慣」,更是「必要之舉」。這些建議主要聚焦於提升 XML 配置檔的可讀性與可管理性。
Spring 能透過類別自省自動綁定依賴,省去手動指定屬性與構造器的麻煩。然而,這種做法以犧牲配置的清晰度與可維護性為代價。在真實的工程環境中,尤其是類別聲明數量龐大的專案裡,自動裝配反而會讓配置變得晦澀難懂。混用自動與手動綁定,只會加劇這種混亂。
這對 Java 編碼同樣適用。採用清晰、具描述性的通俗名稱,能大幅降低理解成本。例如 bean 的 ID 可直接沿用對應的 Java 類別名;大型專案則可在 ID 前加上套件名作為前綴。
簡潔形式能把屬性值與參考寫進屬性標籤中,避免冗長的子元素寫法。例如把 <property><value>lizjason</value></property> 簡化為 <property name="companyName" value="lizjason"/>。這不僅省下打字,更能顯著提升大型配置檔的可讀性。
當構造器有多個同類型參數時,與其使用從 0 起算的序號(index),不如用 type 屬性明確標示型別。序號雖能減少冗長,卻容易出錯且難以閱讀,只應在參數不明確時才使用。
Spring 提供類似繼承的機制來減少配置重複:把父 bean 設為 abstract="true" 作為模板,子 bean 則透過 parent 屬性繼承其配置。這是大型專案中實現「重用」的關鍵手法。
相較於在 XML 中用 <import> 預裝配,透過 ApplicationContext 來組織多個配置檔更為靈活,也讓配置更易於管理。
雖然 id 與 name 都能標識 bean,但 id 能讓 XML 解析器對引用做更好的驗證。只有當遇到 XML IDREF 限制(如 id 必須以字母開頭)時,才改用 name。實際上碰觸到這類限制的機會很少。
透過在 bean 上設定 dependency-check(如 simple、object、all),可讓容器在開發階段驗證依賴是否被明確設定,及早發現遺漏的屬性。
與其在各處散落註解,不如在檔案開頭用 <description> 標籤概述這個配置檔定義了哪些 bean、依賴於哪些檔案。這樣做的好處是工具能輕易從標籤中擷取描述內容。
XML 配置檔也是程式碼,是應用不可或缺的一部分,卻往往難讀難維護。每當重構 Java 程式碼時,別忘了同步更新配置並通知隊友。
構造器注入能確保 bean 不會處於非法狀態被創建,而 setter 注入則更靈活、更易管理——特別是當類別屬性眾多且部分為可選時,setter 注入的優勢更為明顯。
並非所有 Java 對象都應透過依賴注入創建,例如全域對象就不適合由 ApplicationContext 管理。過度依賴注入會讓配置變得複雜臃腫。記住:在使用 Eclipse、IntelliJ 這類強大的 IDE 時,Java 程式碼往往比 XML 檔更易讀、易維護。
對於 Spring 配置而言,XML 是一種優秀的方式。但當 bean 數量龐大時,基於 XML 的配置難免變得冗長笨拙。善用 Spring 提供的豐富配置選項能讓 XML 保持清晰,但要謹慎對待像自動裝配這種會降低可讀性與可維護性的特性。掌握上述實踐,你就能打造既清晰又好維護的 XML 配置檔。