IntelliJ IDEA 程式碼模板自定義實戰：File and Code Templates 完整配置指南

IntelliJ IDEA 程式碼模板自定義實戰

統一團隊程式碼風格、自動生成標準化註解，是提升開發效率與程式碼品質的關鍵。本文詳細講解如何使用 IntelliJ IDEA 的 File and Code Templates 功能，打造專屬的程式碼生成模板。

一、兩大模板機制對比

二、File and Code Templates 核心配置

1. 開啟設定位置

Settings (Ctrl+Alt+S) → Editor → File and Code Templates

2. 內建模板分類

• Files：各類檔案模板
• Includes：可重用的片段模板
• Code：程式碼產生模板

三、實戰：建立標準 Java 類別模板

1. 類別註解模板

編輯 Files → Class：

#if (${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end

/**
 * @author ${USER}
 * @date ${DATE} ${TIME}
 * @description ${DESCRIPTION}
 * @version 1.0
 */
public class ${NAME} {
}

2. 版權聲明模板

編輯 Includes → File Header：

/**
 * Copyright (c) ${YEAR} ${COMPANY_NAME}. All rights reserved.
 * This software is the confidential and proprietary information of ${COMPANY_NAME}.
 */

3. 掛載版權聲明到類別模板

在 Files → Class 最頂部加入：

#parse("File Header.java")

4. 介面與 Enum 同步配置

同樣編輯 Files → Interface 和 Files → Enum，引用相同的 File Header。

四、常用預定義變數速查表

五、進階：自定義變數與腳本

1. 使用 #set 定義變數

#set($DESCRIPTION = "用戶服務介面")
public interface ${NAME} {
}

2. 使用 Groovy 腳本動態生成

/**
 * @author ${USER}
 * @date ${DATE}
 * @description ${GROOVY_SCRIPT:"return 'Auto-generated ' + new Date().format('yyyy-MM-dd')"}
 */

六、團隊共享模板最佳實踐

1. 導出/匯入模板

• Settings → Editor → File and Code Templates → 點擊齒輪圖示 → Export/Import Settings
• 或直接複製 config/templates 目錄到版本控制

2. 專案級模板（.idea 檔案）

專案根目錄建立 .idea/fileTemplates/ 目錄，放入自定義模板檔案，提交到 Git 實現團隊同步。

3. 結合 EditorConfig 統一格式

# .editorconfig
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.java]
indent_size = 4

七、常用模板範例庫

1. Spring Service 實作類

#parse("File Header.java")

#if (${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end

import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
@Transactional(rollbackFor = Exception.class)
public class ${NAME} implements ${INTERFACE_NAME} {
}

2. JUnit 5 測試類

#parse("File Header.java")

#if (${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.DisplayName;
import static org.junit.jupiter.api.Assertions.*;

@DisplayName("${NAME} 測試")
class ${NAME}Test {

    @Test
    @DisplayName("測試方法")
    void testMethod() {
        // given
        
        // when
        
        // then
    }
}

3. MyBatis Mapper 介面

#parse("File Header.java")

#if (${PACKAGE_NAME} != "")
package ${PACKAGE_NAME};
#end

import org.apache.ibatis.annotations.Mapper;
import java.util.List;

@Mapper
public interface ${NAME}Mapper {
    
    int insert(${ENTITY_NAME} entity);
    
    int update(${ENTITY_NAME} entity);
    
    ${ENTITY_NAME} selectById(Long id);
    
    List<${ENTITY_NAME}> selectAll();
    
    int deleteById(Long id);
}

八、Live Templates 互補配置

常用片段快速鍵（Settings → Editor → Live Templates）：

透過 File and Code Templates 統一檔案級結構，配合 Live Templates 加速片段編寫，再結合 EditorConfig 強制格式化，能構建高效一致的團隊開發環境。建議將模板納入專案版本控制，新成員 Clone 專案即可獲得標準化配置。